DigiOffice API Services Services

Get4PSBCPersons

Get persons mapped to 4PS specific result set

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DO.Synchronization.IDB_4PSBC.DTO.Operations

Namespace Global

    Namespace DO.Synchronization.IDB_4PSBC.DTO.Operations

        '''<Summary>
        '''Get persons mapped to 4PS specific result set
        '''</Summary>
        <Api(Description:="Get persons mapped to 4PS specific result set")>
        <ApiResponse(Description:="Persons are returned in the message body", IsDefaultResponse:=true, StatusCode:=200)>
        Public Partial Class Get4PSBCPersons
            '''<Summary>
            '''Number of items in the resultset per page. Default = 100
            '''</Summary>
            <ApiMember(Description:="Number of items in the resultset per page. Default = 100")>
            Public Overridable Property PageSize As Integer

            '''<Summary>
            '''Page number of paged resultset. Default = 1
            '''</Summary>
            <ApiMember(Description:="Page number of paged resultset. Default = 1")>
            Public Overridable Property PageNumber As Integer
        End Class
    End Namespace
End Namespace

VB.NET 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-do-services.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>