POST v{version}/Authenticate/GetToken
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
UserAuthenticationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| APIUserUserName | string |
Required Matching regular expression pattern: ^(?(")(".+?(?<!\\)"@)|(([0-9a-zA-Z]((\.(?!\.))|[-!#\$%&'\*\+/=\?\^`\{\}\|~\w])*)(?<=[0-9a-zA-Z]|[-!#$%&'*+/=?^`{}|~\w])@))(?(\[)(\[(\d{1,3}\.){3}\d{1,3}\])|(([0-9a-zA-Z][-0-9a-zA-Z]*[0-9a-zA-Z]*\.)+[a-zA-Z0-9][\-a-zA-Z0-9]{0,22}[a-zA-Z0-9]))$ |
|
| APIUserPassword | string |
Required |
|
| APIKey | string |
Required Matching regular expression pattern: ^(\{{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}\}{0,1})$ |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| EmailID | string |
Matching regular expression pattern: ^(?(")(".+?(?<!\\)"@)|(([0-9a-zA-Z]((\.(?!\.))|[-!#\$%&'\*\+/=\?\^`\{\}\|~\w])*)(?<=[0-9a-zA-Z]|[-!#$%&'*+/=?^`{}|~\w])@))(?(\[)(\[(\d{1,3}\.){3}\d{1,3}\])|(([0-9a-zA-Z][-0-9a-zA-Z]*[0-9a-zA-Z]*\.)+[a-zA-Z0-9][\-a-zA-Z0-9]{0,22}[a-zA-Z0-9]))$ |
|
| Office | string |
None. |
Request Formats
application/json, text/json
{
"APIUserUserName": "sample string 1",
"APIUserPassword": "sample string 2",
"APIKey": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"EmailID": "sample string 6",
"Office": "sample string 7"
}
application/xml, text/xml
<UserAuthenticationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LoanBeam.API.V1.Models"> <APIKey xmlns="http://schemas.datacontract.org/2004/07/LoanBeam.Data.Model.V1">sample string 3</APIKey> <APIUserPassword xmlns="http://schemas.datacontract.org/2004/07/LoanBeam.Data.Model.V1">sample string 2</APIUserPassword> <APIUserUserName xmlns="http://schemas.datacontract.org/2004/07/LoanBeam.Data.Model.V1">sample string 1</APIUserUserName> <EmailID xmlns="http://schemas.datacontract.org/2004/07/LoanBeam.Data.Model.V1">sample string 6</EmailID> <FirstName xmlns="http://schemas.datacontract.org/2004/07/LoanBeam.Data.Model.V1">sample string 4</FirstName> <LastName xmlns="http://schemas.datacontract.org/2004/07/LoanBeam.Data.Model.V1">sample string 5</LastName> <Office xmlns="http://schemas.datacontract.org/2004/07/LoanBeam.Data.Model.V1">sample string 7</Office> </UserAuthenticationModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |