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
  {PlanRestService.getPlan.param.vanityName}

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 
-u apicsadmin:password
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
Server: Oracle Traffic Director
Content-Length: 312
Date: Thu, 15 Feb 2018 15:48:41 GMT
Content-type: application/json
X-oracle-dms-ecid: a7070a18-e96d-4e69-a511-58eafd07a798-0000f83d
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",
            "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
}

Back to Top