Arghon Interactive REST Request API
This API defines the REST web-service interface your company must implement to enable Arghon users
to communicate directly with your company in real-time.
Note: A business account is required to utilize this API.
Interactive API XSD File
Click here for Interactive API XSD File.
Data Formats Sent and Received
HTTPS POST - REST
REST API Parameters
This is the name of an item the user is interested in. So it could be "paper towel", "chicken", "sony television", etc.
The attribute of the name in the object parameter the user wants information on. For example: target could be the price, amount, etc.
Verb applies more to a condition of the value in the target field. An example verb could be the words: "on sale"
This is usually today's date in XML Format YYYY-MM-DD. It allows the user to specify a date for when he or she wants the information .
Example: The user may want to know the price on a specific day such as black Friday. Black Friday's date would be in this field.
This allows the user to further refine the value in target.
Example: it could have "latest" or "lowest", referring to the price of apples.
This field holds "command value" of a list item the user selected from the previous interaction where you presented the user with a list of items to choose from.
You should always check for userselection first. If one exists, then it's a follow up question.
Note: When the userselection has a value, object, verb, date, target, and adjective, parameters will be empty.
This is the 2 letter state or province code at the user's current location.
This is the postal code at the user's current location.
The latitude in radians of the user's location. Example 43.12345
The longitude in radians of the user's location. Example -71.34884
The ISO3 country code.
The UTC offset in minutes from the user's local time. This could be negative or positive.
This is the arghon developer key. This will allow your web service to authenticate the caller.
API Response XML Fields
A name that describes the answer. In most cases it is the value in the target parameter from the request.
Tells the success or failure of the request.
0: The request was successful, value or list field has the answer.
-1: Your web-service does not have an answer to the question.
-nn: Any other negative number is a system or authentication error.
Place a description of the error in the value field.
Each answer is rated for an age appropriate audience.
0: Answer suited for all audience
13: Answer suited for age 13 and above.
18: Answer suited for age 18 and above
-1: Answer has violence/strong language or sexually explicit content.
See AnswerFormatType in the xsd specification file.
An answer can be a list or a single value.
0: Plain text. The value is displayed to the user as is.
1: Answer is a list of 2 or more listItemType to choose from.
4: "pictureurl" element in response is of a coupon.
a. Coupons should be no more 3"x4" inches in size.
b. The value field describes the coupon to the user.
c. The amount field has the value of the coupon.
Set to 1 if the result can be cached. This allows Arghon to cache the result without having to go back to your web service each time a user asks the same question. A cached answer lasts 24 hours.
This is a number that communicates quantity, price or value. In most cases the default is 1.
The answer to a question is either a single value or a list the user must choose from.
A list consists of 2 or more ListItemType.
See the answerformat field documentation for additional information.
An optional expire date. Primarily used for holding the expiration date of a coupon.
This is the answer to the user's request (question).
An answer can be a list or a plain text single value.
The answerformat field is used to determine which to use.
A URL to an image of the product or service.
A URL to an Audio file that the user can listen to. (mp3,wav,ect)
A URL to a video with additional information. It could be a YouTube video or another source.
This is the latitude coordinate of a location where the answer can be found. It can be a store or place of business.
Example 42.12993. Set to empty value, if it is not applicable
This is the longitude coordinate of a location where the answer can be found. It can be a store or place of business.
Example -73.12345. Set to empty value if it is not applicable.
The URL Arghon connects to is specified by you on the developer profile page in the communication URL field.
REST Example Request
https://yourwebsite.com/services/arghoninteractive/ HTTP POST
Example REST XML response to request:
<value>The price is $2.45 per roll.</value>
Example Response XML with list to Arghon REST Request
<text>Bounty paper towel</text>
<text>Brawny Paper towel</text>
<text>Scott paper towel</text>