GET api/v2.0/Demographics/GetDemographicChoices?demographicTypeKey={demographicTypeKey}
Returns a list of all existing demographic choices for a given demographic category
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
demographicTypeKey |
The DemographicTypeKey for the desired demographic category |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of DemographicChoiceName | Description | Type | Additional information |
---|---|---|---|
DemographicKey |
Unique key for the Demographic. |
globally unique identifier |
None. |
DemographicType |
Associated Demographic Type. |
DemographicType |
None. |
Name |
Name of the Demographic Choice |
string |
None. |
Description |
Description of the Demographic Choice |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "DemographicKey": "5c5c02db-ea84-4064-a8b2-5e2db982bd67", "DemographicType": { "DemographicTypeKey": "56071d78-7b7f-4478-a970-178809c4c896", "Name": "sample string 2", "Description": "sample string 3", "IsNetwork": true, "IsFreeFormAllowed": true, "IsMultiSelect": true, "IsPerson": true, "ShowDescriptionInProfile": true }, "Name": "sample string 2", "Description": "sample string 3" }, { "DemographicKey": "5c5c02db-ea84-4064-a8b2-5e2db982bd67", "DemographicType": { "DemographicTypeKey": "56071d78-7b7f-4478-a970-178809c4c896", "Name": "sample string 2", "Description": "sample string 3", "IsNetwork": true, "IsFreeFormAllowed": true, "IsMultiSelect": true, "IsPerson": true, "ShowDescriptionInProfile": true }, "Name": "sample string 2", "Description": "sample string 3" } ]
application/xml, text/xml
Sample:
<ArrayOfDemographicChoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Demographics"> <DemographicChoice> <DemographicKey>5c5c02db-ea84-4064-a8b2-5e2db982bd67</DemographicKey> <DemographicType> <DemographicTypeKey>56071d78-7b7f-4478-a970-178809c4c896</DemographicTypeKey> <Description>sample string 3</Description> <IsFreeFormAllowed>true</IsFreeFormAllowed> <IsMultiSelect>true</IsMultiSelect> <IsNetwork>true</IsNetwork> <IsPerson>true</IsPerson> <Name>sample string 2</Name> <ShowDescriptionInProfile>true</ShowDescriptionInProfile> </DemographicType> <Description>sample string 3</Description> <Name>sample string 2</Name> </DemographicChoice> <DemographicChoice> <DemographicKey>5c5c02db-ea84-4064-a8b2-5e2db982bd67</DemographicKey> <DemographicType> <DemographicTypeKey>56071d78-7b7f-4478-a970-178809c4c896</DemographicTypeKey> <Description>sample string 3</Description> <IsFreeFormAllowed>true</IsFreeFormAllowed> <IsMultiSelect>true</IsMultiSelect> <IsNetwork>true</IsNetwork> <IsPerson>true</IsPerson> <Name>sample string 2</Name> <ShowDescriptionInProfile>true</ShowDescriptionInProfile> </DemographicType> <Description>sample string 3</Description> <Name>sample string 2</Name> </DemographicChoice> </ArrayOfDemographicChoice>