POST Leads/GetHealthJourney

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenVerifiedHealthJourneyGetRequest
NameDescriptionTypeAdditional information
SecurityKey

string

None.

LeadId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SecurityKey": "sample string 1",
  "LeadId": 2
}

application/xml, text/xml

Sample:
<SecurityTokenVerifiedHealthJourneyGetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <LeadId>2</LeadId>
  <SecurityKey>sample string 1</SecurityKey>
</SecurityTokenVerifiedHealthJourneyGetRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfHealthJourney
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

HealthJourney

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "Id": 1,
    "CreatedDateTime": "2025-05-13T22:01:20.9011167+02:00",
    "CreatedBy": "sample string 3",
    "LeadId": 4,
    "FirstName": "sample string 5",
    "Surname": "sample string 6",
    "IdNumber": "sample string 7",
    "PassportNumber": "sample string 8",
    "MobileNumber": "sample string 9",
    "EmailAddress": "sample string 10",
    "JsonJourneyData": "sample string 11",
    "JsonQAData": "sample string 12"
  }
}

application/xml, text/xml

Sample:
<ResponseOfHealthJourney_PYwLh37g xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.GeneratedModels">
    <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
    <d2p1:CreatedDateTime>2025-05-13T22:01:20.9011167+02:00</d2p1:CreatedDateTime>
    <d2p1:EmailAddress>sample string 10</d2p1:EmailAddress>
    <d2p1:FirstName>sample string 5</d2p1:FirstName>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IdNumber>sample string 7</d2p1:IdNumber>
    <d2p1:JsonJourneyData>sample string 11</d2p1:JsonJourneyData>
    <d2p1:JsonQAData>sample string 12</d2p1:JsonQAData>
    <d2p1:LeadId>4</d2p1:LeadId>
    <d2p1:MobileNumber>sample string 9</d2p1:MobileNumber>
    <d2p1:PassportNumber>sample string 8</d2p1:PassportNumber>
    <d2p1:Surname>sample string 6</d2p1:Surname>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfHealthJourney_PYwLh37g>