DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Bedrijf

Import bedrijf record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportBedrijf
IDB_4PSBC_Import_Bedrijf Parameters:
NameParameterData TypeRequiredDescription
HeaderbodyHeaderYesMessage header
DatabodyData_CompanyYesMessage data
Header Parameters:
NameParameterData TypeRequiredDescription
ContainsformstringNoInhoud van het bericht
DateformstringNoDatum aanmaak bericht
MessageIDformstringNoID voor het bericht
SenderformstringNoVerzender van het bericht
Data_Company Parameters:
NameParameterData TypeRequiredDescription
visitAddressformstringNo
visitAddress2formstringNo
vatRegistrationNoformstringNo
vendorNoformstringNo
customerNoformstringNo
eMailformstringNo
companyName4psformstringNo
systemIdformGuid?No
digiOfficeIdformGuid?No
cocRegistrationNoformstringNo
cocLocationNoformstringNo
cocCityformstringNo
visitAddressCountryRegionIdformstringNo
countryRegionIdformstringNo
countryRegionCodeIdformstringNo
mobilePhoneNoformstringNo
nameformstringNo
name2formstringNo
visitAddressCityformstringNo
cityformstringNo
addressformstringNo
visitAddressPostCodeformstringNo
postCodeformstringNo
phoneNoformstringNo
phoneNo2formstringNo
homePageformstringNo
noformstringNo
companyIdformGuid?No
blockedformbool?No
nameAbbreviationformstringNo
IDB_4PSBC_Response_Bedrijf Parameters:
NameParameterData TypeRequiredDescription
HeaderformHeaderYesHeader of the response
ResponseformResponse_CompanyYesResponse body
Response_Company Parameters:
NameParameterData TypeRequiredDescription
StatusformstringYesReponse status (Ok/Error)
ErrorsformstringNoErrors summary
DigiOfficeCompanyIDformstringYesID of the company in DigiOffice
DigiOfficeGlobalIDformGuidYesGlobalID (digiOfficeId) of the company 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/ImportBedrijf HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Import_Bedrijf 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>
    <blocked>false</blocked>
    <city>String</city>
    <cocCity>String</cocCity>
    <cocLocationNo>String</cocLocationNo>
    <cocRegistrationNo>String</cocRegistrationNo>
    <companyId>00000000-0000-0000-0000-000000000000</companyId>
    <companyName4ps>String</companyName4ps>
    <countryRegionCodeId>String</countryRegionCodeId>
    <countryRegionId>String</countryRegionId>
    <customerNo>String</customerNo>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <eMail>String</eMail>
    <homePage>String</homePage>
    <mobilePhoneNo>String</mobilePhoneNo>
    <name>String</name>
    <name2>String</name2>
    <nameAbbreviation>String</nameAbbreviation>
    <no>String</no>
    <phoneNo>String</phoneNo>
    <phoneNo2>String</phoneNo2>
    <postCode>String</postCode>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
    <vatRegistrationNo>String</vatRegistrationNo>
    <vendorNo>String</vendorNo>
    <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_Bedrijf>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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