Jump to

• Request
• Response

Update transfer tours for the bookable tour

put

/spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/setup/transferTours

Request

Supported Media Types

• application/json

Path Parameters

• bookableTourId: integer
  bookable tour Id
• shipId: integer
  ship Id

Body ()

Root Schema : Update transfer tours for bookable tour

Type: object

Title: Update transfer tours for bookable tour

Show Source

• isTransferTour(optional): boolean
  Flag to indicate to transfer tour or not to.

  Example: true
• transferFromLocationCode(optional): string
  Minimum Length: 0

  Maximum Length: 6

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'

  Bookable Tour Transfer To Location Code

  Example: TTL01
• transferFromLocationDescription(optional): string
  Minimum Length: 0

  Maximum Length: 40

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'

  Bookable Tour Transfer From Location Description

  Example: FOR DINNER
• transferToLocationCode(optional): string
  Minimum Length: 0

  Maximum Length: 6

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'

  Bookable Tour Transfer To Location Code

  Example: TTL02
• transferToLocationDescription(optional): string
  Minimum Length: 0

  Maximum Length: 40

  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'

  Example: NIGHT MARKET

{
    "title":"Update transfer tours for bookable tour",
    "type":"object",
    "properties":{
        "isTransferTour":{
            "type":"boolean",
            "example":true,
            "description":"Flag to indicate to transfer tour or not to."
        },
        "transferFromLocationCode":{
            "type":"string",
            "minLength":0,
            "maxLength":6,
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\\|,.\":;{}[]=<>`'",
            "example":"TTL01",
            "description":"Bookable Tour Transfer To Location Code"
        },
        "transferFromLocationDescription":{
            "type":"string",
            "minLength":0,
            "maxLength":40,
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\\|,.\":;{}[]=<>`'",
            "example":"FOR DINNER",
            "description":"Bookable Tour Transfer From Location Description"
        },
        "transferToLocationCode":{
            "type":"string",
            "minLength":0,
            "maxLength":6,
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\\|,.\":;{}[]=<>`'",
            "example":"TTL02",
            "description":"Bookable Tour Transfer To Location Code"
        },
        "transferToLocationDescription":{
            "type":"string",
            "minLength":0,
            "maxLength":40,
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\\|,.\":;{}[]=<>`'",
            "example":"NIGHT MARKET"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Transfer Tour Info for Bookable Tour

Type: object

Title: Transfer Tour Info for Bookable Tour

Transfer Tour Info for Bookable Tour

Show Source

• isTransferTour(optional): boolean
  Flag to indicate to transfer tour or not to.

  Example: true
• transferFromLocationCode(optional): string
  Bookable Tour Transfer From Location Code

  Example: TTL01
• transferFromLocationDescription(optional): string
  Bookable Tour Transfer To Location Description

  Example: FOR DINNER
• transferToLocationCode(optional): string
  Bookable Tour Transfer To Location Code

  Example: TTL02
• transferToLocationDescription(optional): string
  Bookable Tour Transfer To Location Description

  Example: NIGHT MARKET

{
    "title":"Transfer Tour Info for Bookable Tour",
    "description":"Transfer Tour Info for Bookable Tour",
    "type":"object",
    "properties":{
        "isTransferTour":{
            "type":"boolean",
            "example":true,
            "description":"Flag to indicate to transfer tour or not to."
        },
        "transferFromLocationCode":{
            "type":"string",
            "example":"TTL01",
            "description":"Bookable Tour Transfer From Location Code"
        },
        "transferFromLocationDescription":{
            "type":"string",
            "example":"FOR DINNER",
            "description":"Bookable Tour Transfer To Location Description"
        },
        "transferToLocationCode":{
            "type":"string",
            "example":"TTL02",
            "description":"Bookable Tour Transfer To Location Code"
        },
        "transferToLocationDescription":{
            "type":"string",
            "example":"NIGHT MARKET",
            "description":"Bookable Tour Transfer To Location Description"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":[
            {
                "errorPath":"transferFromLocationCode",
                "message":"is invalid."
            }
        ]
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":[
        {
            "errorPath":"transferFromLocationCode",
            "message":"is invalid."
        }
    ]
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship Id could not be found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"System not allows officers to schedule a tour before the current date"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"System not allows officers to schedule a tour before the current date"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable.  Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top