API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve exceptions

During the staging process and import execution, exceptions may occur due to various factors, such as incorrect data or email addresses that do not conform to the regular expressions (RegEx) configured on your account.

This same endpoint is used to retrieve records that encountered exceptions during either the staging or execution phase. Exception records retrieved during the staging process can be corrected and re-staged for import.

Header Parameters

Authorizationstring Required

Authorization token

Query Parameters

limitinteger

Specifies the maximum number of records to return. Defaults to 1000, if not specified.

offsetinteger

Used in conjunction with limit that specifies the starting point to retrieve the next batch of records. Defaults to 1, if not specified. For example, if your limit is 100 and you specify an offset of 100, the system returns records from 100 through 200.

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

accessTokeninteger Required

Access token returned from InitiateBulkImport call. A 401 is returned if this value is invalid.

Response

200
Object

Response Attributes

Countinteger

Number of exception records returned based on the criteria provided in the request properties. Read-Only Field.

HasMoreboolean

Based on the limit value specified, it informs the user if there are any additional exception records available for retrieval. Read-Only Field.

Limitinteger

Specifies the maximum number of records to return. Defaults to 1000, if not specified.

Offsetinteger

Used in conjunction with limit that specifies the starting point to retrieve the next batch of records. Defaults to 1, if not specified. For example, if your limit is 100 and you specify an offset of 100, the system returns records from 100 through 200.

TotalResultsinteger

This is the Total number of exception records returned in the request. This number is limited to the maximum number defined in the limit and will not exceed that value. Read-Only Field.

FailedRecordsarray

Collection of BulkUserProfilePreferenceExceptions. This value is the list of records that encountered exceptions. Exceptions will be returned in the format of the BulkUserProfilePreferenceException collection and include the data that was received as well as the exceptions encountered using the ExceptionsDefinition collection.

Show child attributes

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.
503
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?