GET /api/fleets/{fleetId}/messages

Paginated fleet message receipt history#

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

• Authentication, envelopes and pagination
• Language-neutral client examples

Path parameters#

object; fields below; unknown fields rejected

Validation#

check.object({ fleetId: check.identifier })

Referenced definitions:

• object
• identifier

Query parameters#

custom validation: messagePage ; see function below

Accepted query parameters: page, pageSize.

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function messagePage(input: unknown) {
    const values = listQuery(['page', 'pageSize'])(input);
    if (!values.ok)
        return values;
    const page = queryInteger(values.value.get('page') ?? '1', 1, 100000);
    const pageSize = queryInteger(values.value.get('pageSize') ?? '10', 1, 10);
    if (!page.ok)
        return page;
    if (!pageSize.ok)
        return pageSize;
    return success({ page: page.value, pageSize: pageSize.value });
}

Validation#

fleetControl.messagePage

Referenced definitions:

• messagePage

Request body#

empty object; unknown fields rejected

Validation#

check.empty

Referenced definitions:

• empty

Response data#

array; 0–10 entries; item: object; fields below; unknown fields rejected ( fleetMessageSummary )

Additional checks#

The following checks apply in addition to the field limits.

Constraint on [].body:

body => !!body.trim() && body.length <= 4096

Validation#

check.list(fleetControl.fleetMessageSummary, 10)

Referenced definitions:

• list
• fleetMessageSummary

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001",
    "page": 1,
    "pageSize": 20,
    "totalItems": 0,
    "totalPages": 1
  }
}