Jump to

• Request
• Response

Sync an unregister attendance record

delete

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

This is to sync an unregister attendance record

Request

Supported Media Types

• application/json

Path Parameters

• registrationId(required): integer
  Profile registration id.
• safetyMode(required): string
  Values: * `EMERCY` - Emergency Passenger Drill * `GENASS` - General Assembly * `ASHSHP` - Abandon Ship

  Allowed Values: [ "EMERCY", "GENASS", "ASHSHP" ]
• shipId(required): number
  ship Id

Back to Top

Response

Supported Media Types

• application/json

200 Response

Return 200 if registration record is unregistered successfully.

204 Response

Return 204 if registration record cannot be found by registration id.

400 Response

Bad Request

Body ()

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.1",
        "title":"Bad Request",
        "detail":"Safety mode ABC is invalid."
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Safety mode ABC is invalid."
}

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

Body ()

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

Body ()

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

Body ()

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.5",
        "title":"Not Found",
        "detail":"Ship Id could not be found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be 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

Body ()

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

Body ()

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"
        }
    }
}

500 Response

Internal Server Error

Body ()

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"
        }
    }
}

503 Response

Service Unavailable

Body ()

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"
        }
    }
}

Back to Top