Loading ...

REST API: Get User's Recognition Programs | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Recognition » REST API: Get User's Recognition Programs
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get User's Recognition Programs

0 
 /5
0 (0votes)

Get User's Recognition Programs

GET /api/recognition/awards/programs

Get a list of recognition programs a user can participate in. 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.
ForUserID Used in the request URL as a query parameter User ID of the user to get a list of recognition programs for.

Example Request

GET https://myintranet.communifire.com/api/recognition/awards/programs?ForUserID=641

Example Response

Recognition program JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ContentID": 7089,
      "EntityType": 74,
      "ContentTypeID": 0,
      "ContentTitle": "Community Recognition Program",
      "ContentStub": "community-recognition-program",
      "ContentBody": "",
      "ContentSummary": "The Community Recognition Program rewards people who contribute most to the organization's culture and goals.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "ParentContentID": 0,
      "ContentVersionID": 0,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 0,
      "DateCreated": "2020-01-21T08:41:23.21",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0.0,
      "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/assets/Themes/default/images/photo-placeholder.gif",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 0,
      "CategoryStub": "",
      "AuthorAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
      "AuthorProfileUrl": "https://myintranet.communifire.com/people/admin",
      "TagsCSV": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "",
      "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,
      "ViewerVote": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "ParentContentStub": "",
      "GrandParentContentStub": "",
      "GreatGrandParentContentStub": "",
      "IsContentAvailablePostExpiry": false,
      "SystemName": "DefaultRecogntionProgram",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "TenantID": 0
    },
    {
      "ContentID": 7142,
      "EntityType": 74,
      "ContentTypeID": 0,
      "ContentTitle": "Getting Started Program",
      "ContentStub": "getting-started-program",
      "ContentBody": "",
      "ContentSummary": "These Badges and Recognition are earned through activity challenges completed in our community site when you are getting started as a new member.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "ParentContentID": 0,
      "ContentVersionID": 0,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 0,
      "DateCreated": "2020-03-07T08:03:56.593",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0.0,
      "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/assets/Themes/default/images/photo-placeholder.gif",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 44,
      "CategoryStub": "",
      "AuthorAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/66cf48bb-c3df-441b-9ee7-0db833f7b41f.jpeg",
      "AuthorProfileUrl": "https://myintranet.communifire.com/people/admin",
      "TagsCSV": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "",
      "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,
      "ViewerVote": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "ParentContentStub": "",
      "GrandParentContentStub": "",
      "GreatGrandParentContentStub": "",
      "IsContentAvailablePostExpiry": false,
      "SystemName": "",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "TenantID": 0
    },
    {
      "ContentID": 12212,
      "EntityType": 74,
      "ContentTypeID": 0,
      "ContentTitle": "HR Recognition Program",
      "ContentStub": "hr-recognition-program",
      "ContentBody": "",
      "ContentSummary": "A recognition program for the HR department.",
      "AuthorID": 1,
      "AuthorUserName": "admin",
      "ParentContentID": 0,
      "ContentVersionID": 0,
      "SpaceID": 0,
      "WorkflowID": 0,
      "CurrentWorkflowStepID": 0,
      "StatusID": 0,
      "DateCreated": "2021-02-10T19:54:33.593",
      "IsFeatured": false,
      "ViewCount": 0,
      "CommentCount": 0,
      "Rating": 0.0,
      "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/assets/Themes/default/images/photo-placeholder.gif",
      "LikesCount": 0,
      "DoesCurrentUserLike": false,
      "ContentMediaServerID": 64,
      "CategoryStub": "",
      "AuthorAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
      "AuthorProfileUrl": "https://myintranet.communifire.com/people/admin",
      "TagsCSV": "",
      "IsPublishedFromDraftMode": false,
      "ParentContentTitle": "",
      "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,
      "ViewerVote": 0,
      "IsDirectory": false,
      "IsActivityStreamAlbum": false,
      "LastChildAuthorUserID": 0,
      "LastGrandChildAuthorUserID": 0,
      "ParentContentStub": "",
      "GrandParentContentStub": "",
      "GreatGrandParentContentStub": "",
      "IsContentAvailablePostExpiry": false,
      "SystemName": "",
      "IsExternalContent": false,
      "IsAnonymous": false,
      "OriginalAuthorID": 1,
      "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