DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Bouwnummer

Import bouwnummer record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportBouwnummer
IDB_4PSBC_Import_Bouwnummer Parameters:
NameParameterData TypeRequiredDescription
HeaderbodyHeaderYesMessage header
DatabodyData_BouwnummerYesMessage data
Header Parameters:
NameParameterData TypeRequiredDescription
ContainsformstringNoInhoud van het bericht
DateformstringNoDatum aanmaak bericht
MessageIDformstringNoID voor het bericht
SenderformstringNoVerzender van het bericht
Data_Bouwnummer Parameters:
NameParameterData TypeRequiredDescription
systemIdformGuid?No
digiOfficeIdformGuid?No
projectIdformGuidNo
plotNoformstringNo
addressformstringNo
address2formstringNo
postCodeformstringNo
cityformstringNo
countryRegionIdformstringNo
systemModifiedByformstringNo
companyName4psformstringNo
IDB_4PSBC_Response_Bouwnummer Parameters:
NameParameterData TypeRequiredDescription
HeaderformHeaderYesHeader of the response
ResponseformResponse_BouwnummerYesResponse body
Response_Bouwnummer Parameters:
NameParameterData TypeRequiredDescription
StatusformstringYesReponse status (Ok/Error)
ErrorsformstringNoErrors summary
DigiOfficeBouwnummerIDformstringYesID of the bouwnummer in DigiOffice
DigiOfficeGlobalIDformGuidYesGlobalID (digiOfficeId) of the bouwnummer 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/ImportBouwnummer 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,
		plotNo: String,
		address: String,
		address2: String,
		postCode: String,
		city: String,
		countryRegionId: String,
		systemModifiedBy: String,
		companyName4ps: String
	}
}
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,
		DigiOfficeBouwnummerID: String
	}
}