application.fetch
Description
Fetch a single application object. Please see Fetching Objects for an overview of how the fetch method works.
Parameters
application id
An integer representing the unique id of the application to fetch. You may also pass a json object with a field of id to identify the application you wish to fetch.
Response
An application object, as described by the object.describe call. NULL is returned if the member could not be found.
Examples
A Sample JSON-RPC Application Fetch Request
{ "method": "application.fetch", "params": [1234], "id": 1 }
The JSON-RPC Response
{ "result": { "id": 1234, "uuid": "124124sfsfsdfsdfsdfsdfsdf", "created": "2009-12-11T00:25:45Z", "updated": "2009-12-11T00:25:45Z", "username": "example_username", "name": "example_application_name", "description": "", "type": "", "commercial": false, "ads": false, "ads_system": "", "usage_model": "", "notes": "", "how_did_you_hear": "", "preferred_protocol": "", "preferred_output": "", "external_id": "", "uri": "", "status": "draft", "object_type": "application" }, "error": null, "id": 1 }
Permissions Required
The user who owns the key used to authenticate the application.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:
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