Product Objects

List Products

GET /(company_code)/v2/aol/product

Get data of available Products

This endpoint does not require a session token. Available products are determined by the supplied API key.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Query Parameters:
 
  • primary (boolean) – (Optional) Get only the primary product for client application
  • product_class (string) – (Optional) Product class code to filter results by, or comma-separated list of codes
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Product data objects
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Product data fields

Each object in data response array has the following fields:

Field name Type Description
mnemocode string Product mnemocode
product_class string Product class code
name string Product name for display
status string Product status code: I (in effect), C (cancelled), or S (suspended)
effective_date string Date of becoming effective, ISO-formatted: YYYY-MM-DD
discontinue_date string Discontinue date, ISO-formatted: YYYY-MM-DD
details object Product content data for display
attributes array Data objects for product attributes (see below)
primary boolean Flag indicating whether this is the primary product for client application

Attribute data fields

Each object in attributes array of response product data object has the following fields:

Field name Type Description
seq integer Attribute sequential number, 1 to 20
label string Attribute label for display
value string Attribute value

Error codes used

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

See Error Codes for details.

Get Product Data

GET /(company_code)/v2/aol/product/(product_code)

Get Product data

This endpoint does not require a session token. Available products are determined by the supplied API key.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Parameters:
  • product_code – Mnemocode of product to get
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Product data object
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Product data fields

data response object has the following fields:

Field name Type Description
mnemocode string Product mnemocode
product_class string Product class code
name string Product name for display
status string Product status code: I (in effect), C (cancelled), or S (suspended)
effective_date string Date of becoming effective, ISO-formatted: YYYY-MM-DD
discontinue_date string Discontinue date, ISO-formatted: YYYY-MM-DD
details object Product content data for display
attributes array Data objects for product attributes (see below)
primary boolean Flag indicating whether this is the primary product for client application

Attribute data fields

Each object in attributes array of response product data object has the following fields:

Field name Type Description
seq integer Attribute sequential number, 1 to 20
label string Attribute label for display
value string Attribute value

Error codes used

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

See Error Codes for details.

Update Product Data

PUT /(company_code)/v2/aol/product/(product_code)

Update Product data

All data fields in request JSON are optional, any field can be omitted if its data has not changed.

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

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • product_code – Mnemocode of product to update
Request JSON Object:
 
  • name (string/null) – (Optional) Product name
  • attributes (array) – (Optional) Data objects for product 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 product 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 product 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.

List Product Combinations

GET /(company_code)/v2/aol/product/(product_code)/combination

List Product Combinations

This endpoint does not require a session token. Available products are determined by the supplied API key.

Parameters:
  • product_code – Mnemocode of product to get
Query Parameters:
 
  • foreign_product_class (string) – (Optional) Foreign product class code to filter results by, or comma-separated list of codes
  • seq (integer/string) – (Optional) Combination sequential number to filter results by, or comma-separated list of numbers
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Product combination data objects
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Product combination data fields

Each object in data response array has the following fields:

Field name Type Description
seq integer Combination sequential number
foreign_product string Foreign product mnemocode
foreign_product_class string Foreign product class code
foreign_product_name string Foreign product name
foreign_product_status string Foreign product status code: I (in effect), C (cancelled), or S (suspended)
details object Product combination content data for display
suspend_flag boolean Indicates whether product combination is suspended

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • object.id.notfound
  • request.validation.failed

See Error Codes for details.

List Entry Classes

GET /(company_code)/v2/aol/product/(product_code)/entryclass

Get data of available Entry Classes for Product

Some of returned values are user role dependant. If this endpoint is used before user authentication, it must be called again for authorized user.

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Parameters:
  • product_code – Mnemocode of product to get
Query Parameters:
 
  • name (string) – (Optional) Entry Class name to filter results by, or comma-separated list of names
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Entry class data objects
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Entry class data fields

Each object in data response array has the following fields:

Field name Type Description
name string Entry class name
details object Entry class content data for display
product string Product mnemocode
product_class string Product class code
enabled_flag boolean Indicates whether entry class is enabled
multiple_entry boolean Indicates whether entry class allows profile to have more than one entry
one_to_many boolean Indicates whether entry class allows entry to have more than one combination
signup_flag boolean Indicates whether entry class allows user to sign up client for a new entry
signup_disclaimers array Data objects of legal disclaimers that user needs to accept to sign up
enroll_flag boolean Indicates whether entry class allows user to enroll a new entry for client
enroll_disclaimers array Data objects of legal disclaimers that user needs to accept to enroll
enroll_oauth_provider integer/null ID of OAuth provider used to enroll a new entry
entry_nr_mask string/null Regexp mask to check entry number format
entry_nr_input_mask string/null Mask for entry number UI input field format
card_product_alt string/null Payment card product name for display
card_payment_org string/null Payment card organization name for display
tags array Names of tags available for this entry class as strings

