POST PatientPortal/CheckVerificationCode

Request Information

URI Parameters

None.

Body Parameters

PatientComms.DataAccess.Models.PatientPortal.CheckVerificationCodeRequest

Name	Type	Additional information
VerificationCode	string	None.
CorrelationId	globally unique identifier	None.
Name	string	None.
Phone	string	None.
Email	string	None.
PracticeApikey	globally unique identifier	None.
PlatformName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "VerificationCode": "sample string 1",
  "CorrelationId": "43475ce6-944f-4004-8b01-0b96918409a7",
  "Name": "sample string 3",
  "Phone": "sample string 4",
  "Email": "sample string 5",
  "PracticeApikey": "3c624a6d-d963-47b2-a5f5-471823768683",
  "PlatformName": "sample string 7"
}

application/xml, text/xml

Sample:

<CheckVerificationCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.DataAccess.Models.PatientPortal">
  <CorrelationId>43475ce6-944f-4004-8b01-0b96918409a7</CorrelationId>
  <Email>sample string 5</Email>
  <Name>sample string 3</Name>
  <Phone>sample string 4</Phone>
  <PlatformName>sample string 7</PlatformName>
  <PracticeApikey>3c624a6d-d963-47b2-a5f5-471823768683</PracticeApikey>
  <VerificationCode>sample string 1</VerificationCode>
</CheckVerificationCodeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>