POST | /login | Logs in a user by using the given credentials to get a valid auth token. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
body | string | Yes | The email address of the user. | |
Password | body | string | Yes | The password of the user. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
User_Id | form | Guid | No | |
User_Alias | form | string | No | |
User_Name | form | string | No | |
Password | form | string | No | |
Group_Id | form | Guid? | No | |
Is_Active | form | bool? | No | |
Language | form | string | No | |
First_Name | form | string | No | |
Last_Name | form | string | No | |
Address_Line_1 | form | string | No | |
Address_Line_2 | form | string | No | |
City | form | string | No | |
State_Code | form | string | No | |
Zip | form | string | No | |
Phone_Number | form | string | No | |
Is_Operator | form | bool? | No | |
Is_Internal | form | bool? | No | |
Use_Mobile_Theme | form | bool? | No | |
Show_Keyboard | form | bool? | No | |
Email_Address | form | string | No | |
Mobile_Phone | form | string | No | |
Mobile_Carrier_Id | form | int? | No | |
User_Status_Id | form | int? | No | |
Display_Reports_In_New_Window | form | bool | No | |
Time_Zone | form | string | No | |
Is_Canary_Tester | form | bool | No | |
Api_Token_Id | form | Guid? | No | |
Home_Page_Id | form | int? | No | |
Is_EnforcementOfficer | form | bool | No | |
Can_Use_MIMS | form | bool | No | |
Mobile_Apps_Allowed | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /login HTTP/1.1
Host: api.paylock.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
email: String,
password: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { user_Alias: String, user_Name: String, password: String, group_Id: 00000000000000000000000000000000, is_Active: False, language: String, first_Name: String, last_Name: String, address_Line_1: String, address_Line_2: String, city: String, state_Code: String, zip: String, phone_Number: String, is_Operator: False, is_Internal: False, use_Mobile_Theme: False, show_Keyboard: False, email_Address: String, mobile_Phone: String, mobile_Carrier_Id: 0, user_Status_Id: 0, display_Reports_In_New_Window: False, time_Zone: String, is_Canary_Tester: False, api_Token_Id: 00000000000000000000000000000000, home_Page_Id: 0, is_EnforcementOfficer: False, can_Use_MIMS: False, mobile_Apps_Allowed: False }