| POST | /api/4PSBC/ImportProject |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Header | body | Header | Yes | Message header |
| Data | body | Data_Project | 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 | |
| companyId | form | Guid? | No | |
| no | form | string | No | |
| description | form | string | No | |
| description2 | form | string | No | |
| visitAddress | form | string | No | |
| visitAddress2 | form | string | No | |
| visitAddressPostCode | form | string | No | |
| visitAddressCity | form | string | No | |
| visitAddressCountryRegionId | form | string | No | |
| address | form | string | No | |
| postCode | form | string | No | |
| city | form | string | No | |
| countryRegionId | form | string | No | |
| projectStatus | form | string | No | |
| startingDate | form | DateTime? | No | |
| endingDate | form | DateTime? | No | |
| contactId | form | Guid? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Header | form | Header | Yes | Header of the response |
| Response | form | Response_Project | Yes | Response body |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | form | string | Yes | Reponse status (Ok/Error) |
| Errors | form | string | No | Errors summary |
| DigiOfficeProjectID | form | string | Yes | ID of the project in DigiOffice |
| DigiOfficeGlobalID | form | Guid | Yes | GlobalID (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
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
}
}