Login

 Previous  Home topic  Next  Print this topic Send Feedback

The Login method logs the API into the system using a security token.

 

public int Login(string emailAddress, string password, string securityKey, out string token, out string firstName, 

out string lastName, out long maxAttachmentSize)

 

 

Send Params

Return Params
•email id - Email id is the same login ID you use to login at http://app.perfectforms.com.
•out long maxAttachmentSize - Maximum allowable attachment file size for this login/user.
•out string firstName - Logged in user's first name.
•out string lastName - Logged in user's last name.
•out string token - This is the return value from server which needs to be used as security key on the following request. (Remember each security key is valid for one request only and each response will have a security key which will be used on the following request).
•string password - Password is the same password you use to log in at http://app.perfectforms.com.
•string security Key - This key will be empty for login.

0 if successful. Any non-zero value indicates an error.

 

 

Test

The test form is only available for requests from the local machine.

 

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

 

POST /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.PerfectForms.com/API/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="http://www.PerfectForms.com/API">

      <emailAddress>string</emailAddress>

      <password>string</password>

      <securityKey>string</securityKey>

    </Login>

  </soap:Body>

</soap:Envelope>

 

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

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>

    <LoginResponse xmlns="http://www.PerfectForms.com/API">

      <LoginResult>int</LoginResult>

      <token>string</token>

      <firstName>string</firstName>

      <lastName>string</lastName>

      <maxAttachmentSize>long</maxAttachmentSize>

    </LoginResponse>

  </soap:Body>

</soap:Envelope>

 

 

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

 

POST /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <Login xmlns="http://www.PerfectForms.com/API">

      <emailAddress>string</emailAddress>

      <password>string</password>

      <securityKey>string</securityKey>

    </Login>

  </soap12:Body>

</soap12:Envelope>

 

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <LoginResponse xmlns="http://www.PerfectForms.com/API">

      <LoginResult>int</LoginResult>

      <token>string</token>

      <firstName>string</firstName>

      <lastName>string</lastName>

      <maxAttachmentSize>long</maxAttachmentSize>

    </LoginResponse>

  </soap12:Body>

</soap12:Envelope>

 

Updated: 06/12/2011  Page url: http://www.perfectforms.com/Documentation/manual/html/?fg_login_(account).htm
PerfectForms™ -- forms software, workflow software, and business process management