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 .jsv suffix or ?format=jsv

HTTP + JSV

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: dogw.klokgroep.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		systemId: 00000000-0000-0000-0000-000000000000,
		digiOfficeId: 00000000-0000-0000-0000-000000000000,
		companyName4ps: String,
		no: String,
		firstName: String,
		middleName: String,
		surname: String,
		gender: String,
		initials: String,
		nameAbbreviation: String,
		title: String,
		titleBehindTheName: String,
		phoneNo: String,
		mobilePhoneNo: String,
		eMail: String,
		visitAddress: String,
		visitAddress2: String,
		visitAddressPostCode: String,
		visitAddressCity: String,
		visitAddressCountryRegionId: String,
		companyId: 00000000-0000-0000-0000-000000000000,
		blocked: False,
		cocCity: String
	}
]