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

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

<GetProjects xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Project.Operations">
  <Active>false</Active>
  <DependableFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationProfileFieldValue>
      <d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
      <d2p1:IsModifiedByUser>false</d2p1:IsModifiedByUser>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationProfileFieldValue>
  </DependableFields>
  <OrderBy>String</OrderBy>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RegistrationProfileFieldID>00000000-0000-0000-0000-000000000000</RegistrationProfileFieldID>
  <SearchCriteria>String</SearchCriteria>
</GetProjects>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Project">
  <Project>
    <Active>false</Active>
    <City>String</City>
    <Description1>String</Description1>
    <Description2>String</Description2>
    <GlobalID>00000000-0000-0000-0000-000000000000</GlobalID>
    <ID>0</ID>
    <Name>String</Name>
    <Number>String</Number>
  </Project>
</ArrayOfProject>