package_key.fetch

Description

Get a specific package key or a list of package keys  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

package_key id

An integer representing the unique id of the package_key to fetch.  You may also pass a json object with a field of id to identify the package_key you wish to fetch.

Response

An package_key object, as described by the object.describe call. NULL is returned if the package_key could not be found.

Examples

A Sample JSON-RPC package_key.fetch Request

{
    "method":"package_key.fetch",
    "id":28,
    "params":[35]
}

The JSON-RPC Response

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

Permissions Required

The user who owns the key used to authenticate the package_key.fetch 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: