POST api/Account/SendOTP?UserOTPOption={UserOTPOption}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserOTPOption | integer |
Default value is 0 |
Body Parameters
MembershipUserViewModelName | Description | Type | Additional information |
---|---|---|---|
membershipUserID | integer |
None. |
|
firstName | string |
None. |
|
lastName | string |
None. |
|
emailID | string |
None. |
|
address | string |
None. |
|
city | string |
None. |
|
zipCode | string |
None. |
|
state | string |
None. |
|
countryID | byte |
None. |
|
countryCode | byte |
None. |
|
mobileNo | string |
None. |
|
faxNo | string |
None. |
|
companyName | string |
None. |
|
updateCompanyImage | boolean |
None. |
|
companyLogoImageName | string |
None. |
|
companyLogoImagePath | string |
None. |
|
personCRMID | string |
None. |
|
password | string |
None. |
|
passwordSalt | string |
None. |
|
membershipRoleID | byte |
None. |
|
languageID | byte |
None. |
|
numberFormat | boolean |
None. |
|
isActive | boolean |
None. |
|
isDeleted | boolean |
None. |
|
isLocked | boolean |
None. |
|
passwordFailedAttempt | byte |
None. |
|
lastLockedDate | date |
None. |
|
lastPasswordChangeDate | date |
None. |
|
tokenID | string |
None. |
|
tokenCreatedDate | date |
None. |
|
tokenStatus | boolean |
None. |
|
createdBy | integer |
None. |
|
createdDate | date |
None. |
|
modifiedBy | integer |
None. |
|
modifiedDate | date |
None. |
|
firstLoginChangePassword | boolean |
None. |
|
firstLoginChangePasswordDate | date |
None. |
|
secureAuthentication | boolean |
None. |
|
subcontractor | string |
None. |
|
termsAcceptDate | date |
None. |
|
registerUserID | integer |
None. |
|
userTokenID | string |
None. |
|
userTokenCreatedDate | date |
None. |
|
userTokenStatus | boolean |
None. |
|
OTPOption | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "membershipUserID": 1, "firstName": "sample string 2", "lastName": "sample string 3", "emailID": "sample string 4", "address": "sample string 5", "city": "sample string 6", "zipCode": "sample string 7", "state": "sample string 8", "countryID": 64, "countryCode": 64, "mobileNo": "sample string 10", "faxNo": "sample string 11", "companyName": "sample string 12", "updateCompanyImage": true, "companyLogoImageName": "sample string 14", "companyLogoImagePath": "sample string 15", "personCRMID": "sample string 16", "password": "sample string 17", "passwordSalt": "sample string 18", "membershipRoleID": 64, "languageID": 64, "numberFormat": true, "isActive": true, "isDeleted": true, "isLocked": true, "passwordFailedAttempt": 64, "lastLockedDate": "2025-04-29T20:36:43.4735273+05:30", "lastPasswordChangeDate": "2025-04-29T20:36:43.4735273+05:30", "tokenID": "sample string 26", "tokenCreatedDate": "2025-04-29T20:36:43.4735273+05:30", "tokenStatus": true, "createdBy": 27, "createdDate": "2025-04-29T20:36:43.4735273+05:30", "modifiedBy": 1, "modifiedDate": "2025-04-29T20:36:43.4735273+05:30", "firstLoginChangePassword": true, "firstLoginChangePasswordDate": "2025-04-29T20:36:43.4735273+05:30", "secureAuthentication": true, "subcontractor": "sample string 31", "termsAcceptDate": "2025-04-29T20:36:43.4735273+05:30", "registerUserID": 32, "userTokenID": "sample string 33", "userTokenCreatedDate": "2025-04-29T20:36:43.4735273+05:30", "userTokenStatus": true, "OTPOption": 1 }
application/xml, text/xml
Sample:
<MembershipUserViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Petra_Mobile_API.ViewModels"> <OTPOption>1</OTPOption> <address>sample string 5</address> <city>sample string 6</city> <companyLogoImageName>sample string 14</companyLogoImageName> <companyLogoImagePath>sample string 15</companyLogoImagePath> <companyName>sample string 12</companyName> <countryCode>64</countryCode> <countryID>64</countryID> <createdBy>27</createdBy> <createdDate>2025-04-29T20:36:43.4735273+05:30</createdDate> <emailID>sample string 4</emailID> <faxNo>sample string 11</faxNo> <firstLoginChangePassword>true</firstLoginChangePassword> <firstLoginChangePasswordDate>2025-04-29T20:36:43.4735273+05:30</firstLoginChangePasswordDate> <firstName>sample string 2</firstName> <isActive>true</isActive> <isDeleted>true</isDeleted> <isLocked>true</isLocked> <languageID>64</languageID> <lastLockedDate>2025-04-29T20:36:43.4735273+05:30</lastLockedDate> <lastName>sample string 3</lastName> <lastPasswordChangeDate>2025-04-29T20:36:43.4735273+05:30</lastPasswordChangeDate> <membershipRoleID>64</membershipRoleID> <membershipUserID>1</membershipUserID> <mobileNo>sample string 10</mobileNo> <modifiedBy>1</modifiedBy> <modifiedDate>2025-04-29T20:36:43.4735273+05:30</modifiedDate> <numberFormat>true</numberFormat> <password>sample string 17</password> <passwordFailedAttempt>64</passwordFailedAttempt> <passwordSalt>sample string 18</passwordSalt> <personCRMID>sample string 16</personCRMID> <registerUserID>32</registerUserID> <secureAuthentication>true</secureAuthentication> <state>sample string 8</state> <subcontractor>sample string 31</subcontractor> <termsAcceptDate>2025-04-29T20:36:43.4735273+05:30</termsAcceptDate> <tokenCreatedDate>2025-04-29T20:36:43.4735273+05:30</tokenCreatedDate> <tokenID>sample string 26</tokenID> <tokenStatus>true</tokenStatus> <updateCompanyImage>true</updateCompanyImage> <userTokenCreatedDate>2025-04-29T20:36:43.4735273+05:30</userTokenCreatedDate> <userTokenID>sample string 33</userTokenID> <userTokenStatus>true</userTokenStatus> <zipCode>sample string 7</zipCode> </MembershipUserViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SendOTPReturnModelName | Description | Type | Additional information |
---|---|---|---|
OTPRequestId | string |
None. |
|
message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "OTPRequestId": "sample string 1", "message": "sample string 2" }
application/xml, text/xml
Sample:
<SendOTPReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Petra_Mobile_API.ViewModels"> <OTPRequestId>sample string 1</OTPRequestId> <message>sample string 2</message> </SendOTPReturnModel>