Get document type information.

GET /document-types/{code}

Sample request:

GET /document-types/705

Path parameters

code integer(int32) Required

Document type code

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- code integer(int32)
  
  Code of the type of document
- name string | null
  
  Name of the type of document
  
  Minimum length is 0, maximum length is 512.
- description string | null
  
  Description of the type of document
  
  Minimum length is 0, maximum length is 2048.
- Additional properties are NOT allowed
400 application/json

Unexpected error
Hide response attributes Show response attributes object
- status string | null
  
  Error status
- timestamp string(date-time)
  
  Error date
- code string | null
  
  Error code
  - R101 : The container size type is unfound.
  - R102 : The country code is unfound.
  - R103 : The document type is unfound.
  - R104 : The location code is unfound.
  - R105 : The location type is unfound.
  - R106 : The packaging code is unfound.
  - R107 : The transport mode is unfound.
  - R108 : The transport mean type is unfound.
  - R109 : The event type is unfound.
  - R110 : The UN/LOCODE is unfound.
  - R111 : The actor is unfound.
  - R112 : The dangerous code is unfound.
- message string | null
  
  Error message
- Additional properties are NOT allowed

GET /document-types/{code}

curl \
 -X GET https://soget-api-integration.azure-api.net/api-referential-unitary/v1/document-types/{code} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Ocp-Apim-Subscription-Key: $API_KEY"

Response examples (200)

{
  "code": 705,
  "name": "Bill of lading",
  "description": "Negotiable document/message which evidences a contract of carriage by sea and the taking over or loading of goods by carrier, and by which carrier undertakes to deliver goods against surrender of the document  A provision in the document that goods are to be delivered to the order of a named person, or to order, or to bearer, constitutes such an undertaking"
}

Response examples (400)

{
  "status": "400",
  "timestamp": "2022-10-18T14:53:52.239Z",
  "code": "R001",
  "message": "Information not found."
}