DigiOffice Gateway Web Services

<back to all web services

GetProjects

Requires Authentication
The following routes are available for this service:
GET POST/api/projects
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetProjects : IFilterRequest
{
    var SearchCriteria:String? = null
    var PageSize:Int? = null
    var PageNumber:Int? = null
    var OrderBy:String? = null
    var Active:Boolean? = null
    var RegistrationProfileFieldID:UUID? = null
    var DependableFields:ArrayList<RegistrationProfileFieldValue> = ArrayList<RegistrationProfileFieldValue>()
}

open class RegistrationProfileFieldValue
{
    var DocumentFieldID:UUID? = null
    var Value:String? = null
    var ShadowValue:String? = null
    var IsModifiedByUser:Boolean? = null
}

Kotlin 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
	}
]