POST Api/v1/HealthLead

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HealthLeadID	integer	None.
FirstName	string	Required String length: inclusive between 0 and 250
LastName	string	Required String length: inclusive between 0 and 250
ContactNumber	string	Required String length: inclusive between 0 and 20
Email	string	Required String length: inclusive between 0 and 250
CurrentCoverStatus	boolean	None.
CurrentHealthInsurer	integer	None.
CoverType	integer	None.
ConsentObtained	boolean	None.
LeadTransferType	string	String length: inclusive between 0 and 200
CallBackDateTime	string	None.
EnergySaleCRN	string	String length: inclusive between 0 and 50
EnergyLeadID	integer	None.
Postcode	string	Required String length: inclusive between 0 and 20
Suburb	string	Required String length: inclusive between 0 and 300
LifeStageType	integer	None.
HealthLeadCallRequestID	integer	None.
Notes	string	String length: inclusive between 0 and 500

Request Formats

application/json, text/json

Sample:

{
  "HealthLeadID": 1,
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "ContactNumber": "sample string 3",
  "Email": "sample string 4",
  "CurrentCoverStatus": true,
  "CurrentHealthInsurer": 1,
  "CoverType": 1,
  "ConsentObtained": true,
  "LeadTransferType": "sample string 5",
  "CallBackDateTime": "sample string 6",
  "EnergySaleCRN": "sample string 7",
  "EnergyLeadID": 1,
  "Postcode": "sample string 8",
  "Suburb": "sample string 9",
  "LifeStageType": 1,
  "HealthLeadCallRequestID": 1,
  "Notes": "sample string 10"
}

application/xml, text/xml

Sample:

<ParamHealthLead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.HealthLead">
  <CallBackDateTime>sample string 6</CallBackDateTime>
  <ConsentObtained>true</ConsentObtained>
  <ContactNumber>sample string 3</ContactNumber>
  <CoverType>1</CoverType>
  <CurrentCoverStatus>true</CurrentCoverStatus>
  <CurrentHealthInsurer>1</CurrentHealthInsurer>
  <Email>sample string 4</Email>
  <EnergyLeadID>1</EnergyLeadID>
  <EnergySaleCRN>sample string 7</EnergySaleCRN>
  <FirstName>sample string 1</FirstName>
  <HealthLeadCallRequestID>1</HealthLeadCallRequestID>
  <HealthLeadID>1</HealthLeadID>
  <LastName>sample string 2</LastName>
  <LeadTransferType>sample string 5</LeadTransferType>
  <LifeStageType>1</LifeStageType>
  <Notes>sample string 10</Notes>
  <Postcode>sample string 8</Postcode>
  <Suburb>sample string 9</Suburb>
</ParamHealthLead>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfHealthLead

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "HealthLeadID": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ContactNumber": "sample string 4",
    "Email": "sample string 5",
    "CurrentCoverStatus": true,
    "CurrentHealthInsurer": 1,
    "CoverType": 1,
    "ConsentObtained": true,
    "LeadTransferType": "sample string 6",
    "CallBackDateTime": "sample string 7",
    "EnergySaleCRN": "sample string 8",
    "EnergyLeadID": 1,
    "Postcode": "sample string 9",
    "Suburb": "sample string 10",
    "LifeStageType": 1,
    "Notes": "sample string 11"
  }
}

application/xml, text/xml

Sample:

<ResultOfHealthLeadVOoIJTQu 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.HealthLead">
    <d2p1:CallBackDateTime>sample string 7</d2p1:CallBackDateTime>
    <d2p1:ConsentObtained>true</d2p1:ConsentObtained>
    <d2p1:ContactNumber>sample string 4</d2p1:ContactNumber>
    <d2p1:CoverType>1</d2p1:CoverType>
    <d2p1:CurrentCoverStatus>true</d2p1:CurrentCoverStatus>
    <d2p1:CurrentHealthInsurer>1</d2p1:CurrentHealthInsurer>
    <d2p1:Email>sample string 5</d2p1:Email>
    <d2p1:EnergyLeadID>1</d2p1:EnergyLeadID>
    <d2p1:EnergySaleCRN>sample string 8</d2p1:EnergySaleCRN>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:HealthLeadID>1</d2p1:HealthLeadID>
    <d2p1:LastName>sample string 3</d2p1:LastName>
    <d2p1:LeadTransferType>sample string 6</d2p1:LeadTransferType>
    <d2p1:LifeStageType>1</d2p1:LifeStageType>
    <d2p1:Notes>sample string 11</d2p1:Notes>
    <d2p1:Postcode>sample string 9</d2p1:Postcode>
    <d2p1:Suburb>sample string 10</d2p1:Suburb>
  </Value>
</ResultOfHealthLeadVOoIJTQu>