POST api/CellPhone/Encrypt

Request Information

URI Parameters

None.

Body Parameters

CellPhoneEncRequest
NameDescriptionTypeAdditional information
SiteCode

string

None.

SitePassword

string

None.

RequestID

string

None.

AuthType

string

None.

ShowCancelButton

boolean

None.

Gender

string

None.

ReturnURLOnSuccess

string

None.

ReturnURLOnError

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteCode": "sample string 1",
  "SitePassword": "sample string 2",
  "RequestID": "sample string 3",
  "AuthType": "sample string 4",
  "ShowCancelButton": true,
  "Gender": "sample string 6",
  "ReturnURLOnSuccess": "sample string 7",
  "ReturnURLOnError": "sample string 8"
}

application/xml, text/xml

Sample:
<CellPhoneEncRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NICEAPI.Models">
  <AuthType>sample string 4</AuthType>
  <Gender>sample string 6</Gender>
  <RequestID>sample string 3</RequestID>
  <ReturnURLOnError>sample string 8</ReturnURLOnError>
  <ReturnURLOnSuccess>sample string 7</ReturnURLOnSuccess>
  <ShowCancelButton>true</ShowCancelButton>
  <SiteCode>sample string 1</SiteCode>
  <SitePassword>sample string 2</SitePassword>
</CellPhoneEncRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CellPhoneEncResponse
NameDescriptionTypeAdditional information
RequestID

string

None.

ReturnCode

integer

None.

ErrorMessage

string

None.

Data

string

None.

Response Formats

application/json, text/json

Sample:
{
  "RequestID": "sample string 1",
  "ReturnCode": 2,
  "ErrorMessage": "",
  "Data": "sample string 3"
}

application/xml, text/xml

Sample:
<CellPhoneEncResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NICEAPI.Models">
  <Data>sample string 3</Data>
  <RequestID>sample string 1</RequestID>
  <ReturnCode>2</ReturnCode>
</CellPhoneEncResponse>