Use this request to retrieve details for campaign steps.
Elements
| Data Element | Type | Length | Conditional | Description |
|---|---|---|---|---|
| campaign_id | Int | True | Unique Campaign ID. | |
| campaign_name | string | 200 | True | Campaign Name. |
| step_id | int | True | Unique Step ID. | |
| step_name | string | 255 | True | The Step Name. |
| step_type_id | int | True | Unique Step Type ID. | |
| step_type_name | string | 255 | True | The Step Type Name. |
| step_key | int | True | The Step Key. | |
| target_group_id | Int | True | Unique Target Group ID. | |
| mailing_id | int | True | Unique Mailing ID. | |
| news_type_list | string | -1 | True | The News Type List. |
| is_news_type_add | bit | True | Is News Type List added? | |
| notify_email_list | string | -1 | True | The Notify Email List. |
| notify_message | String | -1 | True | The Notify Message. |
| wait_seconds | int | True | The Seconds to wait. | |
| wait_months | int | True | The Months to wait. | |
| wait_send_days | int | True | The wait send days. | |
| wait_send_hour_start | int | True | The wait send start hour. | |
| wait_send_hour_end | int | True | The Wait Start Date. | |
| wait_start_date | datetime | True | The Wait Start Date. | |
| timezone_id | int | True | The Time Zone ID. | |
| timezone_name | string | 128 | True | The Time Zone Name. |
| next_step_id | True | The Next Step ID. | ||
| fail_step_id | True | The Fail Step ID. | ||
| send_campaign_id | True | Another Campaign ID. | ||
| is_error | bit | True | Whether the step has an error or not? | |
| error_detail | Sting | -1 | True | The Step Error details. |
| is_step_deleted | bit | True | Has this step been flagged as deleted? |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
<Brand id="9999">Test Brand</Brand>
<User></User>
<Password></Password>
<Grids>
<Grid type="campaign_step">
<Conditions>
<Condition>
<Single>
<DataElement>campaign_id</DataElement>
<DataValue>26</DataValue>
<Comparator>EQ</Comparator>
</Single>
</Condition>
<Condition>
<Single>
<DataElement>step_id</DataElement>
<DataValue>169</DataValue>
<Comparator>EQ</Comparator>
</Single>
</Condition>
</Conditions>
<ReturnFields>
<DataElement>campaign_id</DataElement>
<DataElement>campaign_name</DataElement>
<DataElement>step_id</DataElement>
<DataElement>step_name</DataElement>
<DataElement>step_type_id</DataElement>
<DataElement>step_type_name</DataElement>
<DataElement>step_key</DataElement>
<DataElement>target_group_id</DataElement>
<DataElement>mailing_id</DataElement>
<DataElement>news_type_list</DataElement>
<DataElement>is_news_type_add</DataElement>
<DataElement>notify_email_list</DataElement>
<DataElement>notify_message</DataElement>
<DataElement>wait_seconds</DataElement>
<DataElement>wait_months</DataElement>
<DataElement>wait_send_days</DataElement>
<DataElement>wait_send_hour_start</DataElement>
<DataElement>wait_send_hour_end</DataElement>
<DataElement>wait_start_date</DataElement>
<DataElement>timezone_id</DataElement>
<DataElement>timezone_name</DataElement>
<DataElement>next_step_id</DataElement>
<DataElement>fail_step_id</DataElement>
<DataElement>send_campaign_id</DataElement>
<DataElement>is_error</DataElement>
<DataElement>error_detail</DataElement>
</ReturnFields>
</Grid>
</Grids>
</GridRequest>
Response
<?xml version="1.0" encoding="utf-8"?>
<GridResponse xmlns="http://partner.informz.net/aapi/2009/08/">
<Brand id="9999">Test Brand </Brand>
<User></User>
<Grids>
<Grid type="campaign_step">
<Record row="1">
<Fields>
<Field element="campaign_id">26</Field>
<Field element="campaign_name">Test Mailing</Field>
<Field element="step_id">169</Field>
<Field element="step_name">Send Mailing</Field>
<Field element="step_type_id">2</Field>
<Field element="step_type_name">Send Mail</Field>
<Field element="step_key">-3</Field>
<Field element="target_group_id" />
<Field element="mailing_id">208513</Field>
<Field element="news_type_list" />
<Field element="is_news_type_add">0</Field>
<Field element="notify_email_list" />
<Field element="notify_message" />
<Field element="wait_seconds">0</Field>
<Field element="wait_months">0</Field>
<Field element="wait_send_days">0</Field>
<Field element="wait_send_hour_start">0</Field>
<Field element="wait_send_hour_end">0</Field>
<Field element="wait_start_date" />
<Field element="timezone_id" />
<Field element="timezone_name" />
<Field element="next_step_id">170</Field>
<Field element="fail_step_id">0</Field>
<Field element="send_campaign_id">0</Field>
<Field element="is_error">0</Field>
<Field element="error_detail" />
<Field element="is_step_deleted">0</Field>
</Fields>
</Record>
</Grid>
</Grids>
</GridResponse>