DigiOffice Gateway Web Services

<back to all web services

GetProjectDetails

Requires Authentication
The following routes are available for this service:
GET/api/projects/{ID}
namespace IDB.API.DTO.Project

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ProjectDetails() = 
        member val ID:Int32 = new Int32() with get,set
        member val GlobalID:Guid = new Guid() with get,set
        member val Number:String = null with get,set
        member val Name:String = null with get,set
        member val Description1:String = null with get,set
        member val Description2:String = null with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val CorrespondenceInternalCompanyID:Int32 = new Int32() with get,set
        member val CorrespondenceInternalCompanyName:String = null with get,set
        member val CorrespondenceInternalCompanyGlobalID:Guid = new Guid() with get,set
        member val Postalcode:String = null with get,set
        member val City:String = null with get,set
        member val CountryID:Int32 = new Int32() with get,set
        member val CountryGlobalID:Guid = new Guid() with get,set
        member val CountryName:String = null with get,set
        member val GeoLocation:String = null with get,set
        member val AddressComplete:String = null with get,set
        member val CategoryID:Int32 = new Int32() with get,set
        member val CategoryDescription:String = null with get,set
        member val CategoryGlobalID:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type GetProjectDetails() = 
        member val ID:Int32 = new Int32() with get,set

F# 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>