Jump to

• Request
• Response

Update package linkings for the bookable tour

put

/spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/packageLinkings

This is to update package linkings for the bookable tour

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Root Schema : Update bookable tour package linking

Type: object

Title: Update bookable tour package linking

Show Source

• packageLinkings(optional): array packageLinkings

{
    "title":"Update bookable tour package linking",
    "type":"object",
    "properties":{
        "packageLinkings":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/packageLinkingUpdateRequest"
            }
        }
    }
}

Nested Schema : packageLinkings

Type: array

Show Source

• Array of: object packageLinkingUpdateRequest

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

Nested Schema : packageLinkingUpdateRequest

Type: object

Show Source

• packageId: integer(int64)
  Minimum Value: 1

  Maximum Value: 999999999

  Package ID reference (only accept enabled package)

  Example: 1234567
• packageLinkingId: integer(int64)
  Minimum Value: 1

  Maximum Value: 999999999

  Package linking id

  Example: 1234567

{
    "type":"object",
    "properties":{
        "packageLinkingId":{
            "type":"integer",
            "format":"int64",
            "minimum":1,
            "maximum":999999999,
            "example":1234567,
            "description":"Package linking id"
        },
        "packageId":{
            "type":"integer",
            "format":"int64",
            "minimum":1,
            "maximum":999999999,
            "example":1234567,
            "description":"Package ID reference (only accept enabled package)"
        }
    },
    "required":[
        "packageId",
        "packageLinkingId"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Bookable Tour Package Linking

Type: object

Title: Bookable Tour Package Linking

Retrieve Bookable Tour Package Linking

Show Source

• packageLinkings(optional): array packageLinkings

{
    "title":"Bookable Tour Package Linking",
    "description":"Retrieve Bookable Tour Package Linking",
    "type":"object",
    "properties":{
        "packageLinkings":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/packageLinkingResponse"
            }
        }
    }
}

Nested Schema : packageLinkings

Type: array

Show Source

• Array of: object packageLinkingResponse

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

Nested Schema : packageLinkingResponse

Type: object

Show Source

• code(optional): string
  Package code

  Example: PCK01
• combinationTypeCode(optional): string
  Package combination type code

  Example: PCB-01
• combinationTypeName(optional): string
  Package combination type name

  Example: Package Combination 01
• name(optional): string
  Package name

  Example: Diving
• packageAdultPrice(optional): integer
  Package adult price

  Example: 70
• packageChildPrice(optional): integer
  Package child price

  Example: 50
• packageId(optional): integer
  Package ID reference

  Example: 1234567
• packageLinkingId(optional): integer
  Package linking id

  Example: 1234567

{
    "type":"object",
    "properties":{
        "packageLinkingId":{
            "type":"integer",
            "example":1234567,
            "description":"Package linking id"
        },
        "code":{
            "type":"string",
            "example":"PCK01",
            "description":"Package code"
        },
        "name":{
            "type":"string",
            "example":"Diving",
            "description":"Package name"
        },
        "packageId":{
            "type":"integer",
            "example":1234567,
            "description":"Package ID reference"
        },
        "combinationTypeCode":{
            "type":"string",
            "example":"PCB-01",
            "description":"Package combination type code"
        },
        "combinationTypeName":{
            "type":"string",
            "example":"Package Combination 01",
            "description":"Package combination type name"
        },
        "packageAdultPrice":{
            "type":"integer",
            "example":70,
            "description":"Package adult price"
        },
        "packageChildPrice":{
            "type":"integer",
            "example":50,
            "description":"Package child price"
        }
    }
}

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":"costs[0].packageLinkingId",
                "message":"must not be null"
            }
        ]
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":[
        {
            "errorPath":"costs[0].packageLinkingId",
            "message":"must not be null"
        }
    ]
}

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":"Bookable tour 123 not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Bookable tour 123 not 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"
        }
    }
}

409 Response

Conflict

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.10",
        "title":"Conflict",
        "detail":"This excursion is booked, update package is not allowed."
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"This excursion is booked, update package is not allowed."
}

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