Identity Document List By Booking ID - GET

Identity Document List By Booking ID - GET API Endpoint
StoRegister - Login

List of Identity Document Types By Booking ID API

The Identity Document Type List endpoint provides a list of Identity Document options tailored to specific booking activities, considering the size of the storage box, whether in terms of area or volume. The list is fetched based on the associated booking ID.

GET
/v1/booking/{bookingId}/identity-document/save/
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

URL Query Parameters:

  • bookingId string required

    bookingId refers to an activity ID of the specific booking.

Response Payload:

  • succeeded boolean

    Indicates whether the request to fetch the Identity Document options was successful. It is a boolean value where true denotes success, and false indicates failure.

  • status string

    Describes the status of the request to fetch Identity Document options. It is a string providing additional information about the status.

  • data array

    Contains an array of Identity Document options tailored to specific booking activities. Each option is designed based on the user type of the such as driving license or passport.

  • pagination object

    Details about pagination, including current page number, total number of pages, and overall count of items.

  • errors array

    Holds error information if applicable. It is an array containing error details in case there are issues with fetching the Identity Document options.

Identity Document Option Details

Details about the Identity Document option.

array data

  • id unique-identifier

    Unique identifier for the Identity Document option.

  • name string

    Name of the Identity Document option.

Request Header

Authorization: X-API-Key --api-key--

API Response

{
    "data": [
        {
            "id": "038c9a48-baab-4869-8484-5fa20590d23c",
            "name": "Driving Licence"
        },
        {
            "id": "84a71aea-0dab-4422-bc8c-6645a90abc3a",
            "name": "Passport"
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageCount": 2,
        "totalCount": 2
    },
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • INVALID_PARAM_BOOKING_INFO_ID

    INVALID_PARAM_BOOKING_INFO_ID refers to invalid booking ID.

  • INVALID_PARAM_ACTIVITY_INFO_ID

    INVALID_PARAM_ACTIVITY_INFO_ID refers to invalid activity ID.

  • INVALID_ACTIVITY_INFO_DETAILS

    INVALID_ACTIVITY_INFO_DETAILS means invalid activity details.

  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.

  • FAILED

    FAILED refers to an unsuccessful API call.

  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.
API Reference documentation