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 DemographicChoice

Name	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": "32b185b8-ebef-4731-a7c2-a475c29ecc58",
    "DemographicType": {
      "DemographicTypeKey": "936b1896-78b1-4d36-a3d6-0386e989c00a",
      "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": "32b185b8-ebef-4731-a7c2-a475c29ecc58",
    "DemographicType": {
      "DemographicTypeKey": "936b1896-78b1-4d36-a3d6-0386e989c00a",
      "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>32b185b8-ebef-4731-a7c2-a475c29ecc58</DemographicKey>
    <DemographicType>
      <DemographicTypeKey>936b1896-78b1-4d36-a3d6-0386e989c00a</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>32b185b8-ebef-4731-a7c2-a475c29ecc58</DemographicKey>
    <DemographicType>
      <DemographicTypeKey>936b1896-78b1-4d36-a3d6-0386e989c00a</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>