POST api/v2/VisitorRequestInstances/Photo
Uploads a photo file to the instance that will be used to print the badge later.
Request Information
URI Parameters
None.
Body Parameters
VisitorPhotoViewModelName | Description | Type | Additional information |
---|---|---|---|
VisitorRequestInstanceId | globally unique identifier |
None. |
|
ImageData | Collection of byte |
None. |
|
FileName | string |
None. |
|
ThumbFileName | string |
None. |
|
SetAsDefault | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "VisitorRequestInstanceId": "dd96f6e3-8fd3-45cb-a315-819299be1f72", "ImageData": "QEA=", "FileName": "sample string 2", "ThumbFileName": "sample string 3", "SetAsDefault": true }
application/xml, text/xml
Sample:
<VisitorPhotoViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <FileName>sample string 2</FileName> <ImageData>QEA=</ImageData> <SetAsDefault>true</SetAsDefault> <ThumbFileName>sample string 3</ThumbFileName> <VisitorRequestInstanceId>dd96f6e3-8fd3-45cb-a315-819299be1f72</VisitorRequestInstanceId> </VisitorPhotoViewModel>
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>