Loading ...

REST API: Get Awards | Communifire Documentation

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

REST API: Get Awards

0 
 /5
0 (0votes)

Get Awards

GET /api/recognition/awards

Get a list of badges in a specific recognition program. 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.
ProgramID Used in the request URL as a query parameter ID of the recognition program

Example Request

GET https://myintranet.communifire.com/api/recognition/awards?ProgramID=1

Example Response

Award JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ContentID": 10,
      "EntityType": 74,
      "ContentTypeID": 74,
      "ContentTitle": "Creative Thinker",
      "ContentStub": "creative-thinker",
      "ContentBody": "<p>Thank you for your vision and insights! We appreciate the effort and time you put into your work. Your excellent work is an integral part of our company's success. We are thrilled to have you on our team!</p>",
      "ContentBodyUnprocessed": "<p>Thank you for your vision and insights! We appreciate the effort and time you put into your work. Your excellent work is an integral part of our company's success. We are thrilled to have you on our team!</p>",
      "ContentSummary": "Awarded to people who solve problems and get things done.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "Alexis Fox",
      "UpdatedByUserUsername": "admin",
      "UpdatedByUserEmail": "admin@email.com",
      "UpdatedByUserFirstName": "Alexis",
      "UpdatedByUserLastName": "Fox",
      "UpdatedByUserAvatarImageUrl": "https://myintranet.communifire.com/assets/Themes/default/images/avatar-default.jpg",
      "UpdatedByUserProfileUrl": "https://myintranet.communifire.com/people/admin",
      "ParentContentID": 5,
      "ContentVersionID": 1,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "DateCreated": "2021-02-09T20:19:58.637",
      "DatePublished": "2021-02-09T20:19:58.637",
      "DateUpdated": "2021-02-09T20:19:58.637",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0.0,
      "MetaTitle": "Creative Thinker",
      "MetaDescription": "",
      "MetaKeywords": "",
      "ContentFeaturedImage": "CreativeThinker.png",
      "ContentThumbImage": "CreativeThinker.png",
      "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/CreativeThinker.png",
      "ContentThumbImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/CreativeThinker.png",
      "PageH1Content": "",
      "HeadCustomContent": "",
      "SideBarContent": "",
      "ContentExternalID": "",
      "ExtraSideBarContent": "",
      "ExternalURL": "",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 0,
      "ContentMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
      "AuthorDisplayName": "Alexis Fox",
      "AuthorEmail": "admin@email.com",
      "AuthorFirstName": "Alexis",
      "AuthorLastName": "Fox",
      "AuthorAvatarImageUrl": "https://myintranet.communifire.com/assets/Themes/default/images/avatar-default.jpg",
      "AuthorProfileUrl": "https://myintranet.communifire.com/people/admin",
      "TagsCSV": "",
      "DateCreatedString": "23 hours ago",
      "DateCreatedShortString": "23 hours ago",
      "DatePublishedString": "23 hours ago",
      "DatePublishedShortString": "23 hours ago",
      "DateUpdatedString": "23 hours ago",
      "DateUpdatedShortString": "23 hours ago",
      "ContentURL": "/badges/10/creative-thinker",
      "ContentVersionURL": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "Community Recognition Program",
      "IsPublishedFromUnderProcessingMode": false,
      "IsBeingAddedViaExternalSource": false,
      "IsWallContent": false,
      "HasRead": false,
      "ContentTypeIconCSSClass": "icon-check-empty",
      "IsEditable": false,
      "IsWOPI": false,
      "IsDeletable": false,
      "IsDownloadable": false,
      "IsChekoutable": false,
      "IsUndochekoutable": false,
      "IsChekinable": false,
      "IsRestoreable": false,
      "IsPurgeable": false,
      "IsHistoryViewable": false,
      "IsMoveable": false,
      "IsChildContentCreationAllowed": false,
      "IsContentCreationAllowed": false,
      "ContentMediaOnlineViewUrl": "",
      "ContentMediaUrl": "",
      "ContentHistoryUrl": "",
      "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=10&vid=1','Google Docs',800,600)",
      "ViewerVote": 0,
      "VoteCount": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "TotalChildRecords": 0,
      "TotalGrandChildRecords": 0,
      "IsSticky": false,
      "IsAnswered": false,
      "ParentContentStub": "community-recognition-program",
      "AuthorRankImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "AuthorRankName": "Lurker",
      "IsContentAvailablePostExpiry": false,
      "ContentIDCode": "ylw3gZ8rcij9uXKQJWpo3w%3D%3D",
      "SystemName": "CreativeThinkerBadge",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "DateCreatedISOString": "2021-02-09T12:19:58.6370000",
      "DateCreatedFullString": "Tuesday, February 9, 2021 at 12:19 PM",
      "TenantID": 1
    },
    {
      "ContentID": 9,
      "EntityType": 74,
      "ContentTypeID": 74,
      "ContentTitle": "Great Job",
      "ContentStub": "great-job",
      "ContentBody": "<p>Great job! We appreciate you for stepping up and taking initiative. Your skills, work ethic, and professionalism are a great benefit to our company. Thanks for setting a great example for others. Keep up the great work!</p>",
      "ContentBodyUnprocessed": "<p>Great job! We appreciate you for stepping up and taking initiative. Your skills, work ethic, and professionalism are a great benefit to our company. Thanks for setting a great example for others. Keep up the great work!</p>",
      "ContentSummary": "Awarded to people who go above and beyond.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "Alexis Fox",
      "UpdatedByUserUsername": "admin",
      "UpdatedByUserEmail": "admin@email.com",
      "UpdatedByUserFirstName": "Alexis",
      "UpdatedByUserLastName": "Fox",
      "UpdatedByUserAvatarImageUrl": "https://myintranet.communifire.com/assets/Themes/default/images/avatar-default.jpg",
      "UpdatedByUserProfileUrl": "https://myintranet.communifire.com/people/admin",
      "ParentContentID": 5,
      "ContentVersionID": 1,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "DateCreated": "2021-02-09T20:19:58.637",
      "DatePublished": "2021-02-09T20:19:58.637",
      "DateUpdated": "2021-02-09T20:19:58.637",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0.0,
      "MetaTitle": "Great Job",
      "MetaDescription": "",
      "MetaKeywords": "",
      "ContentFeaturedImage": "GreatJob.png",
      "ContentThumbImage": "GreatJob.png",
      "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/GreatJob.png",
      "ContentThumbImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/GreatJob.png",
      "PageH1Content": "",
      "HeadCustomContent": "",
      "SideBarContent": "",
      "ContentExternalID": "",
      "ExtraSideBarContent": "",
      "ExternalURL": "",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 0,
      "ContentMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
      "AuthorDisplayName": "Alexis Fox",
      "AuthorEmail": "admin@email.com",
      "AuthorFirstName": "Alexis",
      "AuthorLastName": "Fox",
      "AuthorAvatarImageUrl": "https://myintranet.communifire.com/assets/Themes/default/images/avatar-default.jpg",
      "AuthorProfileUrl": "https://myintranet.communifire.com/people/admin",
      "TagsCSV": "",
      "DateCreatedString": "23 hours ago",
      "DateCreatedShortString": "23 hours ago",
      "DatePublishedString": "23 hours ago",
      "DatePublishedShortString": "23 hours ago",
      "DateUpdatedString": "23 hours ago",
      "DateUpdatedShortString": "23 hours ago",
      "ContentURL": "/badges/9/great-job",
      "ContentVersionURL": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "Community Recognition Program",
      "IsPublishedFromUnderProcessingMode": false,
      "IsBeingAddedViaExternalSource": false,
      "IsWallContent": false,
      "HasRead": false,
      "ContentTypeIconCSSClass": "icon-check-empty",
      "IsEditable": false,
      "IsWOPI": false,
      "IsDeletable": false,
      "IsDownloadable": false,
      "IsChekoutable": false,
      "IsUndochekoutable": false,
      "IsChekinable": false,
      "IsRestoreable": false,
      "IsPurgeable": false,
      "IsHistoryViewable": false,
      "IsMoveable": false,
      "IsChildContentCreationAllowed": false,
      "IsContentCreationAllowed": false,
      "ContentMediaOnlineViewUrl": "",
      "ContentMediaUrl": "",
      "ContentHistoryUrl": "",
      "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=9&vid=1','Google Docs',800,600)",
      "ViewerVote": 0,
      "VoteCount": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "TotalChildRecords": 0,
      "TotalGrandChildRecords": 0,
      "IsSticky": false,
      "IsAnswered": false,
      "ParentContentStub": "community-recognition-program",
      "AuthorRankImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "AuthorRankName": "Lurker",
      "IsContentAvailablePostExpiry": false,
      "ContentIDCode": "R1Bex5Fmk3WMtSyMK0TlMg%3D%3D",
      "SystemName": "GreatJobBadge",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "DateCreatedISOString": "2021-02-09T12:19:58.6370000",
      "DateCreatedFullString": "Tuesday, February 9, 2021 at 12:19 PM",
      "TenantID": 1
    },
    {
      "ContentID": 8,
      "EntityType": 74,
      "ContentTypeID": 74,
      "ContentTitle": "Innovation",
      "ContentStub": "innovation",
      "ContentBody": "<p>Your work is outstanding! Your ability to create and implement solutions for our customer's needs adds significant value to our company and brand. Your vision and skills are invaluable to our organization. Keep up the great work!</p>",
      "ContentBodyUnprocessed": "<p>Your work is outstanding! Your ability to create and implement solutions for our customer's needs adds significant value to our company and brand. Your vision and skills are invaluable to our organization. Keep up the great work!</p>",
      "ContentSummary": "Awarded to people who demonstrate brilliant thinking.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "UpdatedByUserID": 1,
      "UpdatedByUserDisplayName": "Alexis Fox",
      "UpdatedByUserUsername": "admin",
      "UpdatedByUserEmail": "admin@email.com",
      "UpdatedByUserFirstName": "Alexis",
      "UpdatedByUserLastName": "Fox",
      "UpdatedByUserAvatarImageUrl": "https://myintranet.communifire.com/assets/Themes/default/images/avatar-default.jpg",
      "UpdatedByUserProfileUrl": "https://myintranet.communifire.com/people/admin",
      "ParentContentID": 5,
      "ContentVersionID": 1,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 1,
      "DateCreated": "2021-02-09T20:19:58.637",
      "DatePublished": "2021-02-09T20:19:58.637",
      "DateUpdated": "2021-02-09T20:19:58.637",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0.0,
      "MetaTitle": "Innovation",
      "MetaDescription": "",
      "MetaKeywords": "",
      "ContentFeaturedImage": "Innovation.png",
      "ContentThumbImage": "Innovation.png",
      "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/Innovation.png",
      "ContentThumbImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/Innovation.png",
      "PageH1Content": "",
      "HeadCustomContent": "",
      "SideBarContent": "",
      "ContentExternalID": "",
      "ExtraSideBarContent": "",
      "ExternalURL": "",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 0,
      "ContentMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
      "AuthorDisplayName": "Alexis Fox",
      "AuthorEmail": "admin@email.com",
      "AuthorFirstName": "Alexis",
      "AuthorLastName": "Fox",
      "AuthorAvatarImageUrl": "https://myintranet.communifire.com/assets/Themes/default/images/avatar-default.jpg",
      "AuthorProfileUrl": "https://myintranet.communifire.com/people/admin",
      "TagsCSV": "",
      "DateCreatedString": "23 hours ago",
      "DateCreatedShortString": "23 hours ago",
      "DatePublishedString": "23 hours ago",
      "DatePublishedShortString": "23 hours ago",
      "DateUpdatedString": "23 hours ago",
      "DateUpdatedShortString": "23 hours ago",
      "ContentURL": "/badges/8/innovation",
      "ContentVersionURL": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "Community Recognition Program",
      "IsPublishedFromUnderProcessingMode": false,
      "IsBeingAddedViaExternalSource": false,
      "IsWallContent": false,
      "HasRead": false,
      "ContentTypeIconCSSClass": "icon-check-empty",
      "IsEditable": false,
      "IsWOPI": false,
      "IsDeletable": false,
      "IsDownloadable": false,
      "IsChekoutable": false,
      "IsUndochekoutable": false,
      "IsChekinable": false,
      "IsRestoreable": false,
      "IsPurgeable": false,
      "IsHistoryViewable": false,
      "IsMoveable": false,
      "IsChildContentCreationAllowed": false,
      "IsContentCreationAllowed": false,
      "ContentMediaOnlineViewUrl": "",
      "ContentMediaUrl": "",
      "ContentHistoryUrl": "",
      "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=8&vid=1','Google Docs',800,600)",
      "ViewerVote": 0,
      "VoteCount": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "TotalChildRecords": 0,
      "TotalGrandChildRecords": 0,
      "IsSticky": false,
      "IsAnswered": false,
      "ParentContentStub": "community-recognition-program",
      "AuthorRankImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "AuthorRankName": "Lurker",
      "IsContentAvailablePostExpiry": false,
      "ContentIDCode": "hcaf187hT77scprlnRXuOQ%3D%3D",
      "SystemName": "InnovationBadge",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "DateCreatedISOString": "2021-02-09T12:19:58.6370000",
      "DateCreatedFullString": "Tuesday, February 9, 2021 at 12:19 PM",
      "TenantID": 1
    }
  ]
}

 

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

 

Wiki Index

Pages

Intranet Software