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 .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/ImportProject HTTP/1.1 
Host: test-dogw.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,
		companyId: 00000000-0000-0000-0000-000000000000,
		no: String,
		description: String,
		description2: String,
		visitAddress: String,
		visitAddress2: String,
		visitAddressPostCode: String,
		visitAddressCity: String,
		visitAddressCountryRegionId: String,
		address: String,
		postCode: String,
		city: String,
		countryRegionId: String,
		projectStatus: String,
		startingDate: 0001-01-01,
		endingDate: 0001-01-01,
		contactId: 00000000-0000-0000-0000-000000000000
	}
}
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,
		DigiOfficeProjectID: String
	}
}