NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve the settings for required visa check at gangway

get

/spms/v1/configurations/visaChecks

This is to retrieve the settings for required visa check at gangway

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object GetVisaCheck
  Title: GetVisaCheck

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/getVisaChecks"
    }
}

Nested Schema : GetVisaCheck

Type: object

Title: GetVisaCheck

Show Source

• comment(optional): string
  Example: 0-Turn Check off, 1-Turn Check On
• description(optional): string
  Example: Port/Visa Check
• enabled(optional): boolean
  Example: true
• name(optional): string
  Example: Enable Visa Checks
• value(optional): string
  Example: 0

{
    "title":"GetVisaCheck",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"Enable Visa Checks"
        },
        "enabled":{
            "type":"boolean",
            "example":true
        },
        "value":{
            "type":"string",
            "example":"0"
        },
        "description":{
            "type":"string",
            "example":"Port/Visa Check"
        },
        "comment":{
            "type":"string",
            "example":"0-Turn Check off, 1-Turn Check On"
        }
    }
}

Example Response (application/json)

[
    {
        "name":"Enable Visa Check",
        "enabled":true,
        "value":"0",
        "description":"Port/Visa Check",
        "comment":"0-Turn Check off, 1-Turn Check On"
    }
]

204 Response

No data is available

401 Response

Full authentication is required to access this resource

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......"
        }
    }
}

500 Response

Error occured while processing this request

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......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top