| POST | /api/4PSBC/ImportBouwnummer |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Header | body | Header | Yes | Message header |
| Data | body | Data_Bouwnummer | Yes | Message data |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Contains | form | string | No | Inhoud van het bericht |
| Date | form | string | No | Datum aanmaak bericht |
| MessageID | form | string | No | ID voor het bericht |
| Sender | form | string | No | Verzender van het bericht |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| systemId | form | Guid? | No | |
| digiOfficeId | form | Guid? | No | |
| projectId | form | Guid | No | |
| plotNo | form | string | No | |
| address | form | string | No | |
| address2 | form | string | No | |
| postCode | form | string | No | |
| city | form | string | No | |
| countryRegionId | form | string | No | |
| systemModifiedBy | form | string | No | |
| companyName4ps | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Header | form | Header | Yes | Header of the response |
| Response | form | Response_Bouwnummer | Yes | Response body |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | form | string | Yes | Reponse status (Ok/Error) |
| Errors | form | string | No | Errors summary |
| DigiOfficeBouwnummerID | form | string | Yes | ID of the bouwnummer in DigiOffice |
| DigiOfficeGlobalID | form | Guid | Yes | GlobalID (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
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
}
}