DigiOffice Gateway Web Services

<back to all web services

GetProjects

Requires Authentication
The following routes are available for this service:
GET POST/api/projects
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Project.Operations;
using IDB.API.DTO.Registrationprofile;

namespace IDB.API.DTO.Project.Operations
{
    public partial class GetProjects
        : IFilterRequest
    {
        public GetProjects()
        {
            DependableFields = new List<RegistrationProfileFieldValue>{};
        }

        public virtual string SearchCriteria { get; set; }
        public virtual int PageSize { get; set; }
        public virtual int PageNumber { get; set; }
        public virtual string OrderBy { get; set; }
        public virtual bool? Active { get; set; }
        public virtual Guid RegistrationProfileFieldID { get; set; }
        public virtual List<RegistrationProfileFieldValue> DependableFields { get; set; }
    }

}

namespace IDB.API.DTO.Registrationprofile
{
    public partial class RegistrationProfileFieldValue
    {
        public virtual Guid DocumentFieldID { get; set; }
        public virtual string Value { get; set; }
        public virtual string ShadowValue { get; set; }
        public virtual bool IsModifiedByUser { get; set; }
    }

}

C# GetProjects DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

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