Reference Data

List special requirements

Changed on

Read-only catalog of special requirements (equipment accessories, driver services, freight handling, location constraints). The ids are what order and load specialRequirements arrays reference. Filter by type to get one category.

The catalog is global and organization-independent: every authenticated organization sees the same rows.

get/reference-data/special-requirements

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/reference-data/special-requirements
  • Auth: HTTP bearer

Query parameters

type'EQUIPMENT' | 'DRIVER' | 'FREIGHT' | 'SHIPPER_LOCATION'

What the requirement applies to.

  • EQUIPMENT: Equipment accessories (e.g., tarps, straps)
  • DRIVER: Driver services (e.g., team service, TWIC)
  • FREIGHT: Freight handling characteristics
  • SHIPPER_LOCATION: Location constraints

Only return requirements of this type

Response

Successful response

Example response

{
  "data": [
    {
      "name": "Tarps"
    }
  ]
}

Changes

  • 2cd6ecfbeb82Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      the optional response header X-RateLimit-Reset removed for the status 429

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • ce0e9003047cRevision changes
    • info

      endpoint added