Jump to

• Request
• Response

Retrieve a list of active mustering user details

get

/spms/v2/ships/{shipId}/safety/users

This is to retrieve a list of active mustering user details.

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): number
  ship Id

Query Parameters

• limit: integer(int32)
  Minimum Value: 0

  Paging limit
• offset: integer(int32)
  Minimum Value: 0

  Paging offset
• orderBy: string
  Minimum Value: 0

  order by userDescription, crewName, position, userId, username, photo with format column1:asc/desc,column2:asc/desc,column3:asc/desc,column4:asc/desc,column5:asc/desc,column6:asc/desc
• userId: integer
  User id

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : User Response List

Type: object

Title: User Response List

The wrapper object when returning successful values in Oracle standard

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: false
• items: array items
• limit: number
  Paging limit

  Example: 1
• offset: number
  Paging offset

  Example: 10

{
    "title":"User Response List",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "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":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SafetyUserList"
            }
        },
        "limit":{
            "description":"Paging limit",
            "type":"number",
            "example":"1"
        },
        "offset":{
            "description":"Paging offset",
            "type":"number",
            "example":"10"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object User List
  Title: User List

  The safety users are retrieved successfully

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

Nested Schema : User List

Type: object

Title: User List

The safety users are retrieved successfully

Show Source

• contactlessIds: array contactlessIds
• crewName: string
  User full name

  Example: Adam Koh
• photo: string
  Profile photo url

  Example: /guest/102919/photo
• position: string
  User crew position

  Example: Safety Officer
• userDescription: string
  User login description

  Example: Adman house
• userGroups: array userGroups
• userId: integer
  User id

  Example: 10001
• username: string
  User login name

  Example: Adam2

{
    "title":"User List",
    "description":"The safety users are retrieved successfully",
    "type":"object",
    "properties":{
        "crewName":{
            "type":"string",
            "description":"User full name",
            "example":"Adam Koh"
        },
        "position":{
            "type":"string",
            "description":"User crew position",
            "example":"Safety Officer"
        },
        "userId":{
            "type":"integer",
            "description":"User id",
            "example":"10001"
        },
        "username":{
            "type":"string",
            "description":"User login name",
            "example":"Adam2"
        },
        "userDescription":{
            "type":"string",
            "description":"User login description",
            "example":"Adman house"
        },
        "userGroups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SafetyUserCurrentGroupList"
            }
        },
        "photo":{
            "type":"string",
            "description":"Profile photo url",
            "example":"/guest/102919/photo"
        },
        "contactlessIds":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SafetyContactlessIdList"
            }
        }
    }
}

Nested Schema : contactlessIds

Type: array

Show Source

• Array of: string
  Title: List of User Rfids

  List of user rfids

  Example: 888888888888888, 999999999999999

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

Nested Schema : userGroups

Type: array

Show Source

• Array of: object User Current Group List
  Title: User Current Group List

  User current group list

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

Nested Schema : User Current Group List

Type: object

Title: User Current Group List

User current group list

Show Source

• code: string
  User group code

  Example: SAFE
• id: integer
  User group id

  Example: 1

{
    "title":"User Current Group List",
    "description":"User current group list",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"User group id",
            "example":"1"
        },
        "code":{
            "type":"string",
            "description":"User group code",
            "example":"SAFE"
        }
    }
}

204 Response

No Content

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/SafetyCommonErrorResponse"
        }
    ],
    "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

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

Example:

{
    "type":"https://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/SafetyCommonErrorResponse"
        }
    ],
    "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/SafetyCommonErrorResponse"
        }
    ],
    "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"
        }
    }
}

415 Response

Unsupported Media Type

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/SafetyCommonErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Unsupported Media Type",
        "detail":"Content type not supported"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Unsupported Media Type",
    "detail":"Content type not supported"
}

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/SafetyCommonErrorResponse"
        }
    ],
    "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"
        }
    }
}

Back to Top