The URI Scheme Convention defines the Uniform Resource Identifier (URI) naming structure top level.
URI Syntax and Example
http://[host:port/internalPath]Application Name/version/[version]/account/[accountID]/[object]/[Object-Id]/[Object-Instance-Id]/[operation]
http://api.interact.jacada.com/version/1/account/<accountid>/interaction/support/navigation
Note: version and account are required.
All URI elements, except http://[host:port] (schema, host, port), are case sensitive.
|
The possible URI fields are as follows:
URI Field
|
Data Type
|
Description and Example
|
version
|
string
|
Specifies the service protocol version. Helps redundancy and supports adding additional protocol versions without limiting older agents.
The format is as follows: v$ - v1, v2, v3, and so on. (where $ is an integer)
|
account
|
string
|
Represents the customer account list when clustering services in cloud.
|
accountID
|
string
|
Unique customer account ID.
|
object
|
string
|
A specific customer service (from a list of services).
A service can be: interaction, chat, voice, video, email, and so on.
|
Object-Id
|
string
|
Designates a specific service sub-class. For example, there can be many Interaction instance types, as well as many voice service sub-classes.
The field value can be an auto-generated server TOKEN or a specified name, for example:
•With an ID— …/interaction/support/g333e/navigation •Without an ID— …/chat/0/0/waitingTime |
Object-Instance-Id
|
string
|
An object instance identifier, for example, the identifier for running a current Interaction instance against a Jacada Interaction Server client.
|
Operation
|
string
|
Specifies one of the following operations:
•Interaction operations—Navigation{next, back, save, end, stopAndSave} •Chat operations—initiate, type, averageWaitTime, visitorTyping Important: When this field is used, this protocol requires the request transport method REST (HTTP) POST.
|
|
