Loading ...

REST API: Get Challenges | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Recognition » REST API: Get Challenges
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get Challenges

0 
 /5
0 (0votes)

Get Challenges

GET /api/recognition/challenges

Get a list of badge challenges. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
ProgramID Used in the request URL as a query parameter ID of the recognition program to get a list of challenges for.
StartPage Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET https://myintranet.communifire.com/api/recognition/challenges?ProgramID=7089&StartPage=1&PageLength=3

Example Response

Challenge JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ProcessID": 34,
      "ProcessTitle": "Connect with 10 coworkers",
      "ProcessDescription": "Connect with 10 coworkers to win this badge.",
      "ProcessType": 1,
      "DateCreated": "2018-03-16T16:38:53.327",
      "IsActive": true,
      "SpaceIDCSV": "",
      "InSequence": false,
      "RepeatableBySite": true,
      "RepeatableByUser": true,
      "ContentTypeIDCSV": "",
      "EntityTypeIDCSV": "",
      "AwardContentID": 6902,
      "AwardContentTitle": "Connector",
      "AwardContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/d9dfe3a5-d069-4052-9deb-d3c05b2a4463.jpg",
      "AwardContentStub": "connector",
      "AwardContentURL": "/badges/6902/connector",
      "OutcomeEmailTemplate": "",
      "OutcomePoints": 50,
      "OutcomeNotifyResourceKey": "",
      "TenantID": 0
    },
    {
      "ProcessID": 38,
      "ProcessTitle": "Create 10 tasks for yourself",
      "ProcessDescription": "Create 10 tasks to win this award.",
      "ProcessType": 1,
      "DateCreated": "2018-03-16T17:10:33.863",
      "IsActive": true,
      "SpaceIDCSV": "",
      "InSequence": false,
      "RepeatableBySite": true,
      "RepeatableByUser": true,
      "ContentTypeIDCSV": "",
      "EntityTypeIDCSV": "",
      "AwardContentID": 6905,
      "AwardContentTitle": "Taskmaster",
      "AwardContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/1d439da3-b73f-471a-9354-90f7cd5b03d1.jpg",
      "AwardContentStub": "taskmaster",
      "AwardContentURL": "/badges/6905/taskmaster",
      "OutcomeEmailTemplate": "",
      "OutcomePoints": 50,
      "OutcomeNotifyResourceKey": "",
      "TenantID": 0
    },
    {
      "ProcessID": 32,
      "ProcessTitle": "Create 3 Articles",
      "ProcessDescription": "Create 3 articles anywhere in the intranet to win this badge.",
      "ProcessType": 1,
      "DateCreated": "2018-03-16T16:08:45.137",
      "IsActive": true,
      "SpaceIDCSV": "",
      "InSequence": true,
      "RepeatableBySite": true,
      "RepeatableByUser": true,
      "ContentTypeIDCSV": "",
      "EntityTypeIDCSV": "",
      "AwardContentID": 6900,
      "AwardContentTitle": "Communicator",
      "AwardContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/203fa2fc-7701-45d6-92d7-6ac123f1d5a8.jpg",
      "AwardContentStub": "communicator",
      "AwardContentURL": "/badges/6900/communicator",
      "OutcomeEmailTemplate": "",
      "OutcomePoints": 50,
      "OutcomeNotifyResourceKey": "",
      "TenantID": 0
    }
  ]
}

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software