Cisco Cisco Prime Home 5.0 Developer's Guide
Cisco Prime Home – Integration Guide
OL-28557-01 v5.0.1
13
API Standards
All APIs found under the /api URI, will follow these standards.
URIs
• The root of all APIs is http://host/prime-home/api/
• Resources are versioned. the version immediately follows .../api. e.g.:
.../api/v1
• Versions are determined by the structure of the representation
• If the resource name is plural, it should be treated as a list / table of
contents. e.g.: .../api/v1/subscribers
Tables of Contents
A Table of Contents is used to find some sub-ordinate resource to work with.
You can also create new items by posting to a Table of Contents.
GET
• request uri query ?filter=<string>; Provide this parameter as a search
query to refine your results.
• request uri query ?first=<number>; Which item in the results to return
first, beginning with 1.
• request uri query ?count=<number>; How many items from the results to
return.
The maximum count handled is 1000. If you request more, then the results will
be limited to this maximum.
• response header Pagination-First: <number>; The actual first item
returned.
• response header Pagination-Count: <number>; The actual number of
items returned.
• response header Pagination-Total: <number>; The total number of items
in the entire result set.
POST to append
DELETE not supported
Documents
Document services will behave as follows:
• GET will return the full representation of the resource
• DELETE will remove the resource from the system
• PUT accepts a new representation
• When a document is sent from the server to the client, it includes a
'revision' property. This value must be returned to the server when
making changes. If the revision on the server is different at the time of
the update, an error status will be returned to the user, and the state of
the resource will be unchanged.