Symphony API V1.0
Click here for a complete list of operations.
CheckLogOn
This method can be used to check if a contact login is correct
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/CheckLogOn"
<?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:Header>
<AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<Timestamp>string</Timestamp>
<Operation>string</Operation>
<Signature>string</Signature>
<APIKey>string</APIKey>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<CheckLogOn xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<emailAddress>string</emailAddress>
<password>string</password>
</CheckLogOn>
</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>
<CheckLogOnResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<CheckLogOnResult>
<ContactID>int</ContactID>
<ContactName>string</ContactName>
<ContactRegStatus>int</ContactRegStatus>
</CheckLogOnResult>
</CheckLogOnResponse>
</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/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.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:Header>
<AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<Timestamp>string</Timestamp>
<Operation>string</Operation>
<Signature>string</Signature>
<APIKey>string</APIKey>
</AuthenticationHeader>
</soap12:Header>
<soap12:Body>
<CheckLogOn xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<emailAddress>string</emailAddress>
<password>string</password>
</CheckLogOn>
</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>
<CheckLogOnResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
<CheckLogOnResult>
<ContactID>int</ContactID>
<ContactName>string</ContactName>
<ContactRegStatus>int</ContactRegStatus>
</CheckLogOnResult>
</CheckLogOnResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /API/1_0/SOAP/SymphonyAPI.asmx/CheckLogOn?emailAddress=string&password=string HTTP/1.1 Host: developer.sym-online.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <CheckLogOnResponseModel xmlns="https://developer.sym-online.com/API/1_0/SOAP/"> <ContactID>int</ContactID> <ContactName>string</ContactName> <ContactRegStatus>int</ContactRegStatus> </CheckLogOnResponseModel>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /API/1_0/SOAP/SymphonyAPI.asmx/CheckLogOn HTTP/1.1 Host: developer.sym-online.com Content-Type: application/x-www-form-urlencoded Content-Length: length emailAddress=string&password=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <CheckLogOnResponseModel xmlns="https://developer.sym-online.com/API/1_0/SOAP/"> <ContactID>int</ContactID> <ContactName>string</ContactName> <ContactRegStatus>int</ContactRegStatus> </CheckLogOnResponseModel>