DigiOffice Gateway Web Services

IDB_4PSBC_Import_Persoon

Import persoon record vanuit 4PS

The following routes are available for this service:
POST	/api/4PSBC/ImportPersoon

**IDB_4PSBC_Import_Persoon** Parameters:
Name	Parameter	Data Type	Required	Description
Header	body	Header	Yes	Message header
Data	body	Data_Person	Yes	Message data

**Header** Parameters:
Name	Parameter	Data Type	Required	Description
Contains	form	string	No	Inhoud van het bericht
Date	form	string	No	Datum aanmaak bericht
MessageID	form	string	No	ID voor het bericht
Sender	form	string	No	Verzender van het bericht

**Data_Person** Parameters:
Name	Parameter	Data Type	Required
systemId	form	Guid?	No
digiOfficeId	form	Guid?	No
companyName4ps	form	string	No
no	form	string	No
firstName	form	string	No
middleName	form	string	No
surname	form	string	No
gender	form	string	No
initials	form	string	No
nameAbbreviation	form	string	No
title	form	string	No
titleBehindTheName	form	string	No
phoneNo	form	string	No
mobilePhoneNo	form	string	No
eMail	form	string	No
visitAddress	form	string	No
visitAddress2	form	string	No
visitAddressPostCode	form	string	No
visitAddressCity	form	string	No
visitAddressCountryRegionId	form	string	No
companyId	form	Guid?	No
blocked	form	bool?	No
cocCity	form	string	No

**IDB_4PSBC_Response_Persoon** Parameters:
Name	Parameter	Data Type	Required	Description
Header	form	Header	Yes	Header of the response
Response	form	Response_Person	Yes	Response body

**Response_Person** Parameters:
Name	Parameter	Data Type	Required	Description
Status	form	string	Yes	Reponse status (Ok/Error)
Errors	form	string	No	Errors summary
DigiOfficePersoonID	form	string	Yes	ID of the person in DigiOffice
DigiOfficeGlobalID	form	Guid	Yes	GlobalID (digiOfficeId) of the person in DigiOffice

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.

POST /api/4PSBC/ImportPersoon HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Import_Persoon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Data>
    <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>
  <Header>
    <Contains>String</Contains>
    <Date>String</Date>
    <MessageID>String</MessageID>
    <Sender>String</Sender>
  </Header>
</IDB_4PSBC_Import_Persoon>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Response_Persoon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Header>
    <Contains>String</Contains>
    <Date>String</Date>
    <MessageID>String</MessageID>
    <Sender>String</Sender>
  </Header>
  <Response>
    <DigiOfficeGlobalID>00000000-0000-0000-0000-000000000000</DigiOfficeGlobalID>
    <DigiOfficePersoonID>String</DigiOfficePersoonID>
    <Errors>String</Errors>
    <Status>String</Status>
  </Response>
</IDB_4PSBC_Response_Persoon>