Fetch Existing Delegates List
POST/fetchDelegatesList
This API is used to retrieve the list of existing delegates and their details. If any optional parameter is not specified then only active delegates are displayed.
The Authorization
must have Bearer
followed by Token
.
Mandatory params:
userName
- this is the parentusername
Optional params:
max
, offset
,
status
- values can be ACTIVE / INACTIVE
Request
- application/json
Body
max string
status string
userName string
Responses
- 200
Fetch Existing Delegates List
Response Headers
Access-Control-Allow-Credentials
string
Access-Control-Allow-Origin
string
Cache-Control
string
Date
string
Expires
string
Referrer-Policy
string
Server
string
Set-Cookie
string
Strict-Transport-Security
string
X-Content-Type-Options
string
X-Frame-Options
string
- application/json
- Schema
- Example (from schema)
- Fetch Existing Delegates List
Schema
Array [
]
delegateCount number
delegateList
object[]
delegateFirstName string
delegateLastName string
delegatekey string
delegateusername string
description string
enddate string
name string
parentFirstName string
parentLastName string
parentusername string
startdate string
status string
errorCode string
msg string
totalCount string
{
"delegateCount": 1,
"delegateList": [
{
"delegateFirstName": "Daniel",
"delegateLastName": "Schibler",
"delegatekey": "1",
"delegateusername": "U011556",
"description": "",
"enddate": "08/18/2020",
"name": "delegatetest",
"parentFirstName": "Maureen",
"parentLastName": "Knauber",
"parentusername": "U013053",
"startdate": "07/14/2020",
"status": "ACTIVE"
}
],
"errorCode": "0",
"msg": "successful",
"totalCount": "1"
}
{
"delegateCount": 1,
"delegateList": [
{
"delegateFirstName": "Daniel",
"delegateLastName": "Schibler",
"delegatekey": "1",
"delegateusername": "U011556",
"description": "",
"enddate": "08/18/2020",
"name": "delegatetest",
"parentFirstName": "Maureen",
"parentLastName": "Knauber",
"parentusername": "U013053",
"startdate": "07/14/2020",
"status": "ACTIVE"
}
],
"errorCode": "0",
"msg": "successful",
"totalCount": "1"
}
Loading...