JUMP Responses

Responses contain a set of properties whose values are in JSON format, with the possible exception of the response property. This includes:

General information about the request for this response, such as the serviced ID (sid), operation ID (oid), JUMP version (version), svcVersion (reserved for future use) and invocation ID (invId). For example:

{ "sid":"RDSService",
"oid":"getAllServiceTypes",
"svcVersion":"0.1",
"invId":"",
"version":"1.0",
...}

User, session and optional headers in the header property. For example:

{ "sid":"RDSService",
...
"header":{
"map":{
"currentUser":"admin",
"sessionTimeout":"1800",
"serviceHeader":{
"map":{}
}
}
},
...}

The header property is an object with a map property which is also an object that contains currentUser, sessionTimeout and optional properties.

If the request was for an authenticated user, currentUser contains the username for this session. If the request was anonymous, or the current session for the user has timed out, currentUser is anonymousUser.

The sessionTimeout property contains the number of seconds until this session expires. Subsequent requests for authenticated or anonymous users extend the session.

Optional JUMP response headers may include headers returned from a mashable, pagination tokens or other information requested from the Business Analytics Server. See Business Analytics Headers/Parameters for a complete list.

Response data in the response property if the invocation was successful. The mashable or API response may be in JSON format (by default), in XML or in a native format for this mashable. An optional JUMP header in the request can choose another format. For example:

{ "sid":"RDSService",
...
"error":"",
"errorCode":"",
"response":[ { "type":"EXCEL", "label":"EXCEL" },
{ "type":"REST", "label":"REST" },
{ "type":"WSDL", "label":"WSDL" },
{ "type":"MASHUP", "label":"MASHUP" },
{ "type":"RSS\/Atom", "label":"RSS\/Atom" },
{ "type":"DAO", "label":"DAO" } ]
}

Error information if the request failed or the service invocation failed. This includes the error message (error) from the platform API, mashable, mashup or from Business Analytics and an error code (errorCode) from Business Analytics, if the request failed in Business Analytics. These properties are null or empty if the response property has content.

{
"sid":"HelloWorldService",
"appId":"",
"oid":"sayHello1",
"svcVersion":"0.1",
"error":"Failed to handle given request. Error = Unable to find service using (HelloWorldService)",
"errorCode":"",
"invId":"",
"response":"",
"version":"1.0"
}