NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve the setting for check travel document returned

get

/spms/v1/configurations/checkTravelDocumentReturned

This is to retrieve the setting for check travel document returned

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieve the Check Travel Document Returned Code

Body ()

Root Schema : checkTravelDocumentReturned

Type: object

check Travel Document Returned

Show Source

• code(optional): string
  Allowed Values: [ "NO_CHECK (0)", "CHECK_DOCUMENT (1)", "CHECK_TRANSIT_DOCUMENT (2)" ]

  Example: 0
• description(optional): string
  Example: No checking

{
    "description":"check Travel Document Returned",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"0",
            "enum":[
                "NO_CHECK (0)",
                "CHECK_DOCUMENT (1)",
                "CHECK_TRANSIT_DOCUMENT (2)"
            ]
        },
        "description":{
            "type":"string",
            "example":"No checking"
        }
    }
}

401 Response

You are not authorized to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

This method is not available

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

The media supplied is not supported

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occurred while processing this request

Body ()

Root Schema : Invalid Data Response

Type: object

Title: Invalid Data Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: Invalid Check Document Returned Value: 4
• title(optional): string
  Example: Invalid Data
• type(optional): string
  Example: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1

{
    "title":"Invalid Data Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "example":"Invalid Data"
        },
        "detail":{
            "type":"string",
            "example":"Invalid Check Document Returned Value: 4"
        },
        "type":{
            "type":"string",
            "example":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top