| GET POST | /api/documents |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ViewID | body | Guid? | No | |
| PageSize | body | int | No | |
| PageNumber | body | int | No | |
| SearchCriteria | body | string | No | |
| ExplorerID | body | Guid? | No | |
| Path | body | string | No | |
| ExternalNumber | body | string | No | |
| ModifiedSince | body | DateTime? | No | |
| AllVersions | body | bool | No | |
| OrderBy | body | string | No | |
| Archived | body | bool? | No | |
| FilterName | body | string | No | |
| ProgCode | body | string | No | |
| RegistrationProfileFieldID | body | Guid | No | |
| DependableFields | body | List<RegistrationProfileFieldValue> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentFieldID | form | Guid | No | |
| Value | form | string | No | |
| ShadowValue | form | string | No | |
| IsModifiedByUser | form | bool | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documents HTTP/1.1
Host: doapigw.baasbv.nl
Accept: application/json
Content-Type: application/json
Content-Length: length
{"__type":"IDB.API.DTO.Document.Operations.GetDocuments, IDB.API.DTO","ViewID":"00000000-0000-0000-0000-000000000000","PageSize":0,"PageNumber":0,"SearchCriteria":"String","ExplorerID":"00000000-0000-0000-0000-000000000000","Path":"String","ExternalNumber":"String","ModifiedSince":"0001-01-01T00:00:00.0000000","AllVersions":false,"OrderBy":"String","Archived":false,"FilterName":"String","ProgCode":"String","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.Document.Document, IDB.API.DTO","ID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","RegistrationprofileID":"00000000-0000-0000-0000-000000000000","Title":"String","FullTitle":"String","Number":"String","Version":"String","ExternalNumber":"String","ExternalVersion":"String","InternalNumber":"String","InternalInvoiceNumber":"String","PersonID":0,"RelationID":0,"RelationTitle":"String","ProjectID":0,"ProjectTitle":"String","Extension":"String","Date":"0001-01-01T00:00:00.0000000","CommentsCount":0,"HasComments":false,"HasPreview":false,"ExtraField":"String","IsFavorite":false,"DocumentcategoryText":"String","FileSize":0,"FileDate":"0001-01-01T00:00:00.0000000","Hash":"String","HashType":"String","FileUrl":"String","StandardDocumentUrl":"String","IsCorporateIdentity":false,"UserTitle":"String","IsFrozen":false,"InternalCompanyID":0,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false}]