DigiOffice Gateway Web Services

<back to all web services

GetProjects

Requires Authentication
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 .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: test-dogw.klokgroep.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SearchCriteria":"String","PageSize":0,"PageNumber":0,"ModifiedSince":"0001-01-01T00:00:00.0000000","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}]