• Register

application.create

Description

Create a single application object.  Please see Creating Objects for an overview of how the create method works.

Parameters

application

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

Response

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

Examples

A Sample JSON-RPC Application Create Request

{
    "method": "application.create",
    "params": [
        {
            "name": "example_application_name",
            "member": {
                "username": "example_username" 
            } 
        } 
    ],
    "id": 1
}

The JSON-RPC Response

{
    "result": {
        "id": 1234,
        "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.create 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.create 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 Objects 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.

version 3 as of 13 years ago by Eric Delore

Docs Navigation