DigiOffice Gateway Web Services

<back to all web services

GetProjects

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

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

    [<AllowNullLiteral>]
    type RegistrationProfileFieldValue() = 
        member val DocumentFieldID:Guid = new Guid() with get,set
        member val Value:String = null with get,set
        member val ShadowValue:String = null with get,set
        member val IsModifiedByUser:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GetProjects() = 
        member val SearchCriteria:String = null with get,set
        member val PageSize:Int32 = new Int32() with get,set
        member val PageNumber:Int32 = new Int32() with get,set
        member val OrderBy:String = null with get,set
        member val Active:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val RegistrationProfileFieldID:Guid = new Guid() with get,set
        member val DependableFields:ResizeArray<RegistrationProfileFieldValue> = new ResizeArray<RegistrationProfileFieldValue>() with get,set

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

POST /api/projects HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SearchCriteria: String,
	PageSize: 0,
	PageNumber: 0,
	OrderBy: String,
	Active: False,
	DependableFields: 
	[
		{
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		ID: 0,
		Number: String,
		Name: String,
		Description1: String,
		Description2: String,
		City: String,
		Active: False
	}
]