Oracle Hospitality Cruise Property Management REST API 23.2.2

Create an attendance

post

/spms/v2/ships/{shipId}/safety/{safetyMode}/registrations

This is to create an attendance

Request

Supported Media Types

application/json

Path Parameters

safetyMode(required): string

Values: * `EMERCY` - Emergency Passenger Drill * `GENASS` - General Assembly * `ASHSHP` - Abandon Ship

Allowed Values: [ "EMERCY", "GENASS", "ASHSHP" ]
shipId(required): integer

ship Id

Root Schema : Registration post request body

Type: object

Title: Registration post request body

Show Source

lifeBoatId(required): integer(int64)

Minimum Value: 0

Maximum Value: 100000000000000000000000000000000000000

Lifeboat id (Mandatory for Abandon Ship)

Example: 123456789
musterStationCode(required): string

Minimum Length: 1

Maximum Length: 6

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

Muster station code (Mandatory for Emergency Passenger Drill and General Assembly)

Example: MS1
profileId(required): integer(int64)

Minimum Value: 0

Maximum Value: 100000000000000000000000000000000000000

User profile id

Example: 123456789
registeredDateTime(required): string(date-time)

Registered date time with local time zone

Example: 2023-01-09T12:30:00.000+08:00

{
    "title":"Registration post request body",
    "type":"object",
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int64",
            "minimum":"0",
            "maximum":"100000000000000000000000000000000000000",
            "example":"123456789",
            "description":"User profile id"
        },
        "musterStationCode":{
            "type":"string",
            "example":"MS1",
            "minLength":"1",
            "maxLength":"6",
            "pattern":"^[a-zA-Z0-9 _,\\?\\/\\.\\-\\\\+\\*\\n~!@#$%&\\{\\}\\[\\]\\(\\)=<>\\|^'\":;`]*$",
            "description":"Muster station code (Mandatory for Emergency Passenger Drill and General Assembly)"
        },
        "lifeBoatId":{
            "type":"integer",
            "format":"int64",
            "minimum":"0",
            "maximum":"100000000000000000000000000000000000000",
            "example":"123456789",
            "description":"Lifeboat id (Mandatory for Abandon Ship)"
        },
        "registeredDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2023-01-09T12:30:00.000+08:00",
            "description":"Registered date time with local time zone"
        }
    },
    "required":[
        "profileId",
        "musterStationCode",
        "lifeBoatId",
        "registeredDateTime"
    ]
}

Response

Supported Media Types

application/json

201 Response

Created

Root Schema : Profile List

Type: object

Title: Profile List

The safety profiles are retrieved successfully

Show Source

cruiseId: integer

Cruise id

Example: 123456789
lifeBoatId: integer(int64)

Profile registered lifeboat id (Value will be null if safety mode is not Abandon Ship (ASHSHP))

Example: 123456789
lifeBoatName: string

Profile registered lifeboat name (Value will be null if safety mode is not Abandon Ship (ASHSHP))

Example: Lifeboat 01
musterStationCode: string

Profile registered muster station code (Value will be null if safety mode is not Emergency Passenger Drill(EMERCY) or General Assembly(GENASS))

Example: MS01
musterStationName: string

Profile registered muster station name (Value will be null if safety mode is not Emergency Passenger Drill(EMERCY) or General Assembly(GENASS))

Example: Muster station 01
profileId: integer

Profile id

Example: 123456789
registeredDateTime: string(date-time)

Registered date time with database time zone

Example: 2023-01-09T10:30:00.000+06:00
registrationId: integer

Profile registration id.

Example: 123456789

{
    "title":"Profile List",
    "description":"The safety profiles are retrieved successfully",
    "type":"object",
    "properties":{
        "registrationId":{
            "type":"integer",
            "description":"Profile registration id.",
            "example":"123456789"
        },
        "profileId":{
            "type":"integer",
            "description":"Profile id",
            "example":"123456789"
        },
        "cruiseId":{
            "type":"integer",
            "description":"Cruise id",
            "example":"123456789"
        },
        "musterStationCode":{
            "type":"string",
            "description":"Profile registered muster station code (Value will be null if safety mode is not Emergency Passenger Drill(EMERCY) or General Assembly(GENASS))",
            "example":"MS01"
        },
        "musterStationName":{
            "type":"string",
            "description":"Profile registered muster station name (Value will be null if safety mode is not Emergency Passenger Drill(EMERCY) or General Assembly(GENASS))",
            "example":"Muster station 01"
        },
        "lifeBoatId":{
            "type":"integer",
            "format":"int64",
            "description":"Profile registered lifeboat id (Value will be null if safety mode is not Abandon Ship (ASHSHP))",
            "example":"123456789"
        },
        "lifeBoatName":{
            "type":"string",
            "description":"Profile registered lifeboat name (Value will be null if safety mode is not Abandon Ship (ASHSHP))",
            "example":"Lifeboat 01"
        },
        "registeredDateTime":{
            "type":"string",
            "format":"date-time",
            "example":"2023-01-09T10:30:00.000+06:00",
            "description":"Registered date time with database time zone"
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

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

Example:

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

Nested Schema : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

401 Response

Unauthorized

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "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 : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

403 Response

Forbidden

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "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 : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

404 Response

Not Found

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

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

Example:

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

Nested Schema : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

405 Response

Method Not Allowed

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "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 : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

406 Response

Not Acceptable

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "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 : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

409 Response

Conflict

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
        "title":"Conflict",
        "detail":"Profile Id ABC has already registered."
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Profile Id ABC has already registered."
}

Nested Schema : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

500 Response

Internal Server Error

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "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 : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

501 Response

Not Implemented

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "example":{
        "type":"http://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":"http://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 : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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

503 Response

Service Unavailable

Root Schema : schema

Match All

Show Source

object Users Error Response

Title: Users Error Response

Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "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 : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

detail: string
title: string
type: string

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