DigiOffice Gateway Web Services

<back to all web services

GetProjects

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

export class RegistrationProfileFieldValue
{
    public DocumentFieldID?: string;
    public Value?: string;
    public ShadowValue?: string;
    public IsModifiedByUser?: boolean;

    public constructor(init?: Partial<RegistrationProfileFieldValue>) { (Object as any).assign(this, init); }
}

export class GetProjects implements IFilterRequest
{
    public SearchCriteria?: string;
    public PageSize?: number;
    public PageNumber?: number;
    public OrderBy?: string;
    public Active?: boolean;
    public RegistrationProfileFieldID?: string;
    public DependableFields?: RegistrationProfileFieldValue[];

    public constructor(init?: Partial<GetProjects>) { (Object as any).assign(this, init); }
}

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