Page Comparison

...

Detailed description of the API request elements:

URL parameter	Example	Description	Requirements
action	action=GetMarkers	Name of the HTTP API request.	Mandatory
apiKey	apiKey=74c8eea0-50c6-40b2-9f3e-252ed501c3c8	API key used to identify the application.	Mandatory
token	token=09835e02-6c10-11e0-bb22-ba324924019b	Unique identifier for authenticated sessions. After successful authentication, the API sends back a token, which has to be used for each request.	Mandatory if authentication is configured for the given API key.
responseType	responseType=HTML	Defines the format of the response of the API request. The following valid values apply: XML: the response is formatted and structured in XML, designed for applications HTML: the response is in human readable format and formatted using standard HTML; it can be directly displayed in any browser. TEXT: simple clear text based response	If the parameter is missing, it defaults to XML.

callID

cid

callID=a8343631-9f35-4a3a-83f0-9e81592339fb

Defines the internal ID of the call.

Either the callID or either the number parameter is mandatory

Mandatory

Response

XML based response sample on success:

Info

icon	false

<?xml version="1.0" encoding="UTF-8"?>
<VerbaApi>
  <Response code="0" type="GetMarkers">
    <verbamarker>
      <name>Sale</name>
      <start>16700</start>
      <end>65400</end>
    </verbamarker>
    <verbamarker>
      <name>Price</name>
      <start>101000</start>
      <end>145000</end>
    </verbamarker>
  </Response>
<VerbaApi>

XML based response sample on error:

Info

icon	false

<?xml version="1.0" encoding="UTF-8"?>

<ErrorMessage description="Error">Call <ErrorMessage>Call cannot be found.</ErrorMessage>

</Response>

</VerbaApi>

...

HTML based response sample:

...

TEXT based response sample:

Info

icon	false

Markers
Name: Sale, Start: 16700 ms, End: 65400 ms
Name: Price, Start: 10100 ms, End: 145000 ms

Versions Compared

Old Version 1

New Version Current

Key

Response