BootView WebApi

Login

Logs in a user by using the given credentials to get a valid auth token.

**Login** Parameters:
Name	Parameter	Data Type	Required	Description
Email	body	string	Yes	The email address of the user.
Password	body	string	Yes	The password of the user.

**User** Parameters:
Name	Parameter	Data Type	Required
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 .soap11 suffix or ?format=soap11

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: Login

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<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>

    </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<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>

    </soap:Body>
</soap:Envelope>