Jump to

• Request
• Response
• Examples

Get details for a plan

get

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

Returns details about the {planId} plan.

All authenticated users can request this resource. Only details for plans that the user is issued the Register Application, Request Register Application or View Public Details plan grant for are returned.

Request

Path Parameters

• vanityName: string
  The vanity name of the plan.

Back to Top

Response

Supported Media Types

• application/json

200 Response

JSON structure with details for the plan.

Body ()

Root Schema : Plan

Type: object

400 Response

Bad request: indicates a problem with the input parameters.

401 Response

Authentication required.

500 Response

Server error.

Back to Top

Examples

The following example shows how to retrieve details of a plan for the given {vanityName} 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/plans/{vanityName}

{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
Content-Length: 7537
Date: Wed, 23 May 2018 04:22:09 GMT
Content-type: application/json
X-oracle-dms-ecid: 585fdc37-bd3c-4713-890e-282f963e56ac-000031f6
X-oracle-dms-rid: 0:1

Example of Response Body

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

{
    "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": [
                {
                    "method": "DELETE",
                    "templated": "true",
                    "rel": "unsubscribe",
                    "href": "http://example.com:443/developers/services/v1/plans/100/subscriptions/100"
                }
            ],
            "id": 101,
            "state": "SUBSCRIBED"
        }
    ],
    "publicationSettings": {
        "icon": {
            "displayed": true
        },
        "description": {
            "displayed": true
        },
        "constraints": {
            "rate": {
                "invocations": {
                    "displayed": true,
                    "displayText": ""
                }
            }
        },
        "recommended": true
    },
    "icon": "data:image/png;base64,=",
    "name": "Real Estate Gold",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ac vestibulum velit.",
    "links": [
        {
            "method": "POST",
            "templated": "true",
            "rel": "subscribe",
            "href": "http://example.com:443/developers/services/v1/plans/100/subscriptions"
        },
        {
            "method": "POST",
            "templated": "true",
            "rel": "request",
            "href": "http://example.com:443/developers/services/v1/plans/100/subscriptions"
        },
        {
            "method": "DELETE",
            "templated": "true",
            "rel": "unsubscribe",
            "href": "http://example.com:443/developers/services/v1/plans/100/subscriptions/subscriptionId"
        }
    ],
    "id": 100,
    "state": "ACTIVE",
    "constraints": {
        "rate": {
            "invocations": [
                {
                    "period": "Day",
                    "limit": "100000"
                },
                {
                    "period": "Minute",
                    "limit": "1000"
                }
            ]
        }
    },
    "version": "1.0"
}

Back to Top