StackMap  API  Specification  Version  2.0  

StackMap  REST  API  Specification   Version  3.0,  August  12,  2012  

Description   This  document  outlines  a  protocol  for  communicating  with  the  StackMap  library  mapping  system  to  be   used  by  third-­‐party  systems.    This  protocol  allows  a  third-­‐party  system  to  query  StackMap  for   information  regarding  the  location  of  holdings,  which  the  API  returns  in  the  specified  format.    Any   questions  regarding  this  document  should  be  sent  to  [email protected].  

Overview   The  StackMap  API  allows  a  system  to  query  StackMap’s  database  to  retrieve  range  maps  and   information.    The  system  accepts  queries  for  one  or  more  holding  records,  and  returns  the  data   associated  with  each  one  in  the  format  below.    The  data  is  designed  to  give  a  third-­‐party  system  all  the   information  it  needs  to  construct  a  client-­‐side  interface  similar  to  the  one  available  within  StackMap.  

Technical  Specification   Request  URL   All  requests  to  the  API  are  HTTP  POST  requests  to  http://your-­‐,  where  your-­‐ domain  is  the  specific  StackMap  installation  for  your  library.      

POST  Data   The  POST  request  consists  of  an  XML  document  containing  the  requested  nodes.    Each  node  type  is   described  below.   Search   The  search  node  is  the  root  of  the  document   §

Attributes o


version,  a  string  corresponding  to  the  API  version  requested.    This  document  uses   version=”2.0”

Child  Nodes   o One  or  more    nodes.  

Holding   A  node  describing  a  holding  record  to  search  for   §

Attributes   o None  



StackMap  API  Specification  Version  2.0   §

Child  Nodes   o One    node   o One    node  

CallNo   A  node  describing  a  call  number   § §

Attributes   o None   Child  Nodes   o The  text  of  the  call  number  for  the  holding  

Location   A  unique  field  used  by  StackMap  to  determine  the  general  location  of  the  holding.    This  may  be  a  library   name  or  ID  number,  as  well  as  a  floor  name.    Consult  the  StackMap  team  for  more  information  on  this   field.   § §

Attributes   o None   Child  Nodes   o The  text  of  the  location  for  the  holding  

Library   A  node  with  the  name  of  the  library  to  search  for  the  holding   § §

Attributes   o None   Child  Nodes   o The  text  of  the  library  for  the  holding  

Request  Example   An  example  request  is  given  below:   ABC STACKS LIBRARY ...Holding 2 data... ...More Holdings...



StackMap  API  Specification  Version  2.0   The  search  node  represents  the  root  of  the  request.    Each  holding  request  is  a  single  child  of  this  root   search  node.    The  holding  requests  contain  two  fields  each,  callno  and  location  representing  the   information  for  that  holding.  

Response  Specification   The  response  from  the  StackMap  server  is  an  XML  document  which  contains  the  information  about  the   requested  holdings.    Each  response  node  type  is  described  below.   Holdings   The  holdings  node  is  the  root  of  the  document   §

Attributes o


version,  a  string  corresponding  to  the  API  version  requested.    This  document  uses   version=”2.0”

Child  Nodes   o One  or  more    nodes.  

Holding   The  holding  node  corresponds  to  a  holding  node  from  the  original  request.   §


Attributes o None. Child  Nodes   o One    node.   o One    node.   o One    node.   o One   node.   o One    node.  

CallNo   A  node  describing  a  call  number   § §

Attributes   o None   Child  Nodes   o The  text  of  the  call  number  for  the  holding  

Library   A  node  describing  a  library   § §

Attributes   o None   Child  Nodes   o The  text  of  the  library  for  the  holding  



StackMap  API  Specification  Version  2.0   Location   A  node  describing  a  location   § §

Attributes   o None   Child  Nodes   o The  text  of  the  location  for  the  holding  

Notes   A  node  containing  general  notes  about  the  given  map   § §

Attributes   o None   Child  Nodes   o A  string,  notes  about  the  floor.    Note  that  this  string  may  contain  HTML,  so  it  will  always   be  encapsulated  as      

Maps   A  node  describing  all  the  maps  associated  with  the  holding   § §

Attributes   o None   Child  Nodes   o One  or  more    nodes.  

Map   A  node  describing  a  single  map  associated  with  the  holding.   § §

Attributes   o None   Child  Nodes   o One    node   o One    node   o One    node   o One    node  

Floorname   A  node  naming  the  floor  for  the  given  map   § §

Attributes   o None   Child  Nodes   o The  text  containing  the  name  of  the  floor    



StackMap  API  Specification  Version  2.0   Mapurl   A  node  containing  the  URL  of  the  map  image  for  the  given  map   § §

Attributes   o None   Child  Nodes   o A  string,  the  URL  to  the  image  for  the  given  map.  For  markers  drawn  into  the  map,   append  “&marker=1”  to  the  end  of  this  string  

Directions   A  node  containing  directions  to  the  floor  for  the  given  map   § §

Attributes   o None   Child  Nodes   o A  string,  directions  to  the  floor.    Note  that  this  string  may  contain  HTML,  so  it  will  always   be  encapsulated  as      

Ranges   A  node  containing  the  collection  of  ranges  where  the  holding  appears  on  the  given  map   § §

Attributes   o None   Child  Nodes   o One  or  more  Range  nodes  

Range   A  node  describing  a  single  range  for  a  given  map   §


Attributes   o x:  A  decimal,  the  x  position  of  the  center  of  the  range  on  the  map,  in  pixels o y:  A  decimal,  the  y  position  of  the  center  of  the  range  on  the  map,  in  pixels Child  Nodes     o One    node     o One    node     o One    node     o One    node     o One   ... ... ... ... ...
... ...
...Holding 2 data... ...More Holdings...



