# Get Equipments

Lists the equipment linked to the user's management unit.

Endpoint: GET /roads/equipments
Version: v2
Security: API-Key, Client-Code

## Security:

  - `API-Key` (unknown)
    apiKey in header Authorization

  - `Client-Code` (unknown)
    apiKey in header Client-Code

## Response 200:

  - `200` (unknown)
    Success.

## Response 200 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (array)

  - `dados.cdEquipamento` (string)

  - `dados.abrevEquipamento` (string)

  - `dados.dcrEquipamento` (string)

  - `dados.cdFamiliaEquipamento` (string)

  - `dados.abrevFamiliaEquipamento` (string)

  - `dados.dcrFamiliaEquipamento` (string)

  - `dados.cdFornecedor` (string)

  - `dados.dcrFornecedor` (string)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 202:

  - `202` (unknown)
    Your request is being processed.

## Response 202 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 401:

  - `401` (unknown)
    Unauthorized. It happens when the API Key sent does not pass authentication.

## Response 401 fields (application/json):

  - `error` (string)

## Response 403:

  - `403` (unknown)
    Forbidden. It happens when the API Key sent does not have access to the specified client.

## Response 403 fields (application/json):

  - `error` (string)

## Response 422:

  - `422` (unknown)
    The destination system rejected the request. The `errors` field details the reason per field; the `$` key indicates a rejection not tied to a specific field.

## Response 422 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 500 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 502:

  - `502` (unknown)
    The destination system returned an invalid response or could not be reached.

## Response 502 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 503:

  - `503` (unknown)
    The destination system or the service is temporarily unavailable or at capacity. Retry after the interval indicated in the `Retry-After` header.

## Response 503 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.

## Response 503 headers (application/json):

  - `Retry-After` (integer)
    Time to wait, in seconds, before retrying.

## Response 504:

  - `504` (unknown)
    The destination system did not respond in time.

## Response 504 fields (application/json):

  - `requestId` (string | null)

  - `status` (string)
    Request outcome. Open list: new values may be added; clients should tolerate unknown values.
    Enum: "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable"

  - `message` (string)

  - `dados` (object | array | null)

  - `errors` (object | null)
    Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.