Document Destination - Inbox

Example

Add a new once schedule for a document that contains one prompt, with inbox destination

This example shows how to add a new schedule with an inbox destination (by default, the scheduled document is always sent to the sender). Since the document contains a prompt, the request body xml file also provides the response to the prompt. Prompt text named "Enter State:" with value "Texas" on a DP with "DP0" as id.

POST <webiURL>/documents/8002/schedules

Request body in an XML file:

<schedule>
    <name>test_monthly_ftp</name>
    <format type="webi"/>
    <destination><inbox/></destination>
    <once retriesAllowed="2" retryIntervalInSeconds="60">
        <startdate>2012-08-26T15:58:51.000+02:00</startdate>
        <enddate>2013-08-27T15:58:51.000+02:00</enddate>
    </once>
    <parameters>
        <parameter optional="false" type="prompt" dpId="DP0">
            <id>0</id>
            <technicalName>Enter State:</technicalName>
            <answer constrained="false" type="text">
                <values>
                    <value>Texas</value>
                </values>
            </answer>
        </parameter>
    </parameters>
</schedule>

Example

Add a new once schedule, with inbox destination for specific users
Note This example shows how to add a new schedule with an inbox destination specifying four user ids (by default, the scheduled document is always send to the sender). The scheduled document can be sent as a shortcut by specifying the tag sendAs with the value shortcut (default value is copy).

POST <webiURL>/documents/8002/schedules

Request body in an XML file:

<schedule>
    <name>test_once_inbox_users</name>
    <format type="webi"/>
    <destination>
        <inbox>
            <to>11,12,1,2
            <sendAs type="shortcut"/>
        </inbox>
    </destination>
</schedule>