plan_filter.validate
Description
Validate a plan filter Please see Updating Objects for an overview of how the update 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_filter
A partial plan_filter object, as described by the object.describe call. If a field in the plan_filter object is ommitted, no validation will be peformed for that field. If extra fields are passed, they will be ignored.
Response
TRUE is returned if all fields are valid, otherwise, an invalid object error object is returned.
Examples
A Sample JSON-RPC plan_filter.validate Request
{ "method":"plan_filter.validate", "id":51, "params":[[{"plan":{"id":47}, "plan_method":{"id":168}, "response_filter":{"id":5}, "service_definition_method":{"id":9}}]] }
The JSON-RPC Response
{ "result": true, "error": null, "id": 1 }
Permissions Required
The user who owns the key used to authenticate the plan_filter.validate 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 | 1000 | Invalid Object | The object could not be created because the object would be invalid. See Validating Fields for details on the format of this error. |
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