Embedded Files
API Documentation V2
ActiveTransactionals collection allows retrieving all defined transactional messages including currently unsent messages.
Request data format
Request data format
Request URL parameters:
Example:
https://api.esv2.com/v2/Api/ActiveTransactionals?apiKey=YOUR_API_KEY_HERE
Response
Response
Response Data element:
Transactional element children:
Tag element children:
Examples
Examples
Request:
GET
https://api.esv2.com/v2/Api/ActiveTransactionals?apiKey=test_api_key1 HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: api.esv2.com
OK response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=cu23cqm125fq1qih1kg4ux45; path=/; HttpOnly
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Mon, 22 Jan 2018 12:56:22 GMT
Content-Length: 480
<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Data>
<Transactionals>
<Transactional>
<Id>23</Id>
<Tags>
<Tag>tag_1</Tag>
<Tag>tag_5</Tag>
</Tags>
</Transactional>
<Transactional>
<ID>256</Id>
<Tags>
<Tag>tag_2</Tag>
</Tags>
</Transactional>
<Transactional>
<Id>345</Id>
<Tags/>
</Transactional>
</Transactionals>
</Data>
</ApiResponse>
OK Response when in the specified Business Unit hasn't active transactional message:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=cu23cqm125fq1qih1kg4ux45; path=/; HttpOnly
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Mon, 22 Jan 2018 12:56:22 GMT
Content-Length: 177
<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Data>
<Transactionals />
</Data>
</ApiResponse>
Report abuse