POST Leads/CreateHealthJourney

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenVerifiedHealthJourneyCreateRequest

Name	Type	Additional information
SecurityKey	string	None.
LeadId	integer	None.
FirstName	string	None.
Surname	string	None.
IdNumber	string	None.
PassportNumber	string	None.
MobileNumber	string	None.
EmailAddress	string	None.
JsonJourneyData	string	None.
JsonQAData	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SecurityKey": "sample string 1",
  "LeadId": 2,
  "FirstName": "sample string 3",
  "Surname": "sample string 4",
  "IdNumber": "sample string 5",
  "PassportNumber": "sample string 6",
  "MobileNumber": "sample string 7",
  "EmailAddress": "sample string 8",
  "JsonJourneyData": "sample string 9",
  "JsonQAData": "sample string 10"
}

application/xml, text/xml

Sample:

<SecurityTokenVerifiedHealthJourneyCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <EmailAddress>sample string 8</EmailAddress>
  <FirstName>sample string 3</FirstName>
  <IdNumber>sample string 5</IdNumber>
  <JsonJourneyData>sample string 9</JsonJourneyData>
  <JsonQAData>sample string 10</JsonQAData>
  <LeadId>2</LeadId>
  <MobileNumber>sample string 7</MobileNumber>
  <PassportNumber>sample string 6</PassportNumber>
  <SecurityKey>sample string 1</SecurityKey>
  <Surname>sample string 4</Surname>
</SecurityTokenVerifiedHealthJourneyCreateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfInt32

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Entity	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Entity": 3
}

application/xml, text/xml

Sample:

<ResponseOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity>3</Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfint>