Jump to

• Request
• Response

Retrieve the user group access for the login user

get

/spms/v2/ships/{shipId}/userAccessRoleTasks

This is to retrieve the user group access for the login user

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): integer
  ship Id

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : User Groups Response

Type: object

Title: User Groups Response

User Groups Response

Show Source

• isActive: boolean
  Activation status of the sub department: * `true` - Sub Department is active * `false` - Sub Department is inactive

  Example: true
• mainTask: array mainTask
• userGroupCode: string
  Maximum Length: 6

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  User Group Code

  Example: Admin
• userGroupDescription: string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  User Group Description

  Example: Administration
• userGroupId: integer
  Minimum Value: 1

  Pattern: ^[0-9]*$

  User Group ID

  Example: 1001

{
    "title":"User Groups Response",
    "description":"User Groups Response",
    "type":"object",
    "properties":{
        "userGroupId":{
            "$ref":"#/definitions/userGroupId"
        },
        "userGroupCode":{
            "$ref":"#/definitions/userGroupCode"
        },
        "userGroupDescription":{
            "$ref":"#/definitions/userGroupDescription"
        },
        "isActive":{
            "$ref":"#/definitions/isActive"
        },
        "mainTask":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/UserGroupMainTask"
                    }
                ]
            }
        }
    }
}

Nested Schema : mainTask

Type: array

Show Source

• Array of: items

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

Nested Schema : items

Match All

Show Source

• object List of User Group main task
  Title: List of User Group main task

  List of User Group main task

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

Nested Schema : List of User Group main task

Type: object

Title: List of User Group main task

List of User Group main task

Show Source

• subTask: array subTask
• taskId: integer
  Example: 1001
• taskName: string
  Example: Guest Handling
• totalCount: integer
  Example: 50

{
    "title":"List of User Group main task",
    "description":"List of User Group main task",
    "type":"object",
    "properties":{
        "totalCount":{
            "type":"integer",
            "example":"50"
        },
        "taskId":{
            "type":"integer",
            "example":"1001"
        },
        "taskName":{
            "type":"string",
            "example":"Guest Handling"
        },
        "subTask":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/UserGroupSubTask"
                    }
                ]
            }
        }
    },
    "example":{
        "totalCount":"4",
        "taskId":"1001",
        "taskName":"Guest Handling",
        "subTask":[
            {
                "taskId":"1002",
                "taskName":"Guest Profile",
                "access":[
                    {
                        "accessId":"1001",
                        "accessName":"View"
                    },
                    {
                        "accessId":"1002",
                        "accessName":"Edit"
                    }
                ]
            },
            {
                "taskId":"1003",
                "taskName":"Crew Profile",
                "access":[
                    {
                        "accessId":"1003",
                        "accessName":"View"
                    },
                    {
                        "accessId":"1004",
                        "accessName":"Edit"
                    }
                ]
            }
        ]
    }
}

Example:

{
    "totalCount":"4",
    "taskId":"1001",
    "taskName":"Guest Handling",
    "subTask":[
        {
            "taskId":"1002",
            "taskName":"Guest Profile",
            "access":[
                {
                    "accessId":"1001",
                    "accessName":"View"
                },
                {
                    "accessId":"1002",
                    "accessName":"Edit"
                }
            ]
        },
        {
            "taskId":"1003",
            "taskName":"Crew Profile",
            "access":[
                {
                    "accessId":"1003",
                    "accessName":"View"
                },
                {
                    "accessId":"1004",
                    "accessName":"Edit"
                }
            ]
        }
    ]
}

Nested Schema : subTask

Type: array

Show Source

• Array of: items

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

Nested Schema : items

Match All

Show Source

• object List of User Group sub task
  Title: List of User Group sub task

  List of User Group sub task

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

Nested Schema : List of User Group sub task

Type: object

Title: List of User Group sub task

List of User Group sub task

Show Source

• access: array access
• taskId: integer
  Example: 1002
• taskName: string
  Example: Guest Profile

{
    "title":"List of User Group sub task",
    "description":"List of User Group sub task",
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "example":"1002"
        },
        "taskName":{
            "type":"string",
            "example":"Guest Profile"
        },
        "access":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/UserGroupPredefinedAccess"
                    }
                ]
            }
        }
    }
}

Nested Schema : access

Type: array

Show Source

• Array of: items

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

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

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
  Example: 1001
• accessName: string
  Example: View

{
    "title":"List of User Group predefined access",
    "description":"List of User Group predefined access",
    "type":"object",
    "properties":{
        "accessId":{
            "type":"integer",
            "example":"1001"
        },
        "accessName":{
            "type":"string",
            "example":"View"
        }
    }
}

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/UserGroupAccessErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter shipId has incorrect format"
    }
}

Example:

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

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: 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/UserGroupAccessErrorResponse"
        }
    ],
    "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: string
• title: string
• type: 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/UserGroupAccessErrorResponse"
        }
    ],
    "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 : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: 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/UserGroupAccessErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"No user group access is available"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"No user group access is available"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: 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/UserGroupAccessErrorResponse"
        }
    ],
    "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 : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: 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/UserGroupAccessErrorResponse"
        }
    ],
    "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: string
• title: string
• type: 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/UserGroupAccessErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://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":"HTTP://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: string
• title: string
• type: 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/UserGroupAccessErrorResponse"
        }
    ],
    "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: string
• title: string
• type: 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