DigiOffice API Services Services

GetProjects

The following routes are available for this service:
GET POST	/api/projects

"use strict";
export class RegistrationProfileFieldValue {
    /** @param {{DocumentFieldID?:string,Value?:string,ShadowValue?:string,IsModifiedByUser?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentFieldID;
    /** @type {string} */
    Value;
    /** @type {string} */
    ShadowValue;
    /** @type {boolean} */
    IsModifiedByUser;
}
export class GetProjects {
    /** @param {{SearchCriteria?:string,PageSize?:number,PageNumber?:number,ModifiedSince?:string,OrderBy?:string,Active?:boolean,RegistrationProfileFieldID?:string,DependableFields?:RegistrationProfileFieldValue[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SearchCriteria;
    /** @type {number} */
    PageSize;
    /** @type {number} */
    PageNumber;
    /** @type {?string} */
    ModifiedSince;
    /** @type {string} */
    OrderBy;
    /** @type {?boolean} */
    Active;
    /** @type {string} */
    RegistrationProfileFieldID;
    /** @type {RegistrationProfileFieldValue[]} */
    DependableFields;
}

JavaScript 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: test-do-services.klokgroep.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>
  <ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
  <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>