1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Role Manager
  4. User Group

Update user group details.

put

/spms/v2/ships/{shipId}/roleManagers/userGroups/{userGroupId}/accessRoleTasks

This is to update user group details.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : User Group Request
Type: object
Title: User Group Request
User Group Request
Show Source
Nested Schema : access
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

Updated
Body ()
Root Schema : User Groups Response
Type: object
Title: User Groups Response
User Groups Response
Show Source
Nested Schema : mainTask
Type: array
Show Source
Nested Schema : items
Match All
Show Source
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
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
Nested Schema : items
Match All
Show Source
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
Nested Schema : access
Type: array
Show Source
Nested Schema : items
Match All
Show Source
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

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
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

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
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

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
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

404 Response

Not Found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Profile ID - 123 not found"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
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

406 Response

Not Acceptable
Body ()
Root Schema : schema
Match All
Show Source
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

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
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

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top