Developers

Winning Ideas in a Challenge

Retrieves the winning ideas in a challenge contains all information to review an idea which includes:

  • Idea information see Idea Profile.
  • Submission questions
  • Private comments - If the on behalf of user is a member of the challenge review team
  • Drop down fields, with the possibility of containing
    • Choices
  • Open text fields
  • Rating fields
    • Rating

GET: /api/challenge/winningIdeas/[id number of challenge]

This API endpoint is capable of pagination. Note the presence of the following elements:

<NumberOfResults>2</NumberOfResults>
<Page>0</Page>
<TotalResults>59</TotalResults>
    

For more information on paged results, see the Query Strings that manipulate responses section on the API overview page.

<Results xmlns="http://brainstorm.intuit.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Data>
        <ChallengeIdea>
            <DropDownFields>
                <DropDownField>
                    <Id>1669</Id>
                    <Label>Challenge Drop Down List</Label>
                    <Position>1</Position>
                    <Choices>
                        <Choice>
                            <Label>First Choice</Label>
                            <Position>0</Position>
                            <Value>875</Value>
                        </Choice>
                        <Choice>
                            <Label>Second Choice</Label>
                            <Position>1</Position>
                            <Value>876</Value>
                        </Choice>
                        <Choice>
                            <Label>Third Choice</Label>
                            <Position>2</Position>
                            <Value>877</Value>
                        </Choice>
                    </Choices>
                    <Value i:nil="true"/>
                </DropDownField>
            </DropDownFields>
            <Idea>
                <Id>7712</Id>
                <AvgRatingRounded>0</AvgRatingRounded>
                <BusinessUnitName>Consumer: Personal Finance</BusinessUnitName>
                <CommentCount>0</CommentCount>
                <PunchLine>API Test idea 10/6/2011 12:16:00 PM</PunchLine>
                <ScoreRecent>5.1</ScoreRecent>
                <StatusName>Just an idea, not working on it</StatusName>
                <SubmittedOn>2011-10-06T12:16:00</SubmittedOn>
                <Submitter>
                    <Id>18003</Id>
                    <DisplayName>Dan Jackson</DisplayName>
                    <EmailWork>dan_jackson@intuit.com</EmailWork>
                    <Location>0102184, Mountain View, CA</Location>
                    <Phone/>
                    <PhotoExists>false</PhotoExists>
                    <PhotoUrl_36x36>http://localhost.localhost/Images/photo_none_small.jpg</PhotoUrl_36x36>
                    <Title>SW Engineer 2</Title>
                </Submitter>
                <TotalRatings>0</TotalRatings>
                <Comments/>
                <Tabs>
                    <Tab>
                        <DocumentParts/>
                        <LinkParts/>
                        <Name>Main</Name>
                        <Notes>
                            <Note>
                                <Id>18243</Id>
                                <Body>This is the description</Body>
                                <Title>Description</Title>
                            </Note>
                        </Notes>
                        <Position>1000</Position>
                        <TodoListParts/>
                    </Tab>
                </Tabs>
                <Team>
                    <Person>
                        <Id>18003</Id>
                        <DisplayName>Dan Jackson</DisplayName>
                        <EmailWork>dan_jackson@intuit.com</EmailWork>
                        <Location>0102184, Mountain View, CA</Location>
                        <Phone/>
                        <PhotoExists>false</PhotoExists>
                        <PhotoUrl_36x36>http://localhost.localhost/Images/photo_none_small.jpg</PhotoUrl_36x36>
                        <Title>SW Engineer 2</Title>
                    </Person>
                </Team>
            </Idea>
            <OpenTextFields>
                <OpenTextField>
                    <Id>1670</Id>
                    <Label>Challenge Text Field</Label>
                    <Position>2</Position>
                    <Value/>
                </OpenTextField>
            </OpenTextFields>
            <PrivateComments>
                <Comment>
                    <Author>
                        <DisplayName>Dan Jackson</DisplayName>
                        <EmailWork>dan_jackson@intuit.com</EmailWork>
                        <PhotoExists>false</PhotoExists>
                        <PhotoUrl_36x36>/Images/photo_none_icon.jpg</PhotoUrl_36x36>
                    </Author>
                    <Body><p>This is a private comment</p></Body>
                    <ByIdeaTeamMember>true</ByIdeaTeamMember>
                    <Id>15750</Id>
                    <LikeCount>0</LikeCount>
                    <PostTime>2011-10-06T19:33:30</PostTime>
                    <Replies/>
                </Comment>
            </PrivateComments>
            <RatingFields>
                <RatingField>
                    <Id>1668</Id>
                    <Label>Overall Rating</Label>
                    <Position>0</Position>
                    <AverageRating>3</AverageRating>
                    <Ratings>
                        <Rating>
                            <Label>Well below average</Label>
                            <Rating>1</Rating>
                            <Reviewers/>
                        </Rating>
                        <Rating>
                            <Label>Below average</Label>
                            <Rating>2</Rating>
                            <Reviewers/>
                        </Rating>
                        <Rating>
                            <Label>Average</Label>
                            <Rating>3</Rating>
                            <Reviewers>
                                <Person>
                                    <DisplayName>Dan Jackson</DisplayName>
                                    <EmailWork>dan_jackson@intuit.com</EmailWork>
                                    <PhotoExists>false</PhotoExists>
                                    <PhotoUrl_36x36>/Images/photo_none_icon.jpg</PhotoUrl_36x36>
                                </Person>
                            </Reviewers>
                        </Rating>
                        <Rating>
                            <Label>Above average</Label>
                            <Rating>4</Rating>
                            <Reviewers/>
                        </Rating>
                        <Rating>
                            <Label>Well above average</Label>
                            <Rating>5</Rating>
                            <Reviewers/>
                        </Rating>
                    </Ratings>
                </RatingField>
            </RatingFields>
            <SubmissionQuestions/>
        </ChallengeIdea>
    </Data>
    <NumberOfResults>1</NumberOfResults>
    <Page>0</Page>
    <TotalResults>1</TotalResults>
