POST api/v2.0/Demographics/AddDemographicChoice
Add a new demographic choice. Can only be accessed by an Admin user.
Request Information
URI Parameters
None.
Body Parameters
DemographicTypeKey: The DemographicTypeKey of the demographic category that this choice is associated with, Name: string, Description: string
DemographicChoiceRequestName | Description | Type | Additional information |
---|---|---|---|
DemographicTypeKey | globally unique identifier |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "DemographicTypeKey": "55b0ecb4-8c7e-4fff-816e-470424f94a45", "Name": "sample string 2", "Description": "sample string 3" }
application/xml, text/xml
Sample:
<DemographicChoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request"> <DemographicTypeKey>55b0ecb4-8c7e-4fff-816e-470424f94a45</DemographicTypeKey> <Description>sample string 3</Description> <Name>sample string 2</Name> </DemographicChoiceRequest>
Response Information
Resource Description
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": "0f84a46a-63d6-4a69-b963-f183330edc14", "DemographicType": { "DemographicTypeKey": "3ef4b11a-e583-4631-aa83-207f0edeaf72", "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:
<DemographicChoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Demographics"> <DemographicKey>0f84a46a-63d6-4a69-b963-f183330edc14</DemographicKey> <DemographicType> <DemographicTypeKey>3ef4b11a-e583-4631-aa83-207f0edeaf72</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>