POST {clientId}/export/CID?startDate={startDate}&endDate={endDate}
Initiate CID export request, provding one or more CID values and one or more channel names.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
Possiblenow ClientId |
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 as well as specified CID values and channel name values.
CIDRequestInfoName | Description | Type | Additional information |
---|---|---|---|
CallbackURL |
Optional Callback URL that will be called when the export is complete |
string |
None. |
CID | Collection of string |
None. |
|
Channels | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "CallbackURL": "sample string 1", "CID": [ "sample string 1", "sample string 2" ], "Channels": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<CIDRequestInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.Async.Models"> <CID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </CID> <CallbackURL>sample string 1</CallbackURL> <Channels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Channels> </CIDRequestInfo>
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
AsyncTokenName | 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>