POST api/clinicians/setPin

Request Information

URI Parameters

None.

Body Parameters

ClinicianSetPinRequest
NameDescriptionTypeAdditional information
PIN

string

Required

Max length: 4

Request Formats

application/json, text/json

Sample:
{
  "PIN": "sample string 1"
}

application/xml, text/xml

Sample:
<ClinicianSetPinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <PIN>sample string 1</PIN>
</ClinicianSetPinRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClinicianPinResponse
NameDescriptionTypeAdditional 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:
<ClinicianPinResponse 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>
</ClinicianPinResponse>