POST Api/Comparison/Quote

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CompassPresaleId	integer	Required Range: inclusive between 1 and 2147483647
PlanId	integer	Required Range: inclusive between 1 and 2147483647
ElecRateId	integer	Range: inclusive between 1 and 2147483647
GasRateId	integer	Range: inclusive between 1 and 2147483647
CompassComparisonDateTimeOffset	date	Required
DeliveryChannel	string	Required String length: inclusive between 0 and 20
Email	string	Required String length: inclusive between 0 and 50
PhoneNumber	string	Required Matching regular expression pattern: ^[\+]?[0-9\s\-]{8,20}$ String length: inclusive between 0 and 20
FirstName	string	Required String length: inclusive between 1 and 50
LastName	string	String length: inclusive between 0 and 50
Nmi	string	String length: inclusive between 0 and 20
Mirn	string	String length: inclusive between 0 and 20
MoveInDate	date	Data type: Date
SupplyAddress	QuoteAddressDetail	Required

Request Formats

application/json, text/json

Sample:

{
  "CompassPresaleId": 1,
  "PlanId": 1,
  "ElecRateId": 1,
  "GasRateId": 1,
  "CompassComparisonDateTimeOffset": "2025-12-07T00:11:48.4752948+00:00",
  "DeliveryChannel": "sample string 1",
  "Email": "sample string 2",
  "PhoneNumber": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Nmi": "sample string 6",
  "Mirn": "sample string 7",
  "MoveInDate": "2025-12-07T00:11:48.4752948+00:00",
  "SupplyAddress": {
    "FullAddress": "sample string 1",
    "FlatUnitNumber": "sample string 2",
    "StreetNumber": "sample string 3",
    "StreetName": "sample string 4",
    "StreetTypeID": 1,
    "Suburb": "sample string 5",
    "StateCode": "sample string 6",
    "PostCode": "sample string 7",
    "LotNumber": "sample string 8",
    "FloorNumber": "sample string 9",
    "BuildingName": "sample string 10",
    "UnitType": "sample string 11"
  }
}

application/xml, text/xml

Sample:

<InsertQuoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.OnlineSignup">
  <CompassComparisonDateTimeOffset xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-07T00:11:48.4752948Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CompassComparisonDateTimeOffset>
  <CompassPresaleId>1</CompassPresaleId>
  <DeliveryChannel>sample string 1</DeliveryChannel>
  <ElecRateId>1</ElecRateId>
  <Email>sample string 2</Email>
  <FirstName>sample string 4</FirstName>
  <GasRateId>1</GasRateId>
  <LastName>sample string 5</LastName>
  <Mirn>sample string 7</Mirn>
  <MoveInDate>2025-12-07T00:11:48.4752948+00:00</MoveInDate>
  <Nmi>sample string 6</Nmi>
  <PhoneNumber>sample string 3</PhoneNumber>
  <PlanId>1</PlanId>
  <SupplyAddress>
    <BuildingName>sample string 10</BuildingName>
    <FlatUnitNumber>sample string 2</FlatUnitNumber>
    <FloorNumber>sample string 9</FloorNumber>
    <FullAddress>sample string 1</FullAddress>
    <LotNumber>sample string 8</LotNumber>
    <PostCode>sample string 7</PostCode>
    <StateCode>sample string 6</StateCode>
    <StreetName>sample string 4</StreetName>
    <StreetNumber>sample string 3</StreetNumber>
    <StreetTypeID>1</StreetTypeID>
    <Suburb>sample string 5</Suburb>
    <UnitType>sample string 11</UnitType>
  </SupplyAddress>
</InsertQuoteRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfInsertQuoteResponse

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
ErrorMessage	Collection of string	None.
Value	InsertQuoteResponse	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ResultOfInsertQuoteResponsegiTj_PTJ_P 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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.OnlineSignup">
    <d2p1:QuoteToken>sample string 1</d2p1:QuoteToken>
  </Value>
</ResultOfInsertQuoteResponsegiTj_PTJ_P>