POST api/OpenAI/CompareOptionsContribution

Compare medical aid options - Contribution

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PlanTypeID		string	None.
EmployerID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "PlanTypeID": "sample string 1",
  "EmployerID": 2
}

application/xml, text/xml

Sample:

<CompareOptionsParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPH.Entities.Parameters">
  <EmployerID>2</EmployerID>
  <PlanTypeID>sample string 1</PlanTypeID>
</CompareOptionsParm>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CompareOptionsParm'.

Response Information

Resource Description

Collection of MedicalComparison

Name	Type	Additional information
OrderID	integer	None.
ComparisonTopicID	integer	None.
IsHeader	boolean	None.
IsMainCategory	boolean	None.
IsAction	boolean	None.
TopicDescription	string	None.
OptionData	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderID": 1,
    "ComparisonTopicID": 2,
    "IsHeader": true,
    "IsMainCategory": true,
    "IsAction": true,
    "TopicDescription": "sample string 6",
    "OptionData": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "OrderID": 1,
    "ComparisonTopicID": 2,
    "IsHeader": true,
    "IsMainCategory": true,
    "IsAction": true,
    "TopicDescription": "sample string 6",
    "OptionData": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfMedicalComparison xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPH.Entities.Core">
  <MedicalComparison>
    <ComparisonTopicID>2</ComparisonTopicID>
    <IsAction>true</IsAction>
    <IsHeader>true</IsHeader>
    <IsMainCategory>true</IsMainCategory>
    <OptionData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </OptionData>
    <OrderID>1</OrderID>
    <TopicDescription>sample string 6</TopicDescription>
  </MedicalComparison>
  <MedicalComparison>
    <ComparisonTopicID>2</ComparisonTopicID>
    <IsAction>true</IsAction>
    <IsHeader>true</IsHeader>
    <IsMainCategory>true</IsMainCategory>
    <OptionData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </OptionData>
    <OrderID>1</OrderID>
    <TopicDescription>sample string 6</TopicDescription>
  </MedicalComparison>
</ArrayOfMedicalComparison>