DigiOffice Gateway Web Services

<back to all web services

Get4PSBCContactpersons

Get contactpersons mapped to 4PS specific result set

Requires Authentication
The following routes are available for this service:
GET/api/4PSBC/contactpersons
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Get contactpersons mapped to 4PS specific result set")
# @ApiResponse(Description="Contactpersons are returned in the message body", IsDefaultResponse=true, StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Get4PSBCContactpersons:
    """
    Get contactpersons mapped to 4PS specific result set
    """

    # @ApiMember(Description="Number of items in the resultset per page. Default = 100")
    page_size: int = 0
    """
    Number of items in the resultset per page. Default = 100
    """


    # @ApiMember(Description="Page number of paged resultset. Default = 1")
    page_number: int = 0
    """
    Page number of paged resultset. Default = 1
    """

Python Get4PSBCContactpersons 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/contactpersons HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfData_ContactPerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Data_ContactPerson>
    <blocked>false</blocked>
    <companyId>00000000-0000-0000-0000-000000000000</companyId>
    <companyName4ps>String</companyName4ps>
    <crmCompanyId>00000000-0000-0000-0000-000000000000</crmCompanyId>
    <crmPersonId>00000000-0000-0000-0000-000000000000</crmPersonId>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <eMail>String</eMail>
    <jobTitle>String</jobTitle>
    <mobilePhoneNo>String</mobilePhoneNo>
    <no>String</no>
    <phoneNo>String</phoneNo>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
  </Data_ContactPerson>
</ArrayOfData_ContactPerson>