| Info |
|---|
As of Q3 2015, the CIFER Project has been transitioned to the TIER-Data Structures and APIs Working Group. |
About the CIFER API Framework
These are uniform API conventions adopted by teams working across CIFER APIs. It provides a reference for current and future contributors to the set of CIFER APIs.
...
REST as Reference Style for CIFER API Framework
This framework references Representational State Transfer (REST), where a service is composed of an addressable set of resources. URLs are used to address resources and transitions of a resources state are accomplished by direct, stateless client interactions with these URLs.
...
example site directory
| Code Block |
|---|
{
"people": "/people",
"places": "/places",
"ciferMeta":{
"lastModified":"2012-11-04T09:57:03.541Z",
"baseUri":"https://example.u.edu/ppservice/v1/",
"responseTimestamp":"2013-07-04T09:57:03.541Z",
"httpStatusCode":200,
"responseTime":"P0.011S",
"serverVersion":"1.1"
}
}
|
example search resource
| Code Block |
|---|
{
[
{"uuid": "3ac85497-1663-4ef4-9933-3df8bc7800bc",
"lastName": "Doe",
"givenName": "John A.",
"address": { ... }
"status": "something",
"uri": "/v1/people/3ac85497-1663-4ef4-9933-3df8bc7800bc"
},
{"uuid": "3ac85497-1663-4ef4-9933-3df8bc7800cc",
"lastName": "Doe",
"givenName": "John B.",
"address": { ... }
"status": "something",
"uri": "/v1/people/3ac85497-1663-4ef4-9933-3df8bc7800cc"
},
],
"ciferMeta":{
"baseUri":"https://example.u.edu/ppservice",
"sortOrder":"a",
"pageLimit":100,
"pageOffset":0,
"sortField":"name",
"statusCode":"SUCCESS",
"responseTimestamp":"2013-07-04T09:57:03.541Z",
"httpStatusCode":200,
"responseTime":"P0.011S",
"serverVersion":"1.1"
}
}
|