POST api/iPin/Encrypt

Request Information

URI Parameters

None.

Body Parameters

iPinEncRequest
NameDescriptionTypeAdditional information
SiteCode

string

None.

SitePassword

string

None.

ReturnURL

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteCode": "sample string 1",
  "SitePassword": "sample string 2",
  "ReturnURL": "sample string 3"
}

application/xml, text/xml

Sample:
<iPinEncRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NICEAPI.Models">
  <ReturnURL>sample string 3</ReturnURL>
  <SiteCode>sample string 1</SiteCode>
  <SitePassword>sample string 2</SitePassword>
</iPinEncRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

iPinEncResponse
NameDescriptionTypeAdditional information
SessionID

string

None.

ReturnCode

integer

None.

Data

string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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