Disclaimer fields

Each member of signup_disclaimers and enroll_disclaimers arrays is an object with following fields:

Field name Type Nullable Description
code string No Disclaimer code
title string No Disclaimer title for display
description string No Short disclaimer description
link string No URL for link to legal disclaimer text

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
  • object.id.notfound

See Error Codes for details.

List Entry Class Combinations

GET /(company_code)/v2/aol/product/(product_code)/entryclass/combination

Get data of available Entry Class combinations

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Parameters:
  • product_code – Mnemocode of product to get
Query Parameters:
 
  • primary_entry_class (string) – (Optional) Primary entry class name to filter results by, or comma-separated list of names
  • foreign_product (string) – (Optional) Foreign product mnemocode to filter results by, or comma-separated list of mnemocodes
  • foreign_product_class (string) – (Optional) Foreign product class code to filter results by, or comma-separated list of codes
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Entry class combination data objects
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Entry class combination data fields

Each object in data response array has the following fields:

Field name Type Description
name string Entry class combination name
seq integer Sequential number of combination
primary_entry_class string Primary entry class name
foreign_entry_class string Foreign entry class name
foreign_product string Foreign product mnemocode
foreign_product_class string Foreign product class code
details object Entry class combination content data for display
options array Valid entry class combination allocation options
enabled_flag boolean Indicates whether combination is enabled
primary_flag boolean Indicates whether combination is primary for entry class

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
  • object.id.notfound

See Error Codes for details.

[DEPRECATED] List Entry Class Combinations

GET /(company_code)/v2/aol/product/(product_code)/entryclass/(name)/combination

[DEPRECATED] Get data of available Entry Class combinations

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • product_code – Mnemocode of product to get
  • name – Name of entry class to get
Query Parameters:
 
  • foreign_product_class (string) – (Optional) Foreign product class code to filter results by, or comma-separated list of codes
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Entry class combination data objects
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Entry class combination data fields

Each object in data response array has the following fields:

Field name Type Description
name string Entry class combination name
seq integer Sequential number of combination
foreign_entry_class object Data object of foreign entry class
details object Entry class combination content data for display
options array Valid entry class combination allocation options
enabled_flag boolean Indicates whether combination is enabled
primary_flag boolean Indicates whether combination is primary for entry class

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
  • object.id.notfound

See Error Codes for details.

List Entry Class Tags

GET /(company_code)/v2/aol/product/(product_code)/entryclass/(name)/tag

List valid Tags for Entry Class

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • product_code – Mnemocode of product to get
  • name – Name of entry class to get
Query Parameters:
 
  • tag_name (string) – (Optional) Tag name to filter results by, or comma-separated list of names
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Entry class tag data objects
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Entry class tag data fields

Each object in data response array has the following fields:

Field name Type Description
tag_name string Tag name
read_only_flag boolean Indicates whether updating values for this tag is restricted for user
values array/null Array of valid value objects. null means that any value is accepted.

Value data fields

Each member of the values array has following fields:

Field name Type Nullable Description
code string No Value code
meaning string No Textual description of the value

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
  • object.id.notfound

See Error Codes for details.

Calculate Conversion for Entry Class Combination

POST /(company_code)/v2/aol/product/(product_code)/entryclass/(entry_class_name)/combination/(combination_name)/calc

Calculate conversion result for Entry Class combination

Request Headers:
 
  • Authorization – (Optional) Bearer <session_token>, or Signature <signature>
Parameters:
  • product_code – Mnemocode of product
  • entry_class_name – Name of primary entry class of combination
  • combination_name – Name of entry class combination
Request JSON Object:
 
  • amount (integer) – Amount (in one-hundredths) of currency to convert
Response JSON Object:
 
  • status (string) – success or error
  • data (integer) – Resulting amount (in one-hundredths) of converted currency
  • error_code (string) – (Optional) If status is error: one of error codes listed below

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
  • object.id.notfound
  • request.validation.failed

See Error Codes for details.