POST PatientPortal/CheckVerificationCode

Request Information

URI Parameters

None.

Body Parameters

PatientComms.DataAccess.Models.PatientPortal.CheckVerificationCodeRequest
NameDescriptionTypeAdditional 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": "73e878ff-5fa8-4dd2-bd90-a723ab01611f",
  "Name": "sample string 3",
  "Phone": "sample string 4",
  "Email": "sample string 5",
  "PracticeApikey": "d841b556-ce11-4544-b156-e86913e6321d",
  "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>73e878ff-5fa8-4dd2-bd90-a723ab01611f</CorrelationId>
  <Email>sample string 5</Email>
  <Name>sample string 3</Name>
  <Phone>sample string 4</Phone>
  <PlatformName>sample string 7</PlatformName>
  <PracticeApikey>d841b556-ce11-4544-b156-e86913e6321d</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>