Availability API

Overview

The Summon Availability API is a service that allows retrieval of catalog item availability statuses. The service allows batch requests for efficiency. This means only one service call is necessary for a page containing multiple catalog items. The Availability API is not an authenticated service. The response is available in following formats: XML, JSON and streaming JSON. Since availability status calls can take a relatively long time, the streaming JSON format allows availability statuses to appear on the page as soon as they are retrieved, even if there are still other statuses being retrieved. The combination of batch requests with streaming responses allows for a fairly responsive feel to the UI while tying up only one valuable browser thread.

URL

The base URL for the Availability API uses the following syntax, where <client_key> is a valid Summon client key:

http://api.summon.serialssolutions.com/availability/<client_key>

The Availability API will return availability statuses for the catalog items owned by the client identified by the given client key.