POST v1/utilityClass/sendOTP

Request Information

URI Parameters

None.

Body Parameters

sendOTPRequest
NameDescriptionTypeAdditional information
otp_lenght

integer

None.

emailAddress

string

None.

phoneNo

string

None.

sms_Message

string

None.

email_body

string

None.

companyCode

string

None.

identifer

string

None.

Request Formats

application/json, text/json

Sample:
{
  "otp_lenght": 1,
  "emailAddress": "sample string 2",
  "phoneNo": "sample string 3",
  "sms_Message": "sample string 4",
  "email_body": "sample string 5",
  "companyCode": "sample string 6",
  "identifer": "sample string 7"
}

application/xml, text/xml

Sample:
<sendOTPRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.utilityClass">
  <companyCode>sample string 6</companyCode>
  <emailAddress>sample string 2</emailAddress>
  <email_body>sample string 5</email_body>
  <identifer>sample string 7</identifer>
  <otp_lenght>1</otp_lenght>
  <phoneNo>sample string 3</phoneNo>
  <sms_Message>sample string 4</sms_Message>
</sendOTPRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:
{"otp_lenght":1,"emailAddress":"sample string 2","phoneNo":"sample string 3","sms_Message":"sample string 4","email_body":"sample string 5","companyCode":"sample string 6","identifer":"sample string 7"}

Response Information

Resource Description

sendOTPResult
NameDescriptionTypeAdditional information
success

boolean

None.

message

string

None.

errorMsg

string

None.

identifer

string

None.

otp

string

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3",
  "identifer": "sample string 4",
  "otp": "sample string 5"
}

application/xml, text/xml

Sample:
<sendOTPResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.utilityClass">
  <errorMsg>sample string 3</errorMsg>
  <identifer>sample string 4</identifer>
  <message>sample string 2</message>
  <otp>sample string 5</otp>
  <success>true</success>
</sendOTPResult>

text/html

Sample:
{"success":true,"message":"sample string 2","errorMsg":"sample string 3","identifer":"sample string 4","otp":"sample string 5"}