POST {clientId}/export/Schedule/{scheduleName}?startDate={startDate}&endDate={endDate}

Initiate request by specifying an Export Schedule name. You can optionally pass-in both a start and an end date (both required, if either provided); otherwise, if dates are not provided, the export will not be restricted to a date range.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Possiblenow ClientId	string	Required
scheduleName	Name of the MyPreferences Export Schedule to export	string	Required
startDate	Optional start date of schedule run.	date	None.
endDate	Optional end date of schedule run.	date	None.

Body Parameters

Optional Callback URL used for the request

ScheduleRequestInfo

Name	Description	Type	Additional information
CallbackURL	Optional Callback URL that will be called when the export is complete	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CallbackURL": "sample string 1"
}

application/xml, text/xml

Sample:

<ScheduleRequestInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.Async.Models">
  <CallbackURL>sample string 1</CallbackURL>
</ScheduleRequestInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.  See https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4 for details.

Response Information

Resource Description

AsyncToken

Name	Description	Type	Additional information
AccessToken	Unique token used to check status and pull data for async calls	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AccessToken": 1
}

application/xml, text/xml

Sample:

<AsyncToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.Async.Models">
  <AccessToken>1</AccessToken>
</AsyncToken>