iSAMS Event API
Click here for a complete list of operations.
RetrieveTypes
Retrieves all available event types.
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 /global/api/Events.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/RetrieveTypes"
<?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>
<RetrieveTypes xmlns="http://www.estaronline.com/api/">
<authenticationToken>string</authenticationToken>
</RetrieveTypes>
</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>
<RetrieveTypesResponse xmlns="http://www.estaronline.com/api/">
<RetrieveTypesResult>
<Data>
<EventType>
<Type>string</Type>
<Triggers>string</Triggers>
<PayloadFormat xsi:nil="true" />
</EventType>
<EventType>
<Type>string</Type>
<Triggers>string</Triggers>
<PayloadFormat xsi:nil="true" />
</EventType>
</Data>
</RetrieveTypesResult>
</RetrieveTypesResponse>
</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 /global/api/Events.asmx HTTP/1.1
Host: demo.viare.io
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>
<RetrieveTypes xmlns="http://www.estaronline.com/api/">
<authenticationToken>string</authenticationToken>
</RetrieveTypes>
</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>
<RetrieveTypesResponse xmlns="http://www.estaronline.com/api/">
<RetrieveTypesResult>
<Data>
<EventType>
<Type>string</Type>
<Triggers>string</Triggers>
<PayloadFormat xsi:nil="true" />
</EventType>
<EventType>
<Type>string</Type>
<Triggers>string</Triggers>
<PayloadFormat xsi:nil="true" />
</EventType>
</Data>
</RetrieveTypesResult>
</RetrieveTypesResponse>
</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 /global/api/Events.asmx/RetrieveTypes?authenticationToken=string HTTP/1.1 Host: demo.viare.io
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<EventTypeApiResponse xmlns="http://www.estaronline.com/api/">
<Data>
<EventType>
<Type>string</Type>
<Triggers>string</Triggers>
<PayloadFormat>xml</PayloadFormat>
</EventType>
<EventType>
<Type>string</Type>
<Triggers>string</Triggers>
<PayloadFormat>xml</PayloadFormat>
</EventType>
</Data>
</EventTypeApiResponse>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /global/api/Events.asmx/RetrieveTypes HTTP/1.1 Host: demo.viare.io Content-Type: application/x-www-form-urlencoded Content-Length: length authenticationToken=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<EventTypeApiResponse xmlns="http://www.estaronline.com/api/">
<Data>
<EventType>
<Type>string</Type>
<Triggers>string</Triggers>
<PayloadFormat>xml</PayloadFormat>
</EventType>
<EventType>
<Type>string</Type>
<Triggers>string</Triggers>
<PayloadFormat>xml</PayloadFormat>
</EventType>
</Data>
</EventTypeApiResponse>