POST api/v1/Users/SendEmployeeOneDayPass
Creates a temporary credentials for an employee and sends out email containing QR code with encoded credentials
Request Information
URI Parameters
None.
Body Parameters
SendEmployeeOneDayPassViewModelName | Description | Type | Additional information |
---|---|---|---|
EmailAddress |
Employee's email address. When specified, the credentials will be send via email |
string |
None. |
PhoneNumber |
Employee's mobile phone number. When specified, the credentials will be send via text (MMS) message |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "EmailAddress": "sample string 1", "PhoneNumber": "sample string 2" }
application/xml, text/xml
Sample:
<SendEmployeeOneDayPassViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <EmailAddress>sample string 1</EmailAddress> <PhoneNumber>sample string 2</PhoneNumber> </SendEmployeeOneDayPassViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultName | Description | Type | Additional information |
---|---|---|---|
ResultCode |
Represents the result code |
integer |
None. |
Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ResultCode": 1, "Description": "sample string 2" }
application/xml, text/xml
Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 2</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>1</ResultCode> </Result>