GET api/v2.0/Demographics/GetDemographicTypes

Get the available Demographic Types.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A collection of Demographic Types.

Collection of DemographicType
NameDescriptionTypeAdditional information
DemographicTypeKey

Unique key for the Demographic Type.

globally unique identifier

None.

Name

Name of the Demographic Type.

string

None.

Description

Description of the Demographic Type.

string

None.

IsNetwork

Is this Demographic Type associated with a Network?

boolean

None.

IsFreeFormAllowed

Can this Demographic Type be used with Free-Form Demographic entries?

boolean

None.

IsMultiSelect

Is this Demographic Type to be used with Multi-select responses.

boolean

None.

IsPerson

Is this Demographic Type related to Contacts?

boolean

None.

ShowDescriptionInProfile

Should this Demographic Type's description be shown in a user's Profile?

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DemographicTypeKey": "2a19a2b2-c129-42d0-9992-dbfc281b140a",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsNetwork": true,
    "IsFreeFormAllowed": true,
    "IsMultiSelect": true,
    "IsPerson": true,
    "ShowDescriptionInProfile": true
  },
  {
    "DemographicTypeKey": "2a19a2b2-c129-42d0-9992-dbfc281b140a",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsNetwork": true,
    "IsFreeFormAllowed": true,
    "IsMultiSelect": true,
    "IsPerson": true,
    "ShowDescriptionInProfile": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfDemographicType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Demographics">
  <DemographicType>
    <DemographicTypeKey>2a19a2b2-c129-42d0-9992-dbfc281b140a</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>
  <DemographicType>
    <DemographicTypeKey>2a19a2b2-c129-42d0-9992-dbfc281b140a</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>
</ArrayOfDemographicType>