DigiOffice Gateway Web Services

<back to all web services

Get4PSBCCompanies

Get companies mapped to 4PS specific result set

Requires Authentication
The following routes are available for this service:
GET/api/4PSBC/companies
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * Get companies mapped to 4PS specific result set
    */
    @Api(Description="Get companies mapped to 4PS specific result set")
    @ApiResponse(Description="Companies are returned in the message body", IsDefaultResponse=true, StatusCode=200)
    public static class Get4PSBCCompanies
    {
        /**
        * Number of items in the resultset per page. Default = 100
        */
        @ApiMember(Description="Number of items in the resultset per page. Default = 100")
        public Integer PageSize = null;

        /**
        * Page number of paged resultset. Default = 1
        */
        @ApiMember(Description="Page number of paged resultset. Default = 1")
        public Integer PageNumber = null;
        
        public Integer getPageSize() { return PageSize; }
        public Get4PSBCCompanies setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public Get4PSBCCompanies setPageNumber(Integer value) { this.PageNumber = value; return this; }
    }

}

Java Get4PSBCCompanies DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/4PSBC/companies HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"visitAddress":"String","visitAddress2":"String","vatRegistrationNo":"String","vendorNo":"String","customerNo":"String","eMail":"String","companyName4ps":"String","systemId":"00000000-0000-0000-0000-000000000000","digiOfficeId":"00000000-0000-0000-0000-000000000000","cocRegistrationNo":"String","cocLocationNo":"String","cocCity":"String","visitAddressCountryRegionId":"String","countryRegionId":"String","countryRegionCodeId":"String","mobilePhoneNo":"String","name":"String","name2":"String","visitAddressCity":"String","city":"String","address":"String","visitAddressPostCode":"String","postCode":"String","phoneNo":"String","phoneNo2":"String","homePage":"String","no":"String","companyId":"00000000-0000-0000-0000-000000000000","blocked":false,"nameAbbreviation":"String"}]