Jump to

• Request
• Response
• Examples

Get API's plans

get

/developers/services/v1/apis/{vanityName}/plans

Returns all the plans for the given API the requesting user is authorized to view.

All authenticated users can request this resource.

Request

Path Parameters

• vanityName: string
  An API's unique vanity name. This is the URI path of the details page for the API on the Developer Portal (like https://example.com/developers/apis/weatherService.

Back to Top

Response

Supported Media Types

• application/json

200 Response

JSON structure with list of all the viewable plans for the API.

Body ()

Root Schema : PlanCollectionResponse

Type: object

HATEOAS 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 null by default.
• hasMore(optional): boolean
  Default Value: false

  Indicates 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 null by default.
• totalResults(optional): integer(int32)
  Response item count (excluding the paging parameters).

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Response item count (excluding the paging parameters)."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"Paging offset."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Item count in this response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Paging limit."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more results after the current batch.",
            "default":false
        },
        "links":{
            "type":"array",
            "description":"HATEOAS links.",
            "items":{
                "$ref":"#/definitions/GenericLink"
            }
        },
        "filters":{
            "type":"array",
            "description":"List of filters applicable for the current API list. This is <code>null</code> by default.",
            "items":{
                "type":"string"
            }
        },
        "items":{
            "type":"array",
            "description":"Actual response items.",
            "items":{
                "$ref":"#/definitions/Plan"
            }
        },
        "states":{
            "type":"array",
            "description":"Optional list of API states. This is <code>null</code> by default.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"HATEOAS plan collection response representation."
}

Nested Schema : filters

Type: array

List of filters applicable for the current API list. This is null by default.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of filters applicable for the current API list. This is <code>null</code> by default.",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Actual response items.

Show Source

• Array of: object Plan

{
    "type":"array",
    "description":"Actual response items.",
    "items":{
        "$ref":"#/definitions/Plan"
    }
}

Nested Schema : links

Type: array

HATEOAS links.

Show Source

• Array of: object GenericLink
  HATEOAS generic link representation.

{
    "type":"array",
    "description":"HATEOAS links.",
    "items":{
        "$ref":"#/definitions/GenericLink"
    }
}

Nested Schema : states

Type: array

Optional list of API states. This is null by default.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Optional list of API states. This is <code>null</code> by default.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Plan

Type: object

Nested Schema : GenericLink

Type: object

HATEOAS 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 canonical or a specific string value.
• templated(optional): string
  Allowed Values: [ "true", "false" ]

  Indicates if the link has templated parts.

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "templated":{
            "type":"string",
            "description":"Indicates if the link has templated parts.",
            "enum":[
                "true",
                "false"
            ]
        },
        "method":{
            "type":"string",
            "description":"HTTP method used with the link."
        },
        "rel":{
            "type":"string",
            "description":"Link relation string Value is either <code>canonical</code> or a specific string value."
        },
        "href":{
            "type":"string",
            "description":"Link reference string."
        }
    },
    "description":"HATEOAS generic link representation."
}

400 Response

Bad request: indicates a problem with the input parameters.

401 Response

Authentication required.

404 Response

Not found.

500 Response

Server error.

Back to Top

Examples

The following example shows how to retrieve all the plans for the given {vanityName} API published to the Developer Portal 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/apis/{vanityName}/plans

{vanityName} is an API's unique vanity name. This is the URI path of the details page for the API on the Developer Portal (like https://example.com/developers/apis/weatherService, see Get APIs.

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle Traffic Director
Content-Length: 7275
Date: Thu, 15 Feb 2018 14:27:50 GMT
Content-type: application/json
X-oracle-dms-ecid: a7070a18-e96d-4e69-a511-58eafd07a798-0000f808
X-oracle-dms-rid: 0:1

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "totalResults": 2,
    "count": 2,
    "hasMore": false,
    "items": [
        {
            "entitlements": [
                {
                    "vanityName": "geo",
                    "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": "allied1",
                    "entitlementId": 100,
                    "name": "Allied Mortgage Calculator",
                    "description": "Fast and easy real estate mortgage payment calculator",
                    "id": 100,
                    "state": "ACTIVE",
                    "version": "1.0"
                },
                {
                    "vanityName": "concur",
                    "entitlementId": 102,
                    "name": "Concur Real Estate Price Comparision",
                    "description": "Compare real estate prices from multiple realtors and multiple markets simultanously",
                    "id": 102,
                    "state": "ACTIVE",
                    "constraints": {
                        "rate": {
                            "invocations": [
                                {
                                    "period": "Day",
                                    "limit": "200000"
                                },
                                {
                                    "period": "Month",
                                    "limit": "5000000"
                                }
                            ]
                        }
                    },
                    "version": "1.0"
                },
                {
                    "vanityName": "energy",
                    "entitlementId": 112,
                    "name": "Energy",
                    "description": "Energy consumption services",
                    "id": 105,
                    "state": "ACTIVE",
                    "version": "1.0"
                }
            ],
            "vanityName": "real",
            "subscriptions": [
                {
                    "name": "World Weather",
                    "id": 101
                },
                {
                    "name": "Temperature",
                    "id": 105
                },
                {
                    "name": "Allied Mortgage Calculator",
                    "id": 104
                },
                {
                    "name": "New",
                    "id": 110
                }
            ],
            "publicationSettings": {
                "icon": {
                    "displayed": true
                },
                "description": {
                    "displayed": true
                },
                "constraints": {
                    "rate": {
                        "invocations": {
                            "displayed": true,
                            "displayText": ""
                        }
                    }
                },
                "recommended": true
            },
            "icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAIAAAC1nk4lAAAABnRSTlMA/6PnjvRcSQRYQD6AOXgKCGNIqgJRFs+syq5kboPUeN5JBsZkG0hxWzj6oMCoAFWc5y4DUJUTMjIAAys3NGla9vV+wxvrHmowCgYBCBVVW8A9p3Pf8HRevgGV2WhT8AAAAASUVORK5CYII=",
            "name": "Real Estate Gold",
            "description": "Allows for high usage.",
            "id": 100,
            "type": "plan"
        },
        {
            "entitlements": [
                {
                    "vanityName": "allied1",
                    "entitlementId": 110,
                    "name": "Allied Mortgage Calculator",
                    "description": "Fast and easy real estate mortgage payment calculator",
                    "id": 100,
                    "state": "ACTIVE",
                    "version": "1.0"
                }
            ],
            "vanityName": "GoldMy",
            "subscriptions": [
                {
                    "name": "Subscribeplan",
                    "id": 108
                }
            ],
            "name": "Goldplan",
            "id": 107,
            "type": "plan"
        }
    ]
}

Back to Top