Get plans
get
/developers/services/v1/plans
All authenticated users can request this resource. Only published plans that the user is issued the Plan View Public Details, Plan Subscribe Application or Plan Request Subscribe Application grant for are returned.
Request
Query Parameters
-
limit(optional): integer(int32)
Requested limit for the results list.Default Value:
0 -
offset(optional): integer(int32)
Requested offset in the results list.
- orderBy(optional): array
-
q(optional): string
Filter query parameter.
Response
Supported Media Types
- application/json
200 Response
JSON structure with list of all plans.
Root Schema : PlanCollectionResponse
Type:
objectHATEOAS plan collection response representation.
Show Source
-
count(optional):
integer(int32)
Item count in this response.
-
filters(optional):
array filters
List of filters applicable for the current API list. This is
nullby default. -
hasMore(optional):
boolean
Default Value:
falseIndicates if there are more results after the current batch. -
items:
array items
Actual response items.
-
limit(optional):
integer(int32)
Paging limit.
-
links(optional):
array links
HATEOAS links.
-
offset(optional):
integer(int32)
Paging offset.
-
states(optional):
array states
Optional list of API states. This is
nullby default. -
totalResults(optional):
integer(int32)
Response item count (excluding the paging parameters).
Nested Schema : filters
Type:
arrayList of filters applicable for the current API list. This is
Show Source
null by default.Nested Schema : links
Type:
arrayHATEOAS links.
Show Source
-
Array of:
object GenericLink
HATEOAS generic link representation.
Nested Schema : states
Type:
arrayOptional list of API states. This is
Show Source
null by default.Nested Schema : Plan
Type:
objectNested Schema : GenericLink
Type:
objectHATEOAS generic link representation.
Show Source
-
href:
string
Link reference string.
-
method(optional):
string
HTTP method used with the link.
-
rel:
string
Link relation string Value is either
canonicalor a specific string value. -
templated(optional):
string
Allowed Values:
[ "true", "false" ]Indicates if the link has templated parts.
400 Response
Bad request: indicates a problem with the input parameters.
401 Response
Authentication required.
500 Response
Server error.
Examples
The following example shows how to retrieve all the plans by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X GET
-H "Authorization: Bearer access_token
https://example.com:443/developers/services/v1/plans
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Date: Tue, 22 May 2018 02:51:30 GMT Content-type: application/json X-oracle-dms-ecid: 585fdc37-bd3c-4713-890e-282f963e56ac-0000278e X-oracle-dms-rid: 0:1
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"totalResults": 4,
"offset": 0,
"count": 4,
"hasMore": false,
"limit": 0,
"links": [
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans"
}
],
"items": [
{
"entitlements": [
{
"vanityName": "allied1",
"endpoints": [],
"entitlementId": 100,
"name": "Allied Mortgage Calculator",
"description": "Fast and easy real estate mortgage payment calculator",
"id": 100,
"state": "ACTIVE",
"version": "1.0"
},
{
"vanityName": "concur",
"endpoints": [],
"entitlementId": 102,
"name": "Concur Real Estate Price Comparision",
"description": "Compare real estate prices from multiple realtors and multiple markets",
"id": 102,
"state": "ACTIVE",
"constraints": {
"rate": {
"invocations": [
{
"period": "Day",
"limit": "200000"
},
{
"period": "Month",
"limit": "5000000"
}
]
}
},
"version": "1.0"
},
{
"vanityName": "geo",
"endpoints": [],
"entitlementId": 103,
"name": "GeoServices",
"description": "Mapping, Routing & Navigation Services",
"id": 103,
"state": "ACTIVE",
"constraints": {
"rate": {
"invocations": [
{
"period": "Day",
"limit": "10000"
},
{
"period": "Week",
"limit": "30000"
}
]
}
},
"version": "3.0"
}
],
"vanityName": "real",
"subscriptions": [
{
"name": "Western Real Estate",
"links": [],
"id": 101,
"state": "SUBSCRIBED"
}
],
"icon": "data:image/png;base64=",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ac vestibulum velit.",
"type": "plan",
"constraints": {
"rate": {
"invocations": [
{
"period": "Day",
"limit": "100000"
},
{
"period": "Minute",
"limit": "1000"
}
]
}
},
"version": "1.0",
"publicationSettings": {
"icon": {
"displayed": true
},
"description": {
"displayed": true
},
"constraints": {
"rate": {
"invocations": {
"displayed": true,
"displayText": ""
}
}
},
"recommended": true
},
"name": "Real Estate Gold",
"links": [
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans"
},
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans/real"
}
],
"id": 100,
"state": "ACTIVE"
},
{
"entitlements": [
{
"vanityName": "geo",
"endpoints": [],
"entitlementId": 104,
"name": "GeoServices",
"description": "Mapping, Routing & Navigation Services",
"id": 103,
"state": "ACTIVE",
"version": "3.0"
},
{
"vanityName": "usweather",
"endpoints": [],
"entitlementId": 105,
"name": "United States Weather",
"description": "U.S. weather conditions services",
"id": 104,
"state": "ACTIVE",
"version": "1.0"
}
],
"vanityName": "weather",
"subscriptions": [
{
"name": "World Weather",
"links": [],
"id": 100,
"state": "SUBSCRIBED"
}
],
"icon": "data:image/png;base64=",
"description": "Nullam leo metus, pharetra eget malesuada quis, aliquam id velit. Phasellus eu pretium neque.",
"type": "plan",
"constraints": {
"rate": {
"invocations": [
{
"period": "Day",
"limit": "30000"
},
{
"period": "Minute",
"limit": "850"
}
]
}
},
"version": "1.0",
"publicationSettings": {
"icon": {
"displayed": true
},
"description": {
"displayed": true
},
"constraints": {
"rate": {
"invocations": {
"displayed": true,
"displayText": ""
}
}
},
"recommended": false
},
"name": "Weather Gold",
"links": [
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans"
},
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans/weather"
}
],
"id": 101,
"state": "ACTIVE"
},
{
"entitlements": [
{
"vanityName": "energy",
"endpoints": [],
"entitlementId": 106,
"name": "Energy",
"description": "Energy consumption services",
"id": 105,
"state": "ACTIVE",
"version": "1.0"
}
],
"vanityName": "energy",
"subscriptions": [
{
"name": "Western Real Estate",
"links": [],
"id": 101,
"state": "SUBSCRIBED"
}
],
"icon": "data:image/png;base64=",
"description": "Egestas dui id ornare arcu odio. In iaculis nunc sed augue lacus viverra vitae congue.",
"type": "plan",
"constraints": {
"rate": {
"invocations": [
{
"period": "Hour",
"limit": "45000"
},
{
"period": "Minute",
"limit": "1500"
}
]
}
},
"version": "1.0",
"publicationSettings": {
"icon": {
"displayed": true
},
"description": {
"displayed": true
},
"constraints": {
"rate": {
"invocations": {
"displayed": true,
"displayText": ""
}
}
},
"recommended": false
},
"name": "Energy Supreme",
"links": [
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans"
},
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans/energy"
}
],
"id": 102,
"state": "ACTIVE"
},
{
"entitlements": [
{
"vanityName": "concur",
"endpoints": [],
"entitlementId": 107,
"name": "Concur Real Estate Price Comparision",
"description": "Compare real estate prices from multiple realtors and multiple markets simultanously",
"id": 102,
"state": "ACTIVE",
"version": "1.0"
},
{
"vanityName": "geo",
"endpoints": [],
"entitlementId": 108,
"name": "GeoServices",
"description": "Mapping, Routing & Navigation Services",
"id": 103,
"state": "ACTIVE",
"version": "3.0"
}
],
"overview": {
"data": "This is a sample description file in simple HTML format.",
"docType": "html",
"dataType": "file"
},
"vanityName": "free",
"subscriptions": [],
"publicationSettings": {
"icon": {
"displayed": true
},
"description": {
"displayed": true
},
"constraints": {
"rate": {
"invocations": {
"displayed": true,
"displayText": ""
}
}
},
"recommended": true
},
"name": "Everything Free",
"description": "All stuff is free here.",
"links": [
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans"
},
{
"method": "GET",
"templated": "true",
"rel": "canonical",
"href": "http://example.com:443/developers/services/v1/plans/free"
}
],
"id": 103,
"state": "ACTIVE",
"type": "plan",
"version": "1.0"
}
]
}