POST Api/Comparison/Check

Request Information

URI Parameters

None.

Body Parameters

ParamCheckComparison
NameDescriptionTypeAdditional information
PresaleID

integer

None.

PostCode

string

None.

Suburb

string

None.

NMI

string

None.

MIRN

string

None.

TariffCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PresaleID": 1,
  "PostCode": "sample string 2",
  "Suburb": "sample string 3",
  "NMI": "sample string 4",
  "MIRN": "sample string 5",
  "TariffCode": "sample string 6"
}

application/xml, text/xml

Sample:
<ParamCheckComparison xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Comparisons.Parameter">
  <MIRN>sample string 5</MIRN>
  <NMI>sample string 4</NMI>
  <PostCode>sample string 2</PostCode>
  <PresaleID>1</PresaleID>
  <Suburb>sample string 3</Suburb>
  <TariffCode>sample string 6</TariffCode>
</ParamCheckComparison>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfBoolean
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

ErrorMessage

Collection of string

None.

Value

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": true
}

application/xml, text/xml

Sample:
<ResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Common.Returns">
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Value>true</Value>
</ResultOfboolean>