List Achievement REST Endpoint

Former Member — Thu, 02 Jun 2022 15:16:47 GMT

Current Revision posted to API Documentation by Former Member on 06/02/2022 15:16:47

GET api.ashx/v2/achievements.{json|xml}

Scopes

Achievements › Read Achievements achievements.achievements.readonly

Request Parameters

Name	Type	Location	Description	Required
Enabled	bool	Query String	Enabled state of the achievements	Optional
PageIndex	int	Query String	Page of results to return	Optional
PageSize	int	Query String	Number of results to return	Optional
SortBy	string	Query String	Accepted values are: Title, DateCreated	Optional
SortOrder	string	Query String	Accepted values are: Ascending, Descending	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/achievements.json'
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "Achievements": [
    {
      "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": "2022-05-11T02:22:50.387",
        "Description": "",
        "Key": "root",
        "Name": "Trunk",
        "ParentGroupId": -1,
        "Url": "http://trunk.local.computer/",
        "GroupType": "Joinless",
        "EnableGroupMessages": true,
        "EnableContact": false,
        "TotalMembers": 0,
        "HasGroups": true,
        "PendingMembers": 0,
        "AvatarUrl": "/cfs-file/__key/communityserver-wikis-components-files/00-00-00-13-86/6523.defaulthub.gif",
        "GroupCount": 3,
        "ThemeId": "3fc3f824-83d1-4ec4-85ef-92e206116d49",
        "ApplicationId": "450fe9a1-32b6-4156-98da-c7d518fba6fe",
        "ContainerId": "450fe9a1-32b6-4156-98da-c7d518fba6fe",
        "ExtendedAttributes": [],
        "Warnings": [],
        "Errors": []
      },
      "Warnings": [],
      "Errors": []
    },
    {
      "Id": "fe65240b-044c-4292-9946-f10e0361ecff",
      "Title": "title",
      "Criteria": "criteria",
      "BadgeIconUrl": "badgeiconurl",
      "Enabled": true,
      "CreatedDate": "2012-05-02T00:00:00",
      "AutomationId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
      "AutomationConfiguration": {},
      "ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
      "Url": "/achievements/fe65240b-044c-4292-9946-f10e0361ecff",
      "Application": {
        "Id": 1,
        "DateCreated": "2022-05-11T02:22:50.387",
        "Description": "",
        "Key": "root",
        "Name": "Trunk",
        "ParentGroupId": -1,
        "Url": "http://trunk.local.computer/",
        "GroupType": "Joinless",
        "EnableGroupMessages": true,
        "EnableContact": false,
        "TotalMembers": 0,
        "HasGroups": true,
        "PendingMembers": 0,
        "AvatarUrl": "/cfs-file/__key/communityserver-wikis-components-files/00-00-00-13-86/6523.defaulthub.gif",
        "GroupCount": 3,
        "ThemeId": "3fc3f824-83d1-4ec4-85ef-92e206116d49",
        "ApplicationId": "450fe9a1-32b6-4156-98da-c7d518fba6fe",
        "ContainerId": "450fe9a1-32b6-4156-98da-c7d518fba6fe",
        "ExtendedAttributes": [],
        "Warnings": [],
        "Errors": []
      },
      "Warnings": [],
      "Errors": []
    }
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Achievements PageSize="2" PageIndex="0" TotalCount="2">
    <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>
    <Achievement>
      <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
      <Title>title</Title>
      <Criteria>criteria</Criteria>
      <BadgeIconUrl>badgeiconurl</BadgeIconUrl>
      <Enabled>true</Enabled>
      <CreatedDate>2012-05-02T00:00:00</CreatedDate>
      <AutomationId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</AutomationId>
    </Achievement>
  </Achievements>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>