3. Call anatomy

Call Anatomy

Purpose

This page describes the JSON formatted object returned by calls to the API.

Summary of return structure

The client sends an http request to the server. The server services the call and returns a JSON formatted stream of data with the following fields:

o
 \
  +--- API
  |       |
  |       +--- APIcall: "text string: API call as seen by client"
  |
  +--- return
  |       |
  |       +--- status: True|False (boolean)
  |       |
  |       +--- payload: {dictionary of call specific results}
  |       |         
  |       +--- URL_PUT: [list of PUT URLs from this context]
  |       |
  |       +--- URL_GET: [list of GET URLs from this context]
  |
  +--- auth
  |       |
  |       +--- status: True|False (boolean)
  |       |
  |       +--- authInfo: {dictionary of authorization information}
  |       |
  |       +--- message: "text message"
  |
  +--- server
          |
          +--- URI: "text URI of server -- can be combined with URL_GET/URL_PUT and {auth} to create valid calls"
          |
          +--- APIversion: "text of called API version"

Detail on return structure

API

The API field echoes back to the client the received API call.

return

The return field contains information that the server has processed based on the client call. It contains the following sub-fields:

status

The boolean return status of the call.

payload

The call-specific information returned.

URL_GET

A list of valid GET URLs from this context.

URL_PUT

A list of valid PUT URLs from this context.

auth

A module containing authorization information used to create per-call hashes between client and server.

server

Information about the server, used in conjunction with URL_GET and URL_PUT to create REST API calls from this context.