Fetch Campaign Details

POST 
/fetchCampaignDetails

This API return details of a particular campaign required for employee verification. The Authorization must have Bearer followed by Token. Mandatory params: campaignId Optional params: certifierUsername certkey max offset showCampaignConfig (True/ False) Returns the campaign configuration details when set to True. Note: The user attributes in the response is driven by the attributes selected during the campaign launch.

Request

application/json

Body

campaignId string

Responses

200

Fetch Campaign Details

Response Headers

• Date

  string

• Server

  string

• Set-Cookie

  string

• X-Content-Type-Options

  string

application/json

Schema

Schema

Total Preview Certification string[]

campaignDetails

object[]

Array [

certificationame string

certifier string

certkey string

progress string

status string

usercount number

users

object[]

Array [

certfied string

comment string

comments string

consulted string

displayname string

firstname string

totalaccount number

updateuser string

username string

]

]

campaignId string
complete string
count number
errorCode string
msg string

Example (from schema)

{
  "Total Preview Certification": [
    "testLock2 - dbailey (Damien Bailey)"
  ],
  "campaignDetails": [
    {
      "certificationame": "testLock2 - dbailey (Damien Bailey)",
      "certifier": "dlogan",
      "certkey": "12258",
      "progress": "100%",
      "status": "Locked And Task Created",
      "usercount": 5,
      "users": [
        {
          "certfied": "WORKSFORME",
          "comment": "",
          "comments": "",
          "consulted": "true",
          "displayname": "Tabitha Bowers",
          "firstname": "Tabitha",
          "totalaccount": 5,
          "updateuser": "dbailey",
          "username": "tbowers"
        },
        {
          "certfied": "WORKSFORME",
          "comment": "[02/26/19-(admin)] test comments for dbailey[02/26/19-(admin)] test comments for dbailey[02/26/19-(admin)] test comments for dbailey[02/26/19-(admin)] test comments for dbailey[02/26/19-(admin)] test comments for dbailey",
          "comments": "",
          "consulted": "true",
          "displayname": "Ariana Hinton",
          "firstname": "Ariana",
          "totalaccount": 1,
          "updateuser": "dbailey",
          "username": "00039016-9acb-495d-8912-7bc289d0af1b"
        },
        {
          "certfied": "WORKSFORME",
          "comment": "[02/26/19-(admin)] test comments for DEWHE0",
          "comments": "",
          "consulted": "false",
          "displayname": "",
          "firstname": "Mathew",
          "totalaccount": 2,
          "updateuser": "dbailey",
          "username": "194422"
        },
        {
          "certfied": "WORKSFORME",
          "comment": "",
          "comments": "",
          "consulted": "false",
          "displayname": "",
          "firstname": "Shania",
          "totalaccount": 2,
          "updateuser": "dbailey",
          "username": "194445"
        },
        {
          "certfied": "WORKSFORME",
          "comment": "",
          "comments": "",
          "consulted": "false",
          "displayname": "",
          "firstname": "Cody",
          "totalaccount": 1,
          "updateuser": "dbailey",
          "username": "194446"
        }
      ]
    }
  ],
  "campaignId": "232",
  "complete": "Yes",
  "count": 1,
  "errorCode": "0",
  "msg": "successful"
}

Fetch Campaign Details

{
  "Total Preview Certification": [
    "testLock2 - dbailey (Damien Bailey)"
  ],
  "campaignDetails": [
    {
      "certificationame": "testLock2 - dbailey (Damien Bailey)",
      "certifier": "dlogan",
      "certkey": "12258",
      "progress": "100%",
      "status": "Locked And Task Created",
      "usercount": 5,
      "users": [
        {
          "certfied": "WORKSFORME",
          "comment": "",
          "comments": "",
          "consulted": "true",
          "displayname": "Tabitha Bowers",
          "firstname": "Tabitha",
          "totalaccount": 5,
          "updateuser": "dbailey",
          "username": "tbowers"
        },
        {
          "certfied": "WORKSFORME",
          "comment": "[02/26/19-(admin)] test comments for dbailey[02/26/19-(admin)] test comments for dbailey[02/26/19-(admin)] test comments for dbailey[02/26/19-(admin)] test comments for dbailey[02/26/19-(admin)] test comments for dbailey",
          "comments": "",
          "consulted": "true",
          "displayname": "Ariana Hinton",
          "firstname": "Ariana",
          "totalaccount": 1,
          "updateuser": "dbailey",
          "username": "00039016-9acb-495d-8912-7bc289d0af1b"
        },
        {
          "certfied": "WORKSFORME",
          "comment": "[02/26/19-(admin)] test comments for DEWHE0",
          "comments": "",
          "consulted": "false",
          "displayname": "",
          "firstname": "Mathew",
          "totalaccount": 2,
          "updateuser": "dbailey",
          "username": "194422"
        },
        {
          "certfied": "WORKSFORME",
          "comment": "",
          "comments": "",
          "consulted": "false",
          "displayname": "",
          "firstname": "Shania",
          "totalaccount": 2,
          "updateuser": "dbailey",
          "username": "194445"
        },
        {
          "certfied": "WORKSFORME",
          "comment": "",
          "comments": "",
          "consulted": "false",
          "displayname": "",
          "firstname": "Cody",
          "totalaccount": 1,
          "updateuser": "dbailey",
          "username": "194446"
        }
      ]
    }
  ],
  "campaignId": "232",
  "complete": "Yes",
  "count": 1,
  "errorCode": "0",
  "msg": "successful"
}

Loading...