+49 69 83008980 service@xqueue.com

Benötigen Sie Hilfe?

Get Mailings By Schedule Time

Sie sind hier:
< Alle Themen
 

Returns a page of mailings in the account that match the given types (one or a list)

GET https://api.maileon.com/1.0/mailings/filter/scheduletime

Attributes

Parameter Default Description
scheduleTime This is a date and time string that defines the filter for a mailing. The mailings before and after that time can be queried, see beforeSchedulingTime. The format is the standard SQL date: yyyy-MM-dd HH:mm:ss
beforeSchedulingTime If true, the mailings before the given time will be returned, if false, the mailings at or after the given time will be returned.
fields This list contains the fields that shall be returned with the result. If this list is empty, only the IDs will be returned. Valid fields are: statetypename, and scheduleTime
page_size 100 The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000.
page_index 1 The index of the result page. The index must be greater or equal to 1.
orderBy id This field can be used to change the order field. Allowed values are: is, state, name, and schedule_time.
order ASC This field sets the order direction, by default this is set to an ascending order.
 

Example 1

GET https://api.maileon.com/1.0/mailings/filter/scheduletime?page_index=3&page_size=3&scheduleTime=2013-10-07+12%3A00%3A00&beforeSchedulingTime=false
Content-type: application/vnd.maileon.api+xml
Accept: application/vnd.maileon.api+xml; charset=utf-8
Authorization: [XXX]

Status: 200 OK
Content-Type: application/vnd.maileon.api+xml
Link: <https://api.maileon.com/1.0/mailings/filter/types?page_index=1&page_size=3&scheduleTime=2013-10-07+12%3A00%3A00&scheduleTime=false>; rel="start"
X-Items: 1
X-Pages: 1

<?xml version="1.0" encoding="UTF-8"?>
<mailings>
  <mailing>
    <id>1</id>
    <fields/>
  </mailing>
</mailings>

Example 2

GET https://api.maileon.com/1.0/mailings/filter/scheduletime?page_index=3&page_size=3&scheduleTime=2013-10-07+12%3A00%3A00&beforeSchedulingTime=false&fields=state&fields=type&fields=name&fields=scheduleTime
Content-type: application/vnd.maileon.api+xml
Accept: application/vnd.maileon.api+xml; charset=utf-8
Authorization: [XXX]

Status: 200 OK
Content-Type: application/vnd.maileon.api+xml
Link: <https://api.maileon.com/1.0/mailings/filter/types?page_index=1&page_size=3&fields=state&fields=type&fields=name&fields=scheduleTime&scheduleTime=2013-10-07+12%3A00%3A00&scheduleTime=false>; rel="start"
X-Items: 1
X-Pages: 1

<?xml version="1.0" encoding="UTF-8"?>
<mailings>
  <mailing>
    <id>1</id>
    <fields>
      <field>
        <name>name</name>
        <value>Mailing1</value>
      </field>
      <field>
        <name>state</name>
        <value>draft</value>
      </field>
      <field>
        <name>type</name>
        <value>regular</value>
      </field>
      <field>
        <name>scheduleTime</name>
        <value>2014-10-06 12:00:00</value>
      </field>
    </fields>
  </mailing>
</mailings>

 

Inhaltsverzeichnis