NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve list of all visa requirements

get

/spms/v1/configurations/visaRequired

This is to retrieve list of all visa requirements for a profile/ nationality/ type of visas or arrival date

Request

Supported Media Types

• application/json

Query Parameters

• accountId: integer
• arrivalDate: string
• nationalityCode: string
• visaTypeCode: string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieve visas successfully

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Response object containing list items
  Title: Oracle Response object containing list items

  The wrapper object when returning a list of objects in Oracle standard

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

Nested Schema : Oracle Response object containing list items

Type: object

Title: Oracle Response object containing list items

The wrapper object when returning a list of objects in Oracle standard

Show Source

• items(optional): array items

{
    "title":"Oracle Response object containing list items",
    "description":"The wrapper object when returning a list of objects in Oracle standard",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/visaInfo"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Oracle Response object
  Title: Oracle Response object

  The object returned in Oracle Standard when function is executed successfully

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

Nested Schema : Oracle Response object

Type: object

Title: Oracle Response object

The object returned in Oracle Standard when function is executed successfully

Show Source

• accountType(optional): string
  Example: Guest
• dateFrom(optional): string
  Example: 2015-08-27 08:08:01 -0400
• dateTo(optional): string
  Example: 2030-08-27 07:08:00 -0400
• harbor(optional): string
  Example: Pier36
• nationality(optional): string
  Example: Cuba
• nationalityCode(optional): string
  Example: CU
• visaType(optional): string
  Example: Tourist Visa
• visaTypeCode(optional): string
  Example: B2

{
    "title":"Oracle Response object",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "nationalityCode":{
            "type":"string",
            "example":"CU"
        },
        "nationality":{
            "type":"string",
            "example":"Cuba"
        },
        "visaTypeCode":{
            "type":"string",
            "example":"B2"
        },
        "visaType":{
            "type":"string",
            "example":"Tourist Visa"
        },
        "dateFrom":{
            "type":"string",
            "example":"2015-08-27 08:08:01 -0400"
        },
        "dateTo":{
            "type":"string",
            "example":"2030-08-27 07:08:00 -0400"
        },
        "harbor":{
            "type":"string",
            "example":"Pier36"
        },
        "accountType":{
            "type":"string",
            "example":"Guest"
        }
    }
}

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

404 Response

Not Found

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 : 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