Vai al contenuto

Query notice batches (HTTP QUERY method)

Richiesta

Lists notice batches owned by the caller (or the caller's site), with cursor pagination.

This endpoint uses the HTTP QUERY method, not GET. OpenAPI cannot express the QUERY method, so it is shown here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields in a JSON body (States, Cursor, Limit, SortBy, SortOrder, Direction, TextSearch).

Sicurezza
basicAuth
Query
StatesArray of strings

Filter by one or more batch states.

Items Enum:"Draft""Submitted""Scheduled""Processing""Processed""Invalid""Failed"
Cursorstring

Opaque pagination cursor returned by the previous response.

Limitinteger, [ 1 .. 100 ]obbligatorio

Maximum number of batches to return (1–100).

SortBystring
Predefinito:"LastUpdated"
Enum:"None""LastUpdated""ScheduledFor""StartedOn"
SortOrderstring
Predefinito:"Ascending"
Enum:"None""Ascending""Descending"
Directionstring
Predefinito:"Forward"
Enum:"None""Forward""Backward"
TextSearchstring

Free-text search over batch descriptions.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v2/EviNotice/Batches?States=Draft&Cursor=string&Limit=1&SortBy=None&SortOrder=None&Direction=None&TextSearch=string'

Risposte

Query executed successfully.

Corpoapplication/json
Cursorstring

Opaque cursor for the next page. Pass it back as Cursor to retrieve more results.

HasMoreResultsboolean
ResultsArray of objects(EviNoticeBatchSummary)
Risposta
{ "Cursor": "string", "HasMoreResults": true, "Results": [ { … } ] }