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 to the PerfectApps system. •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 to the PerfectApps system. •string securityKey - Enter the API Security Key that was sent during the API User Access process. See Setting Up API User Access |
0 if successful. Any non-zero value indicates an error. |
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: app.perfectforms.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.PerfectApps.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.PerfectApps.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.PerfectApps.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: app.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.PerfectApps.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.PerfectApps.com/API"> <LoginResult>int</LoginResult> <token>string</token> <firstName>string</firstName> <lastName>string</lastName> <maxAttachmentSize>long</maxAttachmentSize> </LoginResponse> </soap12:Body> </soap12:Envelope> |
Return to: Account API Methods (SOAP), Integration
