HomeGuidesAPI ReferenceChangelogAEB Transport & Freight ManagementLegal Notice
API Reference

queryDocumentReferenceObjects

get
https://rz3.aeb.de/demo1docs/rest/DocumentService/referenceObject/

Search document reference objects

Executes a search query on the document reference objects. Only the document reference objects that are visible to the caller (session user and session client) are returned. The results can be sorted by predefined criteria, the limit of the number of results is configurable, too.

Path Params
string
required

Criteria for the reference type of the document reference objects. Only reference objects that exactly match the reference type pattern will be returned.

Query Params
boolean

If true, the total number of document reference objects found is returned in field totalCount. The total number can be different from the number of returned reference objects in case maxResults value is exceeded.

int32

Defines how many document reference objects will be returned. The number must not exceed the maximum value of 100If no value is passed, default value 30 will be set.

int32

Number of document reference objects that will be skipped before collecting results. Use this to retrieve other document reference objects (next page) if a previous query did not return all of the required document reference objects. The number must not exceed 10000.

string
enum

Defines how the requested document reference objects are sorted.

  • REFERENCE_NUMBER_ASC : Sorted by reference number, alphabetically ascending.
  • REFERENCE_NUMBER_DESC : Sorted by reference number, alphabetically descending.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

The required data was not found

Updated 2 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago