Update Achievement REST Endpoint

Ben Tiedt — Tue, 19 Nov 2019 20:18:11 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:18:11

URLs

POST (Header: PUT) api.ashx/v2/achievement/{id}.xml (or .json)

Request Parameters

Name	Type	Description	Location	Required
Id	`Guid`	Id of the Achievement	Request Body	Required
Title	`string`	Title of the Achievement	Request Body	Optional
Criteria	`string`	Criteria to earn the Achievement	Request Body	Optional
BadgeIconName	`string`	Name of the file representing the badge for the Achievement	Request Body	Optional
BadgeIconData	`Byte[]`	Data of the file representing the badge for the Achievement. If BadgeIconName is specified, either BadgeIconData or BadgeIconUploadContext is required.	Request Body	Optional
BadgeIconUploadContext	`string`	Upload context of the file representing the badge for the Achievement. Either BadgeIconData or BadgeIconUploadContext is required.	Request Body	Optional
Enabled	`bool`	Enabled state of the achievement, whether it can be earned.	Request Body	Optional
RemoveAutomation	`bool`	Removes the automation used by this achievement.	Request Body	Optional
AutomationId	`Guid`	Identifies the ID of the automation used to automatically award/revoke this achievement.	Request Body	Optional
AutomationConfiguration	`string`	Querystring encoded configuration values used by the selected automation for this achievement.	Request Body	Optional

Example Requests

C# REST SDK

This example uses the REST SDK to access the Community REST API within a .Net C# application. In the example, USER_NAME is the user name of the effective user for the request and OAUTH_CLIENT_ID and OAUTH_SECRET are the OAuth client ID and secret, respectively, associated to this application as configured in Administration > Integration > OAuth Clients with the "Client Credentials" grant type enabled. See the documentation for the REST SDK for more details about installation, configuration, and usage options.

var host = new ClientCredentialsRestHost("USER_NAME", "https://mysite.com/", "OAUTH_CLIENT_ID", "OAUTH_SECRET");
var response = host.PutToDynamic(2, "achievement/{id}.json", false, new RestPutOptions {
	PathParameters = new System.Collections.Specialized.NameValueCollection {
		{ "id", "49fec544-6df7-4a82-872b-f8be586d5e9e" }
	}
});

Widget Javascript

This example uses the [[rest JavaScript API Module|rest JavaScript API]] to access the Community REST API within the Community web UI. When accessing the REST API through the javascript API, the effective user is the current contextual user of the web interface.

jQuery.telligent.evolution.put({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/achievement/{id}.json',
	data: { 
		'id': '49fec544-6df7-4a82-872b-f8be586d5e9e'
	},
	success: function(response) {

	}
});

cURL

This example uses the cURL command-line HTTP utility. ENCODED_TOKEN in the example is the base64-encoded concatenation of the user's API key (created from the user's profile), a colon (:), and the user's user name. Learn more about using the REST API.

curl -H "Rest-User-Token: ENCODED_TOKEN" -H "Rest-Method: PUT" -X POST https://mysite.com/api.ashx/v2/achievement/49fec544-6df7-4a82-872b-f8be586d5e9e.xml

Example Responses

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Achievement>
    <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
    <Title>title</Title>
    <Criteria>criteria</Criteria>
    <BadgeIconUrl>badgeiconurl</BadgeIconUrl>
    <Enabled>true</Enabled>
    <CreatedDate>2012-01-04T00:00:00</CreatedDate>
    <AutomationId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</AutomationId>
  </Achievement>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

JSON

{
  "Achievement": {
    "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e",
    "Title": "title",
    "Criteria": "criteria",
    "BadgeIconUrl": "badgeiconurl",
    "Enabled": true,
    "CreatedDate": "2012-01-04T00:00:00",
    "AutomationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
    "AutomationConfiguration": {},
    "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
    "Url": "/achievements/49fec544-6df7-4a82-872b-f8be586d5e9e",
    "Application": {
      "Id": 1,
      "DateCreated": "2018-09-27T21:12:21.52",
      "Description": "",
      "Key": "root",
      "Name": "Telligent Community",
      "ParentGroupId": -1,
      "Url": "http://trunk.community.local.telligent.com/",
      "GroupType": "Joinless",
      "EnableGroupMessages": true,
      "EnableContact": false,
      "TotalMembers": 0,
      "HasGroups": true,
      "PendingMembers": 0,
      "AvatarUrl": "/cfs-file/__key/communityserver-wikis-components-files/00-00-00-12-82/7026.defaulthub.gif",
      "GroupCount": 1,
      "ThemeId": "3fc3f824-83d1-4ec4-85ef-92e206116d49",
      "ApplicationId": "874c3878-ef28-47c5-92c3-23e97ef8b66a",
      "ContainerId": "874c3878-ef28-47c5-92c3-23e97ef8b66a",
      "ExtendedAttributes": [],
      "Warnings": [],
      "Errors": []
    },
    "Warnings": [],
    "Errors": []
  },
  "Errors": [
    "string",
    "string"
  ]
}