DigiOffice Gateway Web Services

<back to all web services

GetProjects

Requires Authentication
The following routes are available for this service:
GET POST/api/projects
GetProjects Parameters:
NameParameterData TypeRequiredDescription
SearchCriteriabodystringNo
PageSizebodyintNo
PageNumberbodyintNo
OrderBybodystringNo
Activebodybool?No
RegistrationProfileFieldIDbodyGuidNo
DependableFieldsbodyList<RegistrationProfileFieldValue>No
RegistrationProfileFieldValue Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
ValueformstringNo
ShadowValueformstringNo
IsModifiedByUserformboolNo

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: doapigw.baasbv.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"__type":"IDB.API.DTO.Project.Operations.GetProjects, IDB.API.DTO","SearchCriteria":"String","PageSize":0,"PageNumber":0,"OrderBy":"String","Active":false,"RegistrationProfileFieldID":"00000000-0000-0000-0000-000000000000","DependableFields":[{"__type":"IDB.API.DTO.Registrationprofile.RegistrationProfileFieldValue, IDB.API.DTO","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"__type":"IDB.API.DTO.Project.Project, IDB.API.DTO","ID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","Number":"String","Name":"String","Description1":"String","Description2":"String","City":"String","Active":false}]