DigiOffice Gateway Web Services

<back to all web services

Get4PSBCPersons

Get persons mapped to 4PS specific result set

Requires Authentication
The following routes are available for this service:
GET/api/4PSBC/persons

/** @description Get persons mapped to 4PS specific result set */
// @Api(Description="Get persons mapped to 4PS specific result set")
// @ApiResponse(Description="Persons are returned in the message body", IsDefaultResponse=true, StatusCode=200)
export class Get4PSBCPersons
{
    /** @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<Get4PSBCPersons>) { (Object as any).assign(this, init); }
}

TypeScript Get4PSBCPersons DTOs

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

HTTP + XML

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

GET /api/4PSBC/persons HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfData_Person xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Data_Person>
    <blocked>false</blocked>
    <cocCity>String</cocCity>
    <companyId>00000000-0000-0000-0000-000000000000</companyId>
    <companyName4ps>String</companyName4ps>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <eMail>String</eMail>
    <firstName>String</firstName>
    <gender>String</gender>
    <initials>String</initials>
    <middleName>String</middleName>
    <mobilePhoneNo>String</mobilePhoneNo>
    <nameAbbreviation>String</nameAbbreviation>
    <no>String</no>
    <phoneNo>String</phoneNo>
    <surname>String</surname>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
    <title>String</title>
    <titleBehindTheName>String</titleBehindTheName>
    <visitAddress>String</visitAddress>
    <visitAddress2>String</visitAddress2>
    <visitAddressCity>String</visitAddressCity>
    <visitAddressCountryRegionId>String</visitAddressCountryRegionId>
    <visitAddressPostCode>String</visitAddressPostCode>
  </Data_Person>
</ArrayOfData_Person>