StackMap API Specification - GitHub

domain is the specific StackMap installation for your library. POST Data. The POST ... A node with the name of the library to search for the holding. ▫ Attributes.

122KB Sizes 11 Downloads 358 Views

Recommend Documents

StackMap JSON API Specification - GitHub
o The text of the call number of the holding. ▫ “library” o The text ... o An decimal, the x position of the center of the range on the map, in pixels. ▫ “y” o An decimal ...

CarrotPay API Specification
For HTTP pages: ​ ​ ..... the purse id (without displaying), if known OR display login and return.

API - GitHub
Dec 5, 2014 - • ... Slim ... Page 24 ...

Devicetree Specification - GitHub
Apr 30, 2016 - Companies ... A piece of software may be both a client program and a boot ..... defined by the DTSpec. 2.2. Devicetree Structure and Conventions. 10 ...... dtc-paper.pdf), An overview of the concept of the device tree and device ...

Architectural Requirements Specification - GitHub
cumbersome tool to have to port to mobile application clients. 4. Page 7. Description of Components .1 Odin-CLI .1.1 Technologies. The command line interface will be implemented in Python 3, using built-in classes and libraries to provide a usable in

System Requirements Specification - GitHub
This section describes the scope of Project Odin, as well as an overview of the contents of the SRS doc- ument. ... .1 Purpose. The purpose of this document is to provide a thorough description of the requirements for Project Odin. .... Variables. â€

Architectural Requirements Specification - GitHub
porchetta tri-tip kielbasa kevin chicken hamburger sirloin. Cow pastrami short ribs shank. Sirloin spare ribs jowl, beef ham hock kielbasa ribeye prosciutto cow. Capicola pork chop landjaeger jowl venison beef ribs sirloin tri-tip tenderloin pastrami

System Requirements Specification - GitHub
System Requirements Specification. Project Odin. Kyle Erwin. Joshua Cilliers. Jason van Hattum. Dimpho Mahoko. Keegan Ferrett. Note: This document is constantly under revision due to our chosen methodology, ... This section describes the scope of Pro

Orc Protocol Specification - GitHub
Jun 7, 2017 - RPC message format changed (4.1 Structure and Authentication). • New CLAIM .... signature to authenticate the payload. Positions 3 and ..... Kademlia ( • S/Kademlia ...

Orc Protocol Specification - GitHub
Aug 15, 2017 - This specification documents the Orc network protocol in its entirety for the purpose of enabling .... services and authentication is performed by the nature of Tor's routing. Each Orc node ... associated with held contracts (5. Data T

Requirement Specification - GitHub
The former one focuses on understanding and stating ... Controller Area Network ... Clearly, the services of DIL can be categorized in two groups, one bus the ...

BamTools API Tutorial - GitHub
Mar 23, 2011 - ... adjust how your app locates the shared library at runtime.

ActionScript® 4.0 Language Specification - GitHub
Dec 13, 2012 - Computer Software Documentation,'' as such terms are used in 48 C.F.R. §12.212 ... Dec 5 2012 Added syntactic support for variable-length unicode escape ...... 365. Expression. 366. ReferenceExpression = Expression. 367.

Commands for EV3-API - GitHub
char. Color of text. 1: black text. 0: wihteteext with black background. .... LED color cannot be changed while warning is set. ... (1: true, 0: false).

Sliceable Network Management API - GitHub
virtualizing all layer 2 functions the API distributes resource management such ... can be categorized as Infrastructure as a Service (IaaS) in the cloud computing.

Google Code-in Task API Specification Developers ... A Python API client and example code is available at .... "task_definition_name": "Write a test case.",.

Hypervisor Top Level Functional Specification - GitHub
100. HvSendSyntheticClusterIpiEx . ...... That is, the hypervisor is free to deliver the interrupt ..... When a message is sent, the hypervisor selects a free message buffer. ...... The Flags field included an invalid mask value in the proximity doma

Specification on Image Data File Version - GitHub
5.4.10 ShootingRecord heap ... the JFIF file format[1], as described below), sample software shall be provided openly to player vendors. ... In the separate "Decisions Concerning Extension" section, we define how various companies.

Anonymous Go-Kart: Specification Report Supervisor - GitHub
May 9, 2011 - [email protected] (83238549). Wim Looman ... Department of Computer and Electrical Engineering. University of ... kart, so that it can be easily controlled by a laptop. The second is to ..... BostonDynamicsTRQ6Sep09.pdf.

Chatter REST API Developer Overview - GitHub
Building an application outside the Salesforce platform. • Pull feed and social graph out into another application. • Push notifications and activity into the feed.

LERUKA LERUKA UseCase Specification: View public ... - GitHub
UseCase Name. Brief Description. Mockup. Flow of Events. Basic Flow. Narration. Alternative Flows. Special Requirements. Preconditions. Postconditions.

Cosmos​​IBC​​Specification - GitHub
access​​to​​only​​part​​of​​the​​state​​space.​​This​​can​​increase​​throughput,​​but​​also makes​​any​​transaction​​that​​touches​​multiple​​shards​​extremely​​diffi

The Quick Chart File Format Specification 1.01.pdf - GitHub
Page 1. The Quick Chart (.QCT). File Format Specification. Revision 1.01. 07 MAR 2009. Craig Shelley [email protected]. Disclaimer. THIS DOCUMENT ...

Zcash Protocol Specification, Version 2017.0-beta-2.7 - GitHub
T. The domain of a randomized algorithm may be (), indicating that it requires no ...... 32. 100. PoWMaxAdjustUp ◦. ◦ Q := 16. 100. PoWDampingFactor ◦. ◦ N := 4 .... The language consisting of the following encoding possibilities is pre x-fre