package_key.validate

Description

Validate a package key  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

package_key

A partial package_key object, as described by the object.describe call. If a field in the package_key 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 package_key.validate Request

{
    "method":"package_key.validate",
    "id":44,
    "params":[{"id":35,
    "plan":{"id":47},
    "qps_limit_exempt":false,
    "qps_limit_ceiling":4,
    "rate_limit_exempt":false,
    "rate_limit_ceiling":500}]
}

The JSON-RPC Response

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

Permissions Required

The user who owns the key used to authenticate the package_key.validate call must be a member of one of the following roles

•  
  • Administrator
  • Program Manager
  • Community Manager

See authentication.

Errors

In addition to the standard json-rpc errors and authentication errors, application.fetch may also return these errors: