BootView WebApi

<back to all web services

Login

The following routes are available for this service:
POST/loginLogs in a user by using the given credentials to get a valid auth token.
Login Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringYesThe email address of the user.
PasswordbodystringYesThe password of the user.
User Parameters:
NameParameterData TypeRequiredDescription
User_IdformGuidNo
User_AliasformstringNo
User_NameformstringNo
PasswordformstringNo
Group_IdformGuid?No
Is_Activeformbool?No
LanguageformstringNo
First_NameformstringNo
Last_NameformstringNo
Address_Line_1formstringNo
Address_Line_2formstringNo
CityformstringNo
State_CodeformstringNo
ZipformstringNo
Phone_NumberformstringNo
Is_Operatorformbool?No
Is_Internalformbool?No
Use_Mobile_Themeformbool?No
Show_Keyboardformbool?No
Email_AddressformstringNo
Mobile_PhoneformstringNo
Mobile_Carrier_Idformint?No
User_Status_Idformint?No
Display_Reports_In_New_WindowformboolNo
Time_ZoneformstringNo
Is_Canary_TesterformboolNo
Api_Token_IdformGuid?No
Home_Page_Idformint?No
Is_EnforcementOfficerformboolNo
Can_Use_MIMSformboolNo
Mobile_Apps_AllowedformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /x-msgpack/reply/Login HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/x-msgpack
Content-Length: length

{"email":"String","password":"String"}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"user_Id":"00000000000000000000000000000000","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}