Jump to

• Request
• Response

Retrieve a list of active mustering access rights for each active user group

get

/spms/v2/ships/{shipId}/safety/userGroups/accessRoleTasks

This is to retrieve a list of mustering access rights for each active user group.

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 userGroupId, userGroupCode, userGroupDescription with format column1:asc/desc,column2:asc/desc,column3:asc/desc,column4:asc/desc,column5:asc/desc,column6:asc/desc,column7:asc/desc,column8:asc/desc,column9:asc/desc
• userGroupId: integer
  User group id

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : User Group Response List

Type: object

Title: User Group 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 Group 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/SafetyUserGroupList"
            }
        },
        "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 Group List
  Title: User Group List

  The safety user groups are retrieved successfully

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

Nested Schema : User Group List

Type: object

Title: User Group List

The safety user groups are retrieved successfully

Show Source

• mainTask: array mainTask
• userGroupCode: string
  Group code

  Example: SAFE
• userGroupDescription: string
  Group description

  Example: Safety Department
• userGroupId: integer
  Group id

  Example: 1

{
    "title":"User Group List",
    "description":"The safety user groups are retrieved successfully",
    "type":"object",
    "properties":{
        "userGroupId":{
            "type":"integer",
            "description":"Group id",
            "example":"1"
        },
        "userGroupCode":{
            "type":"string",
            "description":"Group code",
            "example":"SAFE"
        },
        "userGroupDescription":{
            "type":"string",
            "description":"Group description",
            "example":"Safety Department"
        },
        "mainTask":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/SafetyUserGroupMainTask"
                    }
                ]
            }
        }
    }
}

Nested Schema : mainTask

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/SafetyUserGroupMainTask"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object List of User Group Main Tasks
  Title: List of User Group Main Tasks

  List of user group main tasks

{
    "allOf":[
        {
            "$ref":"#/definitions/SafetyUserGroupMainTask"
        }
    ]
}

Nested Schema : List of User Group Main Tasks

Type: object

Title: List of User Group Main Tasks

List of user group main tasks

Show Source

• subTask: array subTask
• taskId: integer
  Task ID

  Example: 1
• taskName: string
  Task Name

  Example: Mustering

{
    "title":"List of User Group Main Tasks",
    "description":"List of user group main tasks",
    "type":"object",
    "properties":{
        "taskId":{
            "description":"Task ID",
            "type":"integer",
            "example":"1"
        },
        "taskName":{
            "description":"Task Name",
            "type":"string",
            "example":"Mustering"
        },
        "subTask":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/SafetyUserGroupSubTask"
                    }
                ]
            }
        }
    }
}

Nested Schema : subTask

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/SafetyUserGroupSubTask"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object List of User Group Sub Tasks
  Title: List of User Group Sub Tasks

  List of user group sub tasks

{
    "allOf":[
        {
            "$ref":"#/definitions/SafetyUserGroupSubTask"
        }
    ]
}

Nested Schema : List of User Group Sub Tasks

Type: object

Title: List of User Group Sub Tasks

List of user group sub tasks

Show Source

• access: array access
• taskId: integer
  Task ID

  Example: 1002
• taskName: string
  Task Name

  Example: Registration

{
    "title":"List of User Group Sub Tasks",
    "description":"List of user group sub tasks",
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "description":"Task ID",
            "example":"1002"
        },
        "taskName":{
            "description":"Task Name",
            "type":"string",
            "example":"Registration"
        },
        "access":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/SafetyUserGroupPredefinedAccess"
                    }
                ]
            }
        }
    }
}

Nested Schema : access

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/SafetyUserGroupPredefinedAccess"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object List of User Group Predefined Access
  Title: List of User Group Predefined Access

  List of user group predefined access

{
    "allOf":[
        {
            "$ref":"#/definitions/SafetyUserGroupPredefinedAccess"
        }
    ]
}

Nested Schema : List of User Group Predefined Access

Type: object

Title: List of User Group Predefined Access

List of user group predefined access

Show Source

• accessId: integer
  Access ID

  Example: 1001
• accessName: string
  Access Name

  Example: Register profile

{
    "title":"List of User Group Predefined Access",
    "description":"List of user group predefined access",
    "type":"object",
    "properties":{
        "accessId":{
            "description":"Access ID",
            "type":"integer",
            "example":"1001"
        },
        "accessName":{
            "description":"Access Name",
            "type":"string",
            "example":"Register profile"
        }
    }
}

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