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

Query parameters

reference string

Handling unit reference with which to filter.

Default value is empty.
spi string

Handling unit ID with which to filter. ID corresponds to the single passage identificator in S)ONE.

Default value is empty.
desc boolean

Boolean that indicates the sort order. If it is set to true, results will be sorted by descending order.

Default value is false.
limit integer(int32)

Number of results to be returned. Max value is 10.

Maximum value is 10. Default value is 5.
offset integer(int32)

Index of the first returned result.

Default value is 0.

Responses

200 application/json

Success
Hide response attributes Show response attributes 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.
  
  Hide items attributes Show items attributes object
  
  spi string
  
  Equipment spi
  
  reference string
  
  Equipment reference
  
  seals array[object]
  
  List of seals.
  
  Hide seals attributes Show seals attributes object
  
  number string
  
  origin string
  
  measures object
  
  Hide measures attribute Show measures attribute object
  
  volume object
  
  This object concerns the following fields :
  
  - Length (the default unit is MTR)
  - Width (the default unit is MTR)
  - Height (the default unit is MTR)
  - Volume (the default unit is DMQ)
  
  Hide volume attributes Show volume attributes object
  
  value number(decimal)
  
  Measure value.
  
  unit string
  
  Value which comes from the international system of units.
  
  Minimum length is 0, maximum length is 5.
  
  dimensions object
  
  Hide dimensions attributes Show dimensions attributes object
  
  length object
  
  This object concerns the following fields :
  
  - Length (the default unit is MTR)
  - Width (the default unit is MTR)
  - Height (the default unit is MTR)
  - Volume (the default unit is DMQ)
  
  Hide length attributes Show length attributes object
  
  value number(decimal)
  
  Measure value.
  
  unit string
  
  Value which comes from the international system of units.
  
  Minimum length is 0, maximum length is 5.
  
  width object
  
  This object concerns the following fields :
  
  - Length (the default unit is MTR)
  - Width (the default unit is MTR)
  - Height (the default unit is MTR)
  - Volume (the default unit is DMQ)
  
  Hide width attributes Show width attributes object
  
  value number(decimal)
  
  Measure value.
  
  unit string
  
  Value which comes from the international system of units.
  
  Minimum length is 0, maximum length is 5.
  
  height object
  
  This object concerns the following fields :
  
  - Length (the default unit is MTR)
  - Width (the default unit is MTR)
  - Height (the default unit is MTR)
  - Volume (the default unit is DMQ)
  
  Hide height attributes Show height attributes object
  
  value number(decimal)
  
  Measure value.
  
  unit string
  
  Value which comes from the international system of units.
  
  Minimum length is 0, maximum length is 5.
  
  supplier string
- Additional properties are NOT allowed
400 application/json

Bad Request
Hide response attributes Show response attributes object
- status string | null
  
  Http error status.
- timestamp string(date-time)
  
  Error date.
  ISO 8601 Extended Format
- code string | null
  
  Business error code.
  The possible values are :
  - R001 : No handling unit was found
  - R002 : The handling unit is null
  - R003 : The handling unit is not correctly formated
- message string | null
  
  Error message.
- Additional properties are NOT allowed
404 application/json

Not Found
Hide response attributes Show response attributes object
- status string | null
  
  Http error status.
- timestamp string(date-time)
  
  Error date.
  ISO 8601 Extended Format
- code string | null
  
  Business error code.
  The possible values are :
  - R001 : No handling unit was found
  - R002 : The handling unit is null
  - R003 : The handling unit is not correctly formated
- message string | null
  
  Error message.
- Additional properties are NOT allowed

GET /equipments

curl \
 --request GET 'https://soget-api-integration.azure-api.net/api-equipment/v1/equipments'

Response examples (200)

{
  "total": 3,
  "returned": 1,
  "first": 0,
  "items": [
    {
      "spi": "string",
      "reference": "string",
      "seals": [
        {
          "number": "string",
          "origin": "string"
        }
      ],
      "measures": {
        "volume": {
          "value": 42.0,
          "unit": "string"
        }
      },
      "dimensions": {
        "length": {
          "value": 42.0,
          "unit": "string"
        },
        "width": {
          "value": 42.0,
          "unit": "string"
        },
        "height": {
          "value": 42.0,
          "unit": "string"
        }
      },
      "supplier": "string"
    }
  ]
}

Response examples (400)

{
  "status": "NotFound",
  "timestamp": "2022-11-17T15:40:39.838Z",
  "code": "R001",
  "message": "No handling unit was found"
}

Response examples (404)

{
  "status": "NotFound",
  "timestamp": "2022-11-17T15:40:39.838Z",
  "code": "R001",
  "message": "No handling unit was found"
}