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}
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 GetProjectDetailsByGlobalID() = 
        member val GlobalID:Guid = new Guid() with get,set

F# GetProjectDetailsByGlobalID DTOs

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

HTTP + JSV

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

{
	ID: 0,
	Number: String,
	Name: String,
	Description1: String,
	Description2: String,
	Active: False,
	CorrespondenceInternalCompanyID: 0,
	CorrespondenceInternalCompanyName: String,
	Postalcode: String,
	City: String,
	CountryID: 0,
	CountryName: String,
	GeoLocation: String,
	AddressComplete: String,
	CategoryID: 0,
	CategoryDescription: String
}