Jump to

• Request
• Response

Retrieve configured Guest Comment Category records

get

/spms/v2/ships/{shipId}/configurations/guestCommentCategories

This is to retrieve the configured Guest Comment Category.

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): number(int64)
  Ship Id

Query Parameters

• code: string
  Category Code
• description: string
  Category comment
• isActive: boolean
  This is to indicate switch to active / In-active Guest Comment Category. * `true` - Active Guest Comment Category * `false` - Inactive Guest Comment Category
• limit: integer(int32)
  Paging limit
• offset: integer(int32)
  Paging offset
• orderBy: string
  order by code, description, isActive with format column1:asc/desc,column2:asc/desc column3:asc/desc

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Oracle Response object

Type: object

Title: Oracle Response object

This is to retrieve the configured Guest Comment Category.

Show Source

• count: number
  The total number of items in the list.

  Example: 1
• hasMore: boolean
  Flag which indicates whether or not there are more items.

  Example: true
• items: array items
• limit: number
  Paging limit

  Example: 5
• offset: number
  Paging offset

  Example: 10

{
    "title":"Oracle Response object",
    "description":"This is to retrieve the configured Guest Comment Category.",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"number",
            "example":"1"
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":true
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/guestCommentCategories"
            },
            "example":[
                {
                    "id":"12345",
                    "code":"S10011",
                    "description":"HOSPITAL",
                    "comments":"HOSPITAL",
                    "isActive":true
                }
            ]
        },
        "limit":{
            "description":"Paging limit",
            "type":"number",
            "example":"5"
        },
        "offset":{
            "description":"Paging offset",
            "type":"number",
            "example":"10"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object guestCommentCategories
  This is to retrieve the configured Guest Comment Category.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/guestCommentCategories"
    },
    "example":[
        {
            "id":"12345",
            "code":"S10011",
            "description":"HOSPITAL",
            "comments":"HOSPITAL",
            "isActive":true
        }
    ]
}

Example:

[
    {
        "id":"12345",
        "code":"S10011",
        "description":"HOSPITAL",
        "comments":"HOSPITAL",
        "isActive":true
    }
]

Nested Schema : guestCommentCategories

Type: object

This is to retrieve the configured Guest Comment Category.

Show Source

• code: string
  Category Code

  Example: S10011
• comments: string
  Category comments

  Example: HOSPITAL
• description: string
  Category description

  Example: HOSPITAL
• id: string
  Category Id

  Example: 12345
• isActive: boolean
  This is to indicate switch to active / In-active Categories * `true` - Active category comments * `false` - Inactive category comments

  Example: true

{
    "description":"This is to retrieve the configured Guest Comment Category.",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/guestCommentCategoriesId"
        },
        "code":{
            "$ref":"#/definitions/guestCommentCategoriesCode"
        },
        "description":{
            "$ref":"#/definitions/guestCommentCategoriesDescription"
        },
        "comments":{
            "$ref":"#/definitions/guestCommentCategoriesComments"
        },
        "isActive":{
            "$ref":"#/definitions/guestCommentCategoriesIsActive"
        }
    }
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error response for Guest Comment Category

{
    "allOf":[
        {
            "$ref":"#/definitions/guestCommentCategoriesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter 'Id' has incorrect format"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter 'Id' has incorrect format"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error response for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "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 for Guest Comment Category

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

Example:

{
    "type":"https://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 for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "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 for Guest Comment Category

{
    "allOf":[
        {
            "$ref":"#/definitions/guestCommentCategoriesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"You are forbidden to use this API"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"You are forbidden to use this API"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error response for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "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 for Guest Comment Category

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

Example:

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

Nested Schema : Error Response

Type: object

Title: Error Response

Error response for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "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 for Guest Comment Category

{
    "allOf":[
        {
            "$ref":"#/definitions/guestCommentCategoriesErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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 for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "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 for Guest Comment Category

{
    "allOf":[
        {
            "$ref":"#/definitions/guestCommentCategoriesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error response for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

410 Response

Gone

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error response for Guest Comment Category

{
    "allOf":[
        {
            "$ref":"#/definitions/guestCommentCategoriesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
        "title":"Gone",
        "detail":"Requested Resource no longer exists"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
    "title":"Gone",
    "detail":"Requested Resource no longer exists"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error response for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "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 for Guest Comment Category

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

Example:

{
    "type":"https://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 for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "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 for Guest Comment Category

{
    "allOf":[
        {
            "$ref":"#/definitions/guestCommentCategoriesErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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 for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

501 Response

Not Implemented

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error response for Guest Comment Category

{
    "allOf":[
        {
            "$ref":"#/definitions/guestCommentCategoriesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
        "title":"Not implemented",
        "detail":"Resource is not implemented in this version of the API"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Not implemented",
    "detail":"Resource is not implemented in this version of the API"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error response for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "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 for Guest Comment Category

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

Example:

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

Nested Schema : Error Response

Type: object

Title: Error Response

Error response for Guest Comment Category

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error response for Guest Comment Category",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top