DigiOffice Gateway Web Services

<back to all web services

GetProjectDetails

Requires Authentication
The following routes are available for this service:
GET/api/projects/{ID}
GetProjectDetails Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
ProjectDetails Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
GlobalIDformGuidNo
NumberformstringNo
NameformstringNo
Description1formstringNo
Description2formstringNo
ActiveformboolNo
CorrespondenceInternalCompanyIDformintNo
CorrespondenceInternalCompanyNameformstringNo
CorrespondenceInternalCompanyGlobalIDformGuidNo
PostalcodeformstringNo
CityformstringNo
CountryIDformintNo
CountryGlobalIDformGuidNo
CountryNameformstringNo
GeoLocationformstringNo
AddressCompleteformstringNo
CategoryIDformintNo
CategoryDescriptionformstringNo
CategoryGlobalIDformGuidNo

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

HTTP + CSV

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

GET /api/projects/{ID} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","Number":"String","Name":"String","Description1":"String","Description2":"String","Active":false,"CorrespondenceInternalCompanyID":0,"CorrespondenceInternalCompanyName":"String","CorrespondenceInternalCompanyGlobalID":"00000000-0000-0000-0000-000000000000","Postalcode":"String","City":"String","CountryID":0,"CountryGlobalID":"00000000-0000-0000-0000-000000000000","CountryName":"String","GeoLocation":"String","AddressComplete":"String","CategoryID":0,"CategoryDescription":"String","CategoryGlobalID":"00000000-0000-0000-0000-000000000000"}