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

/** @description 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)
export class Get4PSBCCompanies
{
    /** @description Number of items in the resultset per page. Default = 100 */
    // @ApiMember(Description="Number of items in the resultset per page. Default = 100")
    public PageSize: number;

    /** @description Page number of paged resultset. Default = 1 */
    // @ApiMember(Description="Page number of paged resultset. Default = 1")
    public PageNumber: number;

    public constructor(init?: Partial<Get4PSBCCompanies>) { (Object as any).assign(this, init); }
}

TypeScript Get4PSBCCompanies DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]