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

maxstring
Example: 2
statusstring
Example: ACTIVE
userNamestring
Example: U013053

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

Schema

delegateCountnumber
Example: 1

delegateList

object[]

Array [

delegateFirstNamestring

Example: Daniel

delegateLastNamestring

Example: Schibler

delegatekeystring

Example: 1

delegateusernamestring

Example: U011556

descriptionstring

Example:

enddatestring

Example: 08/18/2020

namestring

Example: delegatetest

parentFirstNamestring

Example: Maureen

parentLastNamestring

Example: Knauber

parentusernamestring

Example: U013053

startdatestring

Example: 07/14/2020

statusstring

Example: ACTIVE

]

errorCodestring
Example: 0
msgstring
Example: successful
totalCountstring
Example: 1

Example (from schema)

{
  "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"
}

Fetch Existing Delegates List

{
  "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"
}