Jump to

• Request
• Response

Retrieve list of all public locations

get

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

This is to retrieve a list of all public locations

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number(12345678)
  Ship ID

Query Parameters

• limit: integer(int32)
  Paging limit
• offset: integer(int32)
  Paging offset
• status: boolean
• title: string

Back to Top

Response

Supported Media Types

• applicaton/json

200 Response

OK

Body ()

Root Schema : GetAllLocations

Type: object

Title: GetAllLocations

Show Source

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

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

  Example: false
• items(optional): array items
• limit(optional): integer
  The size of items in the list.

  Example: 10
• offset(optional): integer
  The page of items in the list.

  Example: 0

{
    "title":"GetAllLocations",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"integer",
            "example":2
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Location"
            },
            "example":[
                {
                    "id":1001,
                    "code":"pool",
                    "title":"Baby Club Chicco",
                    "description":"Pool Side",
                    "comment":"30 meter within the pool",
                    "status":true,
                    "deck":"7",
                    "deckName":"Roof Top",
                    "shouldWarnIfOverLap":false,
                    "picFileName":"RoofTop.jpg"
                },
                {
                    "id":1009,
                    "code":"meet",
                    "title":"Boutique",
                    "description":"Meeting room",
                    "comment":"room 3",
                    "status":false,
                    "deck":"3",
                    "deckName":"deck 3",
                    "shouldWarnIfOverLap":false,
                    "picFileName":"deck3.jpg"
                }
            ]
        },
        "limit":{
            "description":"The size of items in the list.",
            "type":"integer",
            "example":10
        },
        "offset":{
            "description":"The page of items in the list.",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object GetLocation
  Title: GetLocation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Location"
    },
    "example":[
        {
            "id":1001,
            "code":"pool",
            "title":"Baby Club Chicco",
            "description":"Pool Side",
            "comment":"30 meter within the pool",
            "status":true,
            "deck":"7",
            "deckName":"Roof Top",
            "shouldWarnIfOverLap":false,
            "picFileName":"RoofTop.jpg"
        },
        {
            "id":1009,
            "code":"meet",
            "title":"Boutique",
            "description":"Meeting room",
            "comment":"room 3",
            "status":false,
            "deck":"3",
            "deckName":"deck 3",
            "shouldWarnIfOverLap":false,
            "picFileName":"deck3.jpg"
        }
    ]
}

Example:

[
    {
        "id":1001,
        "code":"pool",
        "title":"Baby Club Chicco",
        "description":"Pool Side",
        "comment":"30 meter within the pool",
        "status":true,
        "deck":"7",
        "deckName":"Roof Top",
        "shouldWarnIfOverLap":false,
        "picFileName":"RoofTop.jpg"
    },
    {
        "id":1009,
        "code":"meet",
        "title":"Boutique",
        "description":"Meeting room",
        "comment":"room 3",
        "status":false,
        "deck":"3",
        "deckName":"deck 3",
        "shouldWarnIfOverLap":false,
        "picFileName":"deck3.jpg"
    }
]

Nested Schema : GetLocation

Type: object

Title: GetLocation

Show Source

• code(optional): string
  location code

  Example: Pool
• comment(optional): string
  location comment

  Example: oracle.doceng.json.BetterJsonNull@38379575
• deck(optional): string
  location deck
• deckName(optional): string
  deck name
• description(optional): string
  location description

  Example: Study Room
• id(optional): integer
  This value is refer to Location ID number.

  Example: 1001
• picFileName(optional): string
  location picture filename
• shouldWarnIfOverlap(optional): boolean
  location overlap book (true - Warn, false - Do not Warn)
• status(optional): boolean
  The status of the location

  Example: true
• title(optional): string
  The location title

  Example: Art Gallery

{
    "title":"GetLocation",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/LocationId"
        },
        "code":{
            "type":"string",
            "description":"location code",
            "example":"Pool"
        },
        "title":{
            "type":"string",
            "description":"The location title",
            "example":"Art Gallery"
        },
        "description":{
            "type":"string",
            "description":"location description",
            "example":"Study Room"
        },
        "comment":{
            "type":"string",
            "description":"location comment",
            "example":null
        },
        "status":{
            "type":"boolean",
            "description":"The status of the location",
            "example":"true"
        },
        "deck":{
            "type":"string",
            "description":"location deck"
        },
        "deckName":{
            "type":"string",
            "description":"deck name"
        },
        "shouldWarnIfOverlap":{
            "type":"boolean",
            "description":"location overlap book (true - Warn, false - Do not Warn)"
        },
        "picFileName":{
            "type":"string",
            "description":"location picture filename"
        }
    }
}

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

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "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/ConfigurationLocationErrorResponse"
        }
    ],
    "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/ConfigurationLocationErrorResponse"
        }
    ],
    "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/ConfigurationLocationErrorResponse"
        }
    ],
    "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/ConfigurationLocationErrorResponse"
        }
    ],
    "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/ConfigurationLocationErrorResponse"
        }
    ],
    "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/ConfigurationLocationErrorResponse"
        }
    ],
    "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/ConfigurationLocationErrorResponse"
        }
    ],
    "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