POST (Header:PUT) api.ashx/v2/ideas/challenge.{json|xml}
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
AllowMultipleVotes | bool | Request Body | Determines whether users can vote on their favorite ideas in this ideation. | Optional | ||
ApplicationKey | string | Request Body | Application Key | Optional | ||
Description | string | Request Body | Description | Optional | ||
Id | Guid | Request Body | Ideation Id | Required | ||
IsEnabled | bool | Request Body | Enabled | Optional | ||
IsModerated | bool | Request Body | Moderate | Optional | ||
MaximumVotesPerIdea | int | Request Body | The maximum number of votes a user can cast for a given idea. Setting to zero(0) will allow a user to use as many votes as they have available on any idea. This setting is only valid when multiple votes are permitted. | Optional | ||
MaximumVotesPerUser | int | Request Body | The maximum number of votes a user can cast within this ideation. To reset this back to 1 vote per user per idea, set it to 0. | Optional | ||
Name | string | Request Body | Ideation Name | Optional | ||
RequiresCategory | bool | Request Body | Determines whether ideas created in this ideation must specify a category. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.put({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/ideas/challenge.json', data: { 'Id': '49fec544-6df7-4a82-872b-f8be586d5e9e' } }).then(function(response) { // use response });
Example Responses
JSON
{ "Challenge": { "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e", "Group": { "Name": "name", "Url": "url", "AvatarUrl": "avatarurl", "Id": 6 }, "ApplicationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "ApplicationTypeId": "fe65240b-044c-4292-9946-f10e0361ecff", "Name": "name", "Description": "description", "ApplicationKey": "applicationkey", "CreatedDate": "2012-01-04T00:00:00", "IsEnabled": true, "TotalPosts": 25, "LastPostDate": "2012-05-02T00:00:00", "MaximumVotesPerUser": 8, "MaximumVotesPerIdea": 4, "RequiresCategory": true, "AllowMultipleVotes": true }, "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <Challenge> <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id> <Group> <Name>name</Name> <Url>url</Url> <AvatarUrl>avatarurl</AvatarUrl> <Id>6</Id> </Group> <ApplicationId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationId> <ApplicationTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationTypeId> <Name>name</Name> <Description>description</Description> <ApplicationKey>applicationkey</ApplicationKey> <CreatedDate>2012-01-04T00:00:00</CreatedDate> <IsEnabled>true</IsEnabled> <TotalPosts>25</TotalPosts> <LastPostDate>2012-05-02T00:00:00</LastPostDate> <MaximumVotesPerUser>8</MaximumVotesPerUser> <MaximumVotesPerIdea>4</MaximumVotesPerIdea> <RequiresCategory>true</RequiresCategory> <AllowMultipleVotes>true</AllowMultipleVotes> </Challenge> <Errors> <Message>string</Message> <Message>string</Message> </Errors> </Response>