Standard parameters
action = reply
object = offers
is_success = a Boolean is returned, indicating success or failure of the request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the following:
|
Parameter name |
Obligation |
Definition / Value |
|
codes |
Returned if is_success = true |
The list of codes and their properties. For more information, see the Codes table below. |
Codes
Parameters within the codes associative array are described below.
|
Parameter name |
Obligation |
Definition/Value |
|
code |
Always returned |
The unique code for the offer. |
|
company_name |
Always returned |
The name of the company issuing the offer. Currently, this parameter returns Fotolia, Host Merchant Services, MightyCall, or Ting. |
|
creation_date |
Always returned |
The date that the code was generated, in the form, YYYY-MM-DDThh-mm-ssZ. The T indicates the start of the time component and the Z indicates that it is UTC. |
|
offer_name |
Always returned |
Description of the offer. |
|
status |
Always returned |
The current status of the offer. Allowed values are:
|