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 .xml suffix or ?format=xml

HTTP + XML

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

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

<Login xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Email>String</Email>
  <Password>String</Password>
</Login>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PayLock.BootView.Pocos">
  <_x003C_Address_Line_1_x003E_k__BackingField>String</_x003C_Address_Line_1_x003E_k__BackingField>
  <_x003C_Address_Line_2_x003E_k__BackingField>String</_x003C_Address_Line_2_x003E_k__BackingField>
  <_x003C_Api_Token_Id_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_Api_Token_Id_x003E_k__BackingField>
  <_x003C_Can_Use_MIMS_x003E_k__BackingField>false</_x003C_Can_Use_MIMS_x003E_k__BackingField>
  <_x003C_City_x003E_k__BackingField>String</_x003C_City_x003E_k__BackingField>
  <_x003C_Display_Reports_In_New_Window_x003E_k__BackingField>false</_x003C_Display_Reports_In_New_Window_x003E_k__BackingField>
  <_x003C_Email_Address_x003E_k__BackingField>String</_x003C_Email_Address_x003E_k__BackingField>
  <_x003C_First_Name_x003E_k__BackingField>String</_x003C_First_Name_x003E_k__BackingField>
  <_x003C_Group_Id_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_Group_Id_x003E_k__BackingField>
  <_x003C_Home_Page_Id_x003E_k__BackingField>0</_x003C_Home_Page_Id_x003E_k__BackingField>
  <_x003C_Is_Active_x003E_k__BackingField>false</_x003C_Is_Active_x003E_k__BackingField>
  <_x003C_Is_Canary_Tester_x003E_k__BackingField>false</_x003C_Is_Canary_Tester_x003E_k__BackingField>
  <_x003C_Is_EnforcementOfficer_x003E_k__BackingField>false</_x003C_Is_EnforcementOfficer_x003E_k__BackingField>
  <_x003C_Is_Internal_x003E_k__BackingField>false</_x003C_Is_Internal_x003E_k__BackingField>
  <_x003C_Is_Operator_x003E_k__BackingField>false</_x003C_Is_Operator_x003E_k__BackingField>
  <_x003C_Language_x003E_k__BackingField>String</_x003C_Language_x003E_k__BackingField>
  <_x003C_Last_Name_x003E_k__BackingField>String</_x003C_Last_Name_x003E_k__BackingField>
  <_x003C_Mobile_Apps_Allowed_x003E_k__BackingField>false</_x003C_Mobile_Apps_Allowed_x003E_k__BackingField>
  <_x003C_Mobile_Carrier_Id_x003E_k__BackingField>0</_x003C_Mobile_Carrier_Id_x003E_k__BackingField>
  <_x003C_Mobile_Phone_x003E_k__BackingField>String</_x003C_Mobile_Phone_x003E_k__BackingField>
  <_x003C_Password_x003E_k__BackingField>String</_x003C_Password_x003E_k__BackingField>
  <_x003C_Phone_Number_x003E_k__BackingField>String</_x003C_Phone_Number_x003E_k__BackingField>
  <_x003C_Show_Keyboard_x003E_k__BackingField>false</_x003C_Show_Keyboard_x003E_k__BackingField>
  <_x003C_State_Code_x003E_k__BackingField>String</_x003C_State_Code_x003E_k__BackingField>
  <_x003C_Time_Zone_x003E_k__BackingField>String</_x003C_Time_Zone_x003E_k__BackingField>
  <_x003C_Use_Mobile_Theme_x003E_k__BackingField>false</_x003C_Use_Mobile_Theme_x003E_k__BackingField>
  <_x003C_User_Alias_x003E_k__BackingField>String</_x003C_User_Alias_x003E_k__BackingField>
  <_x003C_User_Id_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_User_Id_x003E_k__BackingField>
  <_x003C_User_Name_x003E_k__BackingField>String</_x003C_User_Name_x003E_k__BackingField>
  <_x003C_User_Status_Id_x003E_k__BackingField>0</_x003C_User_Status_Id_x003E_k__BackingField>
  <_x003C_Zip_x003E_k__BackingField>String</_x003C_Zip_x003E_k__BackingField>
</User>