GET PlanCare2Api/RootData/ChoiceTypes/{choiceType}/Choices

Gets the choices of the specified choice type.

Request Information

URI Parameters

Name Description Type Additional information
choiceType

The choice type to obtain the choices for

string

Required

Body Parameters

None.

Response Information

Resource Description

The list of requested choices

Collection of Choice
Name Description Type Additional information
Id

The internal id of the choice. Should be 0 for new instance

integer

Required

Name

The name of the choice

string

Required

Description

The description of the choice

string

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfChoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.CareRegistration">
  <Choice>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Choice>
  <Choice>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Choice>
</ArrayOfChoice>