FreedomAPI
Click here for a complete list of operations.
Login
Explicit Login function -- used to set the authentication cookie for the duration of those WebService session
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 /freedomapi/freedomapi.asmx HTTP/1.1 Host: webservices.freedomvoice.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://webservices.freedomvoice.com/FreedomAPI/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="https://webservices.freedomvoice.com/FreedomAPI"> <username>string</username> <password>string</password> </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="https://webservices.freedomvoice.com/FreedomAPI"> <LoginResult> <Data>xml</Data> <FileData>base64Binary</FileData> <message>string</message> <result>boolean</result> <ResultList> <string>string</string> <string>string</string> </ResultList> <sessionId>string</sessionId> </LoginResult> </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 /freedomapi/freedomapi.asmx HTTP/1.1 Host: webservices.freedomvoice.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="https://webservices.freedomvoice.com/FreedomAPI"> <username>string</username> <password>string</password> </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="https://webservices.freedomvoice.com/FreedomAPI"> <LoginResult> <Data>xml</Data> <FileData>base64Binary</FileData> <message>string</message> <result>boolean</result> <ResultList> <string>string</string> <string>string</string> </ResultList> <sessionId>string</sessionId> </LoginResult> </LoginResponse> </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 /freedomapi/freedomapi.asmx/Login?username=string&password=string HTTP/1.1 Host: webservices.freedomvoice.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ReturnData xmlns="https://webservices.freedomvoice.com/FreedomAPI"> <Data>xml</Data> <FileData>base64Binary</FileData> <message>string</message> <result>boolean</result> <ResultList> <string>string</string> <string>string</string> </ResultList> <sessionId>string</sessionId> </ReturnData>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /freedomapi/freedomapi.asmx/Login HTTP/1.1 Host: webservices.freedomvoice.com Content-Type: application/x-www-form-urlencoded Content-Length: length username=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"?> <ReturnData xmlns="https://webservices.freedomvoice.com/FreedomAPI"> <Data>xml</Data> <FileData>base64Binary</FileData> <message>string</message> <result>boolean</result> <ResultList> <string>string</string> <string>string</string> </ResultList> <sessionId>string</sessionId> </ReturnData>