DigiOffice Gateway Web Services

<back to all web services

GetProjectDetails

Requires Authentication
The following routes are available for this service:
GET/api/projects/{ID}
import Foundation
import ServiceStack

public class GetProjectDetails : Codable
{
    public var id:Int?

    required public init(){}
}

public class ProjectDetails : Codable
{
    public var id:Int?
    public var globalID:String?
    public var number:String?
    public var name:String?
    public var description1:String?
    public var description2:String?
    public var active:Bool?
    public var correspondenceInternalCompanyID:Int?
    public var correspondenceInternalCompanyName:String?
    public var correspondenceInternalCompanyGlobalID:String?
    public var postalcode:String?
    public var city:String?
    public var countryID:Int?
    public var countryGlobalID:String?
    public var countryName:String?
    public var geoLocation:String?
    public var addressComplete:String?
    public var categoryID:Int?
    public var categoryDescription:String?
    public var categoryGlobalID:String?

    required public init(){}
}


Swift GetProjectDetails DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Project">
  <Active>false</Active>
  <AddressComplete>String</AddressComplete>
  <CategoryDescription>String</CategoryDescription>
  <CategoryGlobalID>00000000-0000-0000-0000-000000000000</CategoryGlobalID>
  <CategoryID>0</CategoryID>
  <City>String</City>
  <CorrespondenceInternalCompanyGlobalID>00000000-0000-0000-0000-000000000000</CorrespondenceInternalCompanyGlobalID>
  <CorrespondenceInternalCompanyID>0</CorrespondenceInternalCompanyID>
  <CorrespondenceInternalCompanyName>String</CorrespondenceInternalCompanyName>
  <CountryGlobalID>00000000-0000-0000-0000-000000000000</CountryGlobalID>
  <CountryID>0</CountryID>
  <CountryName>String</CountryName>
  <Description1>String</Description1>
  <Description2>String</Description2>
  <GeoLocation>String</GeoLocation>
  <GlobalID>00000000-0000-0000-0000-000000000000</GlobalID>
  <ID>0</ID>
  <Name>String</Name>
  <Number>String</Number>
  <Postalcode>String</Postalcode>
</ProjectDetails>