DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Project

Import project record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportProject
IDB_4PSBC_Import_Project Parameters:
NameParameterData TypeRequiredDescription
HeaderbodyHeaderYesMessage header
DatabodyData_ProjectYesMessage data
Header Parameters:
NameParameterData TypeRequiredDescription
ContainsformstringNoInhoud van het bericht
DateformstringNoDatum aanmaak bericht
MessageIDformstringNoID voor het bericht
SenderformstringNoVerzender van het bericht
Data_Project Parameters:
NameParameterData TypeRequiredDescription
systemIdformGuid?No
digiOfficeIdformGuid?No
companyIdformGuid?No
noformstringNo
descriptionformstringNo
description2formstringNo
visitAddressformstringNo
visitAddress2formstringNo
visitAddressPostCodeformstringNo
visitAddressCityformstringNo
visitAddressCountryRegionIdformstringNo
addressformstringNo
postCodeformstringNo
cityformstringNo
countryRegionIdformstringNo
projectStatusformstringNo
startingDateformDateTime?No
endingDateformDateTime?No
contactIdformGuid?No
IDB_4PSBC_Response_Project Parameters:
NameParameterData TypeRequiredDescription
HeaderformHeaderYesHeader of the response
ResponseformResponse_ProjectYesResponse body
Response_Project Parameters:
NameParameterData TypeRequiredDescription
StatusformstringYesReponse status (Ok/Error)
ErrorsformstringNoErrors summary
DigiOfficeProjectIDformstringYesID of the project in DigiOffice
DigiOfficeGlobalIDformGuidYesGlobalID (digiOfficeId) of the project 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/ImportProject HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Import_Project 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>
    <city>String</city>
    <companyId>00000000-0000-0000-0000-000000000000</companyId>
    <contactId>00000000-0000-0000-0000-000000000000</contactId>
    <countryRegionId>String</countryRegionId>
    <description>String</description>
    <description2>String</description2>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <endingDate>0001-01-01T00:00:00</endingDate>
    <no>String</no>
    <postCode>String</postCode>
    <projectStatus>String</projectStatus>
    <startingDate>0001-01-01T00:00:00</startingDate>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
    <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_Project>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Response_Project 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>
    <DigiOfficeProjectID>String</DigiOfficeProjectID>
    <Errors>String</Errors>
    <Status>String</Status>
  </Response>
</IDB_4PSBC_Response_Project>