Jump to

• Request
• Response

Get Users Assigned if the Logged in User is a Supervisor

get

/api/1.0/taskSummary/account/usersAssigned

This endpoint is used to get the users assigned if the Logged in user is a supervisor.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• ifSupervisorToBeAdded: string
  If Supervisor is To Be Added is to specify if supervisor is to be added to the output.

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• userId: string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the users assigned if supervisor.

Body ()

Root Schema : UsersAssignedToSupervisor

Type: object

Returns the list of Users Assigned to the Supervisor UserId and UserName Mapping

Show Source

• usersAssigned(optional): array usersAssigned

{
    "description":"Returns the list of Users Assigned to the Supervisor UserId and UserName Mapping",
    "type":"object",
    "properties":{
        "usersAssigned":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserIdAndUserNameMapping"
            }
        }
    }
}

Nested Schema : usersAssigned

Type: array

Show Source

• Array of: object UserIdAndUserNameMapping
  Returns the Users Assigned to the Supervisor UserId and UserName Mapping

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

Nested Schema : UserIdAndUserNameMapping

Type: object

Returns the Users Assigned to the Supervisor UserId and UserName Mapping

Show Source

• userId(optional): string
• userName(optional): string

{
    "description":"Returns the Users Assigned to the Supervisor UserId and UserName Mapping",
    "type":"object",
    "properties":{
        "userId":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input.

500 Response

Internal error.

Back to Top