# Filter the equipment information by reference or by S)ONE ID. 

**GET /equipments**

Sample request :

    GET /equipments?reference=AAAU1234566&spi=CNI1234567890&limit=5&offset=0&desc=true


## Servers
- https://soget-api-integration.azure-api.net/api-equipment/v1: https://soget-api-integration.azure-api.net/api-equipment/v1 ()



## Parameters


### Query parameters
- **reference** (string)
  Handling unit reference with which to filter.
- **spi** (string)
  Handling unit ID with which to filter. ID corresponds to the single passage identificator in S)ONE.
- **desc** (boolean)
  Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.
- **limit** (integer(int32))
  Number of results to be returned. Max value is 10.
- **offset** (integer(int32))
  Index of the first returned result.


## Responses
### 200
Success

#### Body: application/json (object)
- **total** (integer)
  Total amount of objects matching given parameters.
- **returned** (integer)
  Amount of objects returned by the paginated query.
- **first** (integer)
  Index of the first returned object.
- **items** (array[object] | null)
  Items returned by the query.
- **Additional properties are NOT allowed** ()


### 400
Bad Request

#### Body: application/json (object)
- **status** (string | null)
  Http error status.
- **timestamp** (string(date-time))
  Error date.
  <br>ISO 8601 Extended Format
- **code** (string | null)
  Business error code.
  <br>The possible values are :<br>- R001 : No handling unit was found<br>- R002 : The handling unit is null<br>- R003 : The handling unit is not correctly formated
- **message** (string | null)
  Error message.
- **Additional properties are NOT allowed** ()


### 404
Not Found

#### Body: application/json (object)
- **status** (string | null)
  Http error status.
- **timestamp** (string(date-time))
  Error date.
  <br>ISO 8601 Extended Format
- **code** (string | null)
  Business error code.
  <br>The possible values are :<br>- R001 : No handling unit was found<br>- R002 : The handling unit is null<br>- R003 : The handling unit is not correctly formated
- **message** (string | null)
  Error message.
- **Additional properties are NOT allowed** ()



[Powered by Bump.sh](https://bump.sh)