DigiOffice Gateway Web Services

IDB_4PSBC_Import_Bouwnummer

Import bouwnummer record vanuit 4PS

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

**IDB_4PSBC_Import_Bouwnummer** Parameters:
Name	Parameter	Data Type	Required	Description
Header	body	Header	Yes	Message header
Data	body	Data_Bouwnummer	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_Bouwnummer** Parameters:
Name	Parameter	Data Type	Required
systemId	form	Guid?	No
digiOfficeId	form	Guid?	No
projectId	form	Guid	No
plotNo	form	string	No
address	form	string	No
address2	form	string	No
postCode	form	string	No
city	form	string	No
countryRegionId	form	string	No
systemModifiedBy	form	string	No
companyName4ps	form	string	No

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

**Response_Bouwnummer** Parameters:
Name	Parameter	Data Type	Required	Description
Status	form	string	Yes	Reponse status (Ok/Error)
Errors	form	string	No	Errors summary
DigiOfficeBouwnummerID	form	string	Yes	ID of the bouwnummer in DigiOffice
DigiOfficeGlobalID	form	Guid	Yes	GlobalID (digiOfficeId) of the bouwnummer 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/ImportBouwnummer HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Import_Bouwnummer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Data>
    <address>String</address>
    <address2>String</address2>
    <city>String</city>
    <companyName4ps>String</companyName4ps>
    <countryRegionId>String</countryRegionId>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <plotNo>String</plotNo>
    <postCode>String</postCode>
    <projectId>00000000-0000-0000-0000-000000000000</projectId>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
    <systemModifiedBy>String</systemModifiedBy>
  </Data>
  <Header>
    <Contains>String</Contains>
    <Date>String</Date>
    <MessageID>String</MessageID>
    <Sender>String</Sender>
  </Header>
</IDB_4PSBC_Import_Bouwnummer>

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

<IDB_4PSBC_Response_Bouwnummer 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>
    <DigiOfficeBouwnummerID>String</DigiOfficeBouwnummerID>
    <DigiOfficeGlobalID>00000000-0000-0000-0000-000000000000</DigiOfficeGlobalID>
    <Errors>String</Errors>
    <Status>String</Status>
  </Response>
</IDB_4PSBC_Response_Bouwnummer>