plan_method.create

Description

Create a plan method  Please see Creating Objects for an overview of how the create 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_method

An plan_method object, as described by the object.describe call. If a field in the plan_method object is ommitted, a default value will be used if possible. If extra fields are passed, they will be ignored.

Response

An plan_method object, as described by the object.describe call. This is actual plan_method that was created.

Examples

A Sample JSON-RPC plan_method.create Request

{
    "method":"plan_method.create",
    "id":10,
    "params":[[{"plan":{"id":47},
    "service_definition_method":{"id":9},
    "rate_limit_ceiling":0,
    "rate_limit_exempt":false,
    "qps_limit_ceiling":0},{"plan":{"id":47},
    "service_definition_method":{"id":10},
    "rate_limit_ceiling":0,
    "rate_limit_exempt":false,
    "qps_limit_ceiling":0},{"plan":{"id":47},
    "service_definition_method":{"id":11},
    "rate_limit_ceiling":0,
    "rate_limit_exempt":false,
    "qps_limit_ceiling":0}]]
}

The JSON-RPC Response

{
"result": true,
"error": null,
"id": 1
}

Permissions Required

The user who owns the key used to authenticate the plan_method.create 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.
400	1001	Duplicate Object	The object could not be created because an object already exists with the same identifier.
400	1002	Field "x" is required.	The object could not be created because a required field was not specified.  A field marked false for optional was not specified.  The error object data will include the name of the missing field.
500	2001	Create Failed	The object could not be created.  This is the error message of last resort for object creation and usually indicates a systems integration failure, invalid internal data, or a transient issue.  These errors are logged by Mashery.
403	4200	This operation is not allowed for the service specified	The service specified does not allow key creation via the API.