Commonalities for all requests



This is the service address which has to be used for all requests:


This is how a request looks like:<name-of-request>?<name-of-parameter-1>=<value-of-parameter-1>



Header fields which are returned by most requests

Tracking Id Unique server-assigned tracking id, assigned to almost all requests 
Status-Code 0 if no error occured, otherwise other than 0
Status-Text Human readable error description
Result ACK or NACK (= "Acknowlegded" or "Not Acknowledged") 
Error May be returned if (and only if) the request was rejected, in this case reason(s) will be provided. Presence of this line in headers is indicative for that processing didn't take place.
Warning Indicative of non-fatal processing or validation problems
Proc-Id processing ID 
HTTP error codes 200 if everything is OK (request was accepted and processed or queued for processing), otherwise the reason will be provided in Error header lines (or, if this is absent, HTTP error code should be used).


IMPORTANT: Every request (except "login") requires the presence of the Auth-Sid variable ("Session ID"), which is returned by the "login" request (login). An active session will expire after some inactivity period (default: 1 hour).


In case you are using a browser to access this service, the session id will be set as a cookie, hence need not to be specified as Auth-Sid (unless cookies are not supported or turned off). In any case, Auth-Sid has precedence, if provided.


Requests consist of these parts:

  • "Requires": Defines variables (sometimes referred to as 'fields') that MUST be present
  • "Accepts": Defines variables that MAY be present (but not required)
  • "Returns": Describes the request's output - header fields and extra data (if any). If "Returns" is omitted, then a standard reply should be expected (Status-Code, Status-Text, Proc-ID etc)


Tags: API, login, request, reseller

Related entries:

You cannot comment on this entry