Jump to

• Request
• Response

Retrieve the stateroom configuration with criterias.

get

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

This is to retrieve the stateroom configuration with criterias

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number(12345678)
  Ship Identifier number

Query Parameters

• categoryCode(optional): string
  Stateroom Category Code
• categoryName(optional): string
  Stateroom Category Name
• deck(optional): string
  Stateroom Deck
• disembarkationDate(optional): string
  Disembarkation Date
• embarkationDate(optional): string
  Embarkation Date
• features(optional): string
  Stateroom Features
• lifeBoat(optional): string
  Life Boat Code
• limit: integer(int32)
  Paging limit
• musterStation(optional): string
  Muster Station Code
• offset: integer(int32)
  Paging offset
• orderBy(optional): string(stateroomId:asc)
  Order By stateroomId, categoryCode, categoryName, statusCode, deck, stateroomType, with format column1:asc/desc,column2:asc/desc
• stateroomId(optional): string
  Stateroom Id
• stateroomType(optional): string
  Stateroom types like Guest and Crew and Resident
• statusCode(optional): string
  Stateroom Status
• totalBerths(optional): number
  No of Berth
• verticalZone(optional): string
  Vertical Zone Code

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : All stateroom configuration

Type: object

Title: All stateroom configuration

Show Source

• count(optional): integer
  The total number of items in the list.

  Example: 3
• hasMore(optional): boolean
  Flag which indicates whether or not there are more items.

  Example: false
• items(optional): array items

{
    "title":"All stateroom configuration",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"integer",
            "example":3
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StateroomConfiguration"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object StateroomConfiguration
  Title: StateroomConfiguration

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

Nested Schema : StateroomConfiguration

Type: object

Title: StateroomConfiguration

Show Source

• availableBerth(optional): integer
  Example: 2
• categoryCode(optional): string
  Example: 11
• categoryName(optional): string
  Example: Suite con balcone11
• connectingStateroom(optional): string
  Example: 1000,1002
• deck(optional): string
  Example: Deck 1
• features(optional): string
  Example: 2B
• safetyDetails(optional): object Safety Details
  Title: Safety Details
• stateroomId(optional): string
  Maximum Length: 20

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Example: 12345678
• stateroomType(optional): string
  Example: guest
• statusCode(optional): string
  Example: OC
• statusColorCode(optional): string
  Example: 16711680
• statusName(optional): string
  Example: Occupied Clean
• totalBerth(optional): integer
  Example: 4

{
    "title":"StateroomConfiguration",
    "type":"object",
    "properties":{
        "stateroomId":{
            "type":"string",
            "example":"12345678",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "maxLength":20
        },
        "categoryCode":{
            "type":"string",
            "example":"11"
        },
        "categoryName":{
            "type":"string",
            "example":"Suite con balcone11"
        },
        "statusCode":{
            "type":"string",
            "example":"OC"
        },
        "statusName":{
            "type":"string",
            "example":"Occupied Clean"
        },
        "statusColorCode":{
            "type":"string",
            "example":"16711680"
        },
        "features":{
            "type":"string",
            "example":"2B"
        },
        "stateroomType":{
            "type":"string",
            "example":"guest"
        },
        "totalBerth":{
            "type":"integer",
            "example":4
        },
        "availableBerth":{
            "type":"integer",
            "example":2
        },
        "deck":{
            "type":"string",
            "example":"Deck 1"
        },
        "safetyDetails":{
            "$ref":"#/definitions/SafetyDetails"
        },
        "connectingStateroom":{
            "type":"string",
            "example":"1000,1002"
        }
    }
}

Nested Schema : Safety Details

Type: object

Title: Safety Details

Show Source

• lifeBoat(optional): object Life Boat
  Title: Life Boat
• musterStation(optional): object Muster Station
  Title: Muster Station
• verticalZone(optional): object Vertical Zone
  Title: Vertical Zone

{
    "title":"Safety Details",
    "type":"object",
    "properties":{
        "musterStation":{
            "$ref":"#/definitions/MusterStation"
        },
        "lifeBoat":{
            "$ref":"#/definitions/LifeBoat"
        },
        "verticalZone":{
            "$ref":"#/definitions/VerticalZone"
        }
    }
}

Nested Schema : Life Boat

Type: object

Title: Life Boat

Show Source

• code(optional): string
  Example: LB 01
• description(optional): string
  Example: Lifeboat 1

{
    "title":"Life Boat",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"LB 01"
        },
        "description":{
            "type":"string",
            "example":"Lifeboat 1"
        }
    }
}

Nested Schema : Muster Station

Type: object

Title: Muster Station

Show Source

• code(optional): string
  Example: A
• description(optional): string
  Example: ASSEMBLY STATION A

{
    "title":"Muster Station",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"A"
        },
        "description":{
            "type":"string",
            "example":"ASSEMBLY STATION A"
        }
    }
}

Nested Schema : Vertical Zone

Type: object

Title: Vertical Zone

Show Source

• code(optional): string
  Example: 1
• description(optional): string
  Example: Firezone 1

{
    "title":"Vertical Zone",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"1"
        },
        "description":{
            "type":"string",
            "example":"Firezone 1"
        }
    }
}

204 Response

No Content

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/ConfigurationStateroomErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"limit must not be less than one!"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"limit must not be less than one!"
}

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/ConfigurationStateroomErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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/ConfigurationStateroomErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was 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/ConfigurationStateroomErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship 123 was not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship 123 was 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/ConfigurationStateroomErrorResponse"
        }
    ],
    "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 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/ConfigurationStateroomErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://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":"HTTP://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 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/ConfigurationStateroomErrorResponse"
        }
    ],
    "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 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/ConfigurationStateroomErrorResponse"
        }
    ],
    "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