plan_endpoint.fetch
Description
Get a specific plan endpoint or a list of plan endpoints Please see Fetching Objects for an overview of how the fetch method works.
NOTE:This method is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.
Parameters
plan_endpoint id
An integer representing the unique id of the plan_endpoint to fetch. You may also pass a json object with a field of id to identify the plan_endpoint you wish to fetch.
Response
An plan_endpoint object, as described by the object.describe call. NULL is returned if the plan_endpoint could not be found.
Examples
A Sample JSON-RPC plan_endpoint.fetch Request
{ "method":"plan_endpoint.fetch", "id":25, "params":[88] }
The JSON-RPC Response
{ "result": true, "error": null, "id": 1 }
Permissions Required
The user who owns the key used to authenticate the plan_endpoint.fetch call must be a member of one of the following roles
- Administrator
- API Manager
See authentication.
Errors
In addition to the standard json-rpc errors and authentication errors, application.fetch may also return these errors:
HTTP Status Code | JSON-RPC Code | Error Message | Description |
---|---|---|---|
400 | 1002 | Field "id" is required | You've passed an object to trigger the alternative object identifier syntax, but that object does not contain an id field. |
Docs Navigation
- API Documentation Portal
- IO Docs Definition
- Mashery API Documentation
- Mashery 3.0 API Guide
- Mashery 2.0 API Guide
- OAuth Supporting Methods
- Examples
- JSON RPC
- Authentication
- API Objects
- Fetching Objects
- Query Language
- Creating Objects
- Updating Objects
- Validating Fields
- Deleting Objects
- Applications
- General Object Methods
- Members
- Packages
- Plans
- Package Keys
- Keys
- Developer Classes
- Services
- Roles
- Mashery 2.0 Reporting API Guide
- Event Trigger API
- Differences between Roles and Portal Access Groups
- Managing a Portal Access Group Using Mashery V2 or V3 API
- Mashery Reporting Event Post API Guide
- Tips and Tricks
- Your Portal
- API Traffic Manager
- I/O Docs WSDL requirements