</Results>
            
{
    "Data": [
        {
            "DropDownFields": [
                {
                    "Id": 1669,
                    "Label": "Challenge Drop Down List",
                    "Position": 1,
                    "Choices": [
                        {
                            "Label": "First Choice",
                            "Position": 0,
                            "Value": "875"
                        },
                        {
                            "Label": "Second Choice",
                            "Position": 1,
                            "Value": "876"
                        },
                        {
                            "Label": "Third Choice",
                            "Position": 2,
                            "Value": "877"
                        }
                    ],
                    "Value": null
                }
            ],
            "Idea": {
                "Id": 7712,
                "AvgRatingRounded": 0,
                "BusinessUnitName": "Consumer: Personal Finance",
                "CommentCount": 0,
                "PunchLine": "API Test idea 10/6/2011 12:16:00 PM",
                "ScoreRecent": 5.1,
                "StatusName": "Just an idea, not working on it",
                "SubmittedOn": "/Date(1317928560000-0700)/",
                "Submitter": {
                    "Id": 18003,
                    "DisplayName": "Dan Jackson",
                    "EmailWork": "dan_jackson@intuit.com",
                    "Location": "0102184, Mountain View, CA",
                    "Phone": "",
                    "PhotoExists": false,
                    "PhotoUrl_36x36": "http://localhost.localhost/Images/photo_none_small.jpg",
                    "Title": "SW Engineer 2"
                },
                "TotalRatings": 0,
                "Comments": [],
                "Tabs": [
                    {
                        "DocumentParts": [],
                        "LinkParts": [],
                        "Name": "Main",
                        "Notes": [
                            {
                                "Id": 18243,
                                "Body": "This is the description",
                                "Title": "Description"
                            }
                        ],
                        "Position": 1000,
                        "TodoListParts": []
                    }
                ],
                "Team": [
                    {
                        "Id": 18003,
                        "DisplayName": "Dan Jackson",
                        "EmailWork": "dan_jackson@intuit.com",
                        "Location": "0102184, Mountain View, CA",
                        "Phone": "",
                        "PhotoExists": false,
                        "PhotoUrl_36x36": "http://localhost.localhost/Images/photo_none_small.jpg",
                        "Title": "SW Engineer 2"
                    }
                ]
            },
            "OpenTextFields": [
                {
                    "Id": 1670,
                    "Label": "Challenge Text Field",
                    "Position": 2,
                    "Value": ""
                }
            ],
            "PrivateComments": [
                {
                    "Author": {
                        "DisplayName": "Dan Jackson",
                        "EmailWork": "dan_jackson@intuit.com",
                        "PhotoExists": false,
                        "PhotoUrl_36x36": "/Images/photo_none_icon.jpg"
                    },
                    "Body": "

This is a private comment

", "ByIdeaTeamMember": true, "Id": 15750, "LikeCount": 0, "PostTime": "/Date(1317954810000-0700)/", "Replies": [] } ], "RatingFields": [ { "Id": 1668, "Label": "Overall Rating", "Position": 0, "AverageRating": 3, "Ratings": [ { "Label": "Well below average", "Rating": 1, "Reviewers": [] }, { "Label": "Below average", "Rating": 2, "Reviewers": [] }, { "Label": "Average", "Rating": 3, "Reviewers": [ { "DisplayName": "Dan Jackson", "EmailWork": "dan_jackson@intuit.com", "PhotoExists": false, "PhotoUrl_36x36": "/Images/photo_none_icon.jpg" } ] }, { "Label": "Above average", "Rating": 4, "Reviewers": [] }, { "Label": "Well above average", "Rating": 5, "Reviewers": [] } ] } ], "SubmissionQuestions": [] } ], "NumberOfResults": 1, "Page": 0, "TotalResults": 1 }

Explaination of pagination elements

  • The <NumberOfResults> value designates how many results are contained in the response.
  • The <Page> value designates how many results were skipped
  • The <TotalResults> value designates how many total results exist.