POST MyPortal/GetUserPin

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Models.UserPinRequest

Name	Type	Additional information
AppKey	globally unique identifier	None.
PracticeId	integer	None.
PinToValidate	integer	None.
ErrorMessage	string	None.
ErrorStackTrace	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AppKey": "3f05debe-8538-4f1e-a69c-c58696521b86",
  "PracticeId": 2,
  "PinToValidate": 3,
  "ErrorMessage": "sample string 4",
  "ErrorStackTrace": "sample string 5"
}

application/xml, text/xml

Sample:

<UserPinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <AppKey>3f05debe-8538-4f1e-a69c-c58696521b86</AppKey>
  <ErrorMessage>sample string 4</ErrorMessage>
  <ErrorStackTrace>sample string 5</ErrorStackTrace>
  <PinToValidate>3</PinToValidate>
  <PracticeId>2</PracticeId>
</UserPinRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Models.UserPinResponse

Name	Type	Additional information
IsValid	boolean	None.
Username	string	None.
UserFullName	string	None.
ErrorMessage	string	None.
ErrorStackTrace	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsValid": true,
  "Username": "sample string 2",
  "UserFullName": "sample string 3",
  "ErrorMessage": "sample string 4",
  "ErrorStackTrace": "sample string 5"
}

application/xml, text/xml

Sample:

<UserPinResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <ErrorMessage>sample string 4</ErrorMessage>
  <ErrorStackTrace>sample string 5</ErrorStackTrace>
  <IsValid>true</IsValid>
  <UserFullName>sample string 3</UserFullName>
  <Username>sample string 2</Username>
</UserPinResponse>