Skip to main content

Fetch Account Entitlement Details

POST 
/fetchCampaignAccEntDetails

This API returns user details, account-entitlement details of a particular campaign required for certify/revoke API. If last certified actions and last certified comments are configured during campaign creation, then it is displayed in the API response. If the employmentStatus parameter is passed with this API, then only the match records in the certified field are displayed in the API response.

The Authorization must have Bearer followed by Token.

Mandatory params:

campaignId

Optional params:

certifierUsername,

certkey,

max(default is 100),

offset(default is 0),

returnFlatResponse(can be true or false)

employmentStatus (NORESPONSE/ WORKSFORME/ DOESNOTWORKFORME/ TERMINATED/ ENDDATE_EXTENDED)

Note: The user attributes in the response is driven by the attributes selected during the campaign launch.

Request​

Path Parameters

    path stringrequired

Body

    campaignId string

Responses​

Fetch Account Entitlement Details

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Pragma

    string

  • Referrer-Policy

    string

  • Server

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • Transfer-Encoding

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

  • X-XSS-Protection

    string

Schema

    campaignAccountEntDetails

    object[]

  • Array [

    • certificationname string
    certkey string
    status string
    usercount number

    users

    object[]

  • Array [

    • accountCount number

    accounts

    object[]

  • Array [

    • accountStatus string
    accountname string
    certaccountkey number
    certfied nullable
    certified string
    comments nullable
    consulted string
    endpoint string
    entitlementcount number

    entitlements

    object[]

  • Array [

    • certEntitlementkey number
    consulted string
    entStatus number
    entcertified nullable
    entcomments nullable
    entcriticality number
    entname string
    enttype string

  • ]

  • ]

    • certfied string
    certuserkey number
    comment string
    consulted string
    userStatus number
    username string

  • ]

  • ]

    • campaignId string
    complete string
    count number
    errorCode string
    msg string
Loading...