Product Entry Objects

Get Entry Data

GET /(company_code)/v2/aol/entry/(entry_code)

Get Entry data

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to get. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Entry data object. Included fields depend on the role of authorized user.

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

See Error Codes for details.

Update Entry Data

PUT /(company_code)/v2/aol/entry/(entry_code)

Update Entry data

All data fields in request JSON are optional, any field can be omitted if its data has not changed. Depending on roles of authorized user and updated profile, only part of data fields may be allowed for updates. Values of restricted fields in request JSON will be ignored.

If entry profile is stopped, returns auth.restricted error code.

If product status is C, returns auth.restricted error code.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to update. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
Request JSON Object:
 
  • attributes (array) – (Optional) Data objects for entry attributes (see below)
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Updated entry data object

Request attribute data fields

Each object in attributes request array has the following fields:

Field name Type Description
seq integer Attribute sequential number, 1 to 10
value string New attribute value

Sequential numbers must be the same as in attribute objects returned by API in entry data.

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • request.validation.failed

See Error Codes for details.

Delete Entry

DELETE /(company_code)/v2/aol/entry/(entry_code)

Void Entry

If entry profile is stopped, returns auth.restricted error code.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to delete. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Updated entry data object

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

See Error Codes for details.

Replace Entry

POST /(company_code)/v2/aol/entry/(entry_code)/replace

Replace entry with a newly created one in all entry combinations

A new entry is created representing a bonus account, cashback account etc. that a client has with the same product and entry class as the replaced entry which is cancelled. All entry combinations where replaced entry was the foreign entry are changed to the new entry.

Response data array contains data objects of replaced and new entries.

If entry with supplied external ID already exists, returns auth.restricted error code.

If entry profile is stopped, returns auth.restricted error code.

If entry class is configured for entry enroll using OAuth, users with CLIENT role must supply oauth_code and oauth_redirect_uri request fields instead of entry data fields. OAuth verification is performed and entry data is received from OAuth provider.

If OAuth provider returns the same OAuth user ID that replaced entry has, returns oauth.identifier.used error code.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to replace. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
Request JSON Object:
 
  • external_id (string) – (Optional) External ID for new entry
  • entry_nr (string/null) – (Optional) Entry number
  • entry_date (string) – (Optional) Date of entry becoming effective
  • name (string/null) – (Optional) Entry name for display
  • details (string/null) – (Optional) Entry details text
  • attributes (array) – (Optional) Data objects for entry attributes (see below)
  • oauth_code (string) – (Optional) OAuth code, as received from OAuth provider
  • oauth_redirect_uri (string) – (Optional) Redirect URI, as passed to OAuth provider
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (array) – Entry data objects. Included fields depend on the role of authorized user.

Request attribute data fields

Each object in attributes request array has the following fields:

Field name Type Description
seq integer Attribute sequential number, 1 to 20
value string New attribute value

Sequential numbers must be the same as in attribute objects returned by API in entry data.

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.oauth.failed
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • oauth.identifier.used
  • object.id.notfound
  • request.validation.failed

See Error Codes for details.

Attach Foreign Entry

POST /(company_code)/v2/aol/entry/(entry_code)/attach

Attach foreign Entry (create combination)

If foreign entry is not found or does not belong to the same profile as the primary entry, request.validation.failed error code is returned.

If entry profile is stopped, returns auth.restricted error code.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to update. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
Request JSON Object:
 
  • foreign_entry_code (string) – Code of foreign entry to attach. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
  • allocation_option (string/null) – (Optional) Bonus allocation option
  • allocation_operator (string/null) – (Optional) Comparison operator for allocation value
  • allocation_value (string/null) – (Optional) Bonus allocation value
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Updated entry data object

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • request.validation.failed

See Error Codes for details.

Detach Foreign Entry

POST /(company_code)/v2/aol/entry/(entry_code)/detach

Detach foreign Entry (delete combinations)

If foreign entry is not found or does not belong to the same profile as the primary entry, request.validation.failed error code is returned.

If entry profile is stopped, returns auth.restricted error code.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to update. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
Request JSON Object:
 
  • foreign_entry_code (string) – Code of foreign entry to detach. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Updated entry data object

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • request.validation.failed

See Error Codes for details.

Delete Entry Combination

DELETE /(company_code)/v2/aol/entry/(entry_code)/combination/(int: combination_id)

Delete Entry combination

If entry profile is stopped, returns auth.restricted error code.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to update. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
  • combination_id – ID of combination to delete
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Updated entry data object

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

See Error Codes for details.

Replace Entry Combination

POST /(company_code)/v2/aol/entry/(entry_code)/combination/(int: combination_id)/replace

Replace foreign entry of combination

If foreign entry is not found or does not belong to the same profile as the primary entry, request.validation.failed error code is returned.

If entry profile is stopped, returns auth.restricted error code.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to update. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
  • combination_id – ID of combination to update
Request JSON Object:
 
  • foreign_entry_code (string) – Code of foreign entry to attach. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
  • allocation_option (string/null) – (Optional) Bonus allocation option
  • allocation_operator (string/null) – (Optional) Comparison operator for allocation value
  • allocation_value (string/null) – (Optional) Bonus allocation value
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Updated entry data object

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • request.validation.failed

See Error Codes for details.

Set Entry Tag Value

PUT /(company_code)/v2/aol/entry/(entry_code)/tag/(tag_name)

Set Entry Tag value

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to get. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
  • tag_name – Name of entry tag to set
Request JSON Object:
 
  • tag_date (string) – (Optional) Date when tag value becomes effective, ISO-formatted: YYYY-MM-DD
  • discontinue_date (string) – (Optional) Date when tag value stops being effective, ISO-formatted: YYYY-MM-DD
  • value (string) – Tag value
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Updated entry data object

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

See Error Codes for details.

Unset Entry Tag Value

DELETE /(company_code)/v2/aol/entry/(entry_code)/tag/(tag_name)

Unset Entry Tag value

If entry profile is stopped, returns auth.restricted error code.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • entry_code – Code of entry to get. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
  • tag_name – Name of entry tag to set
Request JSON Object:
 
  • discontinue_date (string) – (Optional) Date when tag value stops being effective, ISO-formatted: YYYY-MM-DD
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below
  • data (object) – Updated entry data object

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

See Error Codes for details.