DigiOffice API Services Services

<back to all web services

IDB_4PSBC_Import_ContactPerson

Import bedrijf record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportContactpersoon
IDB_4PSBC_Import_ContactPerson Parameters:
NameParameterData TypeRequiredDescription
HeaderbodyHeaderYesMessage header
DatabodyData_ContactPersonYesMessage data
Header Parameters:
NameParameterData TypeRequiredDescription
ContainsformstringNoInhoud van het bericht
DateformstringNoDatum aanmaak bericht
MessageIDformstringNoID voor het bericht
SenderformstringNoVerzender van het bericht
Data_ContactPerson Parameters:
NameParameterData TypeRequiredDescription
systemIdformGuid?No
digiOfficeIdformGuid?No
companyName4psformstringNo
noformstringNo
crmCompanyIdformGuidNo
crmPersonIdformGuidNo
jobTitleformstringNo
phoneNoformstringNo
mobilePhoneNoformstringNo
eMailformstringNo
companyIdformGuid?No
blockedformbool?No
IDB_4PSBC_Response_ContactPerson Parameters:
NameParameterData TypeRequiredDescription
HeaderformHeaderYesHeader of the response
ResponseformResponse_ContactPersonYesResponse body
Response_ContactPerson Parameters:
NameParameterData TypeRequiredDescription
StatusformstringYesReponse status (Ok/Error)
ErrorsformstringNoErrors summary
DigiOfficeContactPersonIDformstringYesID of the contactperson in DigiOffice
DigiOfficeGlobalIDformGuidYesGlobalID (digiOfficeId) of the contactperson in DigiOffice

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/4PSBC/ImportContactpersoon HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		Contains: String,
		Date: String,
		MessageID: String,
		Sender: String
	},
	Data: 
	{
		systemId: 00000000-0000-0000-0000-000000000000,
		digiOfficeId: 00000000-0000-0000-0000-000000000000,
		companyName4ps: String,
		no: String,
		jobTitle: String,
		phoneNo: String,
		mobilePhoneNo: String,
		eMail: String,
		companyId: 00000000-0000-0000-0000-000000000000,
		blocked: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		Contains: String,
		Date: String,
		MessageID: String,
		Sender: String
	},
	Response: 
	{
		Status: String,
		Errors: String,
		DigiOfficeContactPersonID: String
	}
}