POST api/clinicians/tfaActivate
Request Information
URI Parameters
None.
Body Parameters
ClinicianTfaActivationRequestName | Description | Type | Additional information |
---|---|---|---|
CredentialID | string |
None. |
|
ReferenceNumber | string |
None. |
|
OneTimePassword | string |
Required Max length: 6 |
|
PIN | string |
Required Max length: 4 |
Request Formats
application/json, text/json
Sample:
{ "CredentialID": "sample string 1", "ReferenceNumber": "sample string 2", "OneTimePassword": "sample string 3", "PIN": "sample string 4" }
application/xml, text/xml
Sample:
<ClinicianTfaActivationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13"> <CredentialID>sample string 1</CredentialID> <OneTimePassword>sample string 3</OneTimePassword> <PIN>sample string 4</PIN> <ReferenceNumber>sample string 2</ReferenceNumber> </ClinicianTfaActivationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ClinicianTfaActivationResponseName | Description | Type | Additional information |
---|---|---|---|
Result | Result |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": { "ResultCode": "sample string 1", "ResultDescription": "sample string 2" } }
application/xml, text/xml
Sample:
<ClinicianTfaActivationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13"> <Result> <ResultCode>sample string 1</ResultCode> <ResultDescription>sample string 2</ResultDescription> </Result> </ClinicianTfaActivationResponse>