POST Async/{clientId}/Export/Segment/{segmentName}
Initiate request by specifying a Segment name. You can optionally pass lastdatetime to retrieve preference updates for a specific period.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
Possiblenow ClientId |
string |
Required |
segmentName |
Name of the MyPreferences segment to export |
string |
Required |
Body Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CallbackURL |
Optional Callback URL that will be called when the export is complete |
string | |
LastDateTime |
Optional starting datetime that preference updates will be retrieved from The LastDateTime support values up to the millisecond. The millisecond value will always be rounded to the nearest boundary to avoid records being skipped. For example, 000 through 002 becomes 003, 003 through 006 becomes 007, and 007 through 009 becomes 000 of the next higher value. |
string |
Request Formats
application/json, text/json, application/json-patch+json
{ "CallbackURL": "sample string 1", "LastDateTime": "sample string 2" }
application/xml, text/xml
<SegmentRequestInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models"> <CallbackURL>sample string 1</CallbackURL> <LastDateTime>sample string 2</LastDateTime> </SegmentRequestInfo>
Response Information
Response Codes
HTTP Status Code | Text | Description |
---|---|---|
400 | Bad Request | The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again. |
401 | Unauthorized | Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again. |
403 | Forbidden | The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again. |
404 | Not Found | The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found. See error description for more details. |
429 | ||
500 | Internal Server Error | The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence. |
503 | Service Unavailable | The server is unable to handle your request due to a temporary condition. You must delay your request for some time before trying again. Notify PossibleNOW Support if it’s a continuous occurrence |
Resource Description
AsyncTokenName | Description | Type | Additional information |
---|---|---|---|
AccessToken |
Unique token used to check status and pull data for async calls |
integer |
Response Formats
application/json, text/json, application/json-patch+json
{ "AccessToken": 1 }
application/xml, text/xml
<AsyncToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models"> <AccessToken>1</AccessToken> </AsyncToken>