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.*;

public class dtos
{

    public static class GetProjects implements IFilterRequest
    {
        public String SearchCriteria = null;
        public Integer PageSize = null;
        public Integer PageNumber = null;
        public String OrderBy = null;
        public Boolean Active = null;
        public UUID RegistrationProfileFieldID = null;
        public ArrayList<RegistrationProfileFieldValue> DependableFields = null;
        
        public String getSearchCriteria() { return SearchCriteria; }
        public GetProjects setSearchCriteria(String value) { this.SearchCriteria = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public GetProjects setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public GetProjects setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public GetProjects setOrderBy(String value) { this.OrderBy = value; return this; }
        public Boolean isActive() { return Active; }
        public GetProjects setActive(Boolean value) { this.Active = value; return this; }
        public UUID getRegistrationProfileFieldID() { return RegistrationProfileFieldID; }
        public GetProjects setRegistrationProfileFieldID(UUID value) { this.RegistrationProfileFieldID = value; return this; }
        public ArrayList<RegistrationProfileFieldValue> getDependableFields() { return DependableFields; }
        public GetProjects setDependableFields(ArrayList<RegistrationProfileFieldValue> value) { this.DependableFields = value; return this; }
    }

    public static class RegistrationProfileFieldValue
    {
        public UUID DocumentFieldID = null;
        public String Value = null;
        public String ShadowValue = null;
        public Boolean IsModifiedByUser = null;
        
        public UUID getDocumentFieldID() { return DocumentFieldID; }
        public RegistrationProfileFieldValue setDocumentFieldID(UUID value) { this.DocumentFieldID = value; return this; }
        public String getValue() { return Value; }
        public RegistrationProfileFieldValue setValue(String value) { this.Value = value; return this; }
        public String getShadowValue() { return ShadowValue; }
        public RegistrationProfileFieldValue setShadowValue(String value) { this.ShadowValue = value; return this; }
        public Boolean getIsModifiedByUser() { return IsModifiedByUser; }
        public RegistrationProfileFieldValue setIsModifiedByUser(Boolean value) { this.IsModifiedByUser = value; return this; }
    }

}

Java GetProjects DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"SearchCriteria":"String","PageSize":0,"PageNumber":0,"OrderBy":"String","Active":false,"RegistrationProfileFieldID":"00000000-0000-0000-0000-000000000000","DependableFields":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"ID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","Number":"String","Name":"String","Description1":"String","Description2":"String","City":"String","Active":false}]