Retrieve status
Returns the status of your request.
Header Parameters
Authorizationstring Required
Authorization token
Path Parameters
clientIdstring Required
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
accessTokeninteger Required
Secure token returned by the Initiate call, required as a URL parameter in all subsequent API requests.
Response
200
Object
Response Attributes
AccessTokeninteger
Authentication Token used to retrieve export status and records.
Statusstring
The Status of the export. 'Processing', 'Error', 'Expired', 'Retrieved', or 'Complete'.
Enum values:
ProcessingErrorExpiredRetrievedCompleteRowCountinteger
Total amount of rows that have been retrieved by the export. This value is only available after the entire export is complete.
ByteCountinteger
Total size of the export in bytes. This value is only available after the entire export is complete.
400
Object
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
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
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
Object
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.
503
Object
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.
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?