DigiOffice Gateway Web Services

<back to all web services

GetProjectDetailsByGlobalID

Requires Authentication
The following routes are available for this service:
GET/api/global/projects/{GlobalID}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetProjectDetailsByGlobalID
{
    var GlobalID:UUID? = null
}

open class ProjectDetails
{
    var ID:Int? = null
    var GlobalID:UUID? = null
    var Number:String? = null
    var Name:String? = null
    var Description1:String? = null
    var Description2:String? = null
    var Active:Boolean? = null
    var CorrespondenceInternalCompanyID:Int? = null
    var CorrespondenceInternalCompanyName:String? = null
    var CorrespondenceInternalCompanyGlobalID:UUID? = null
    var Postalcode:String? = null
    var City:String? = null
    var CountryID:Int? = null
    var CountryGlobalID:UUID? = null
    var CountryName:String? = null
    var GeoLocation:String? = null
    var AddressComplete:String? = null
    var CategoryID:Int? = null
    var CategoryDescription:String? = null
    var CategoryGlobalID:UUID? = null
}

Kotlin GetProjectDetailsByGlobalID 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/global/projects/{GlobalID} 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>