Packages

Resource URI

/packages/{packageId}

Items in curly braces represent variables.

Description

A package object stores data for limit-based notifications, e.g. sending an email to a developer when they near their quota usage, as well as an array of plans. Packages are a collection of plans which in turn are a collection of services, endpoints and methods that ultimately can be used by a developer.

Resource Schema

fetch all [GET]

Retrieves collection of Packages with their respective Plans belonging to the given Area.

Parameters

Returns

Success

Array of Packages for the Area If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "notifyAdminOverQuota": true,
        "notifyDeveloperPeriod": "day",
        "notifyAdminPeriod": "month",
        "notifyDeveloperNearQuota": true,
        "id": "360dbb51-ad7c-4b93-8dd9-736760be2f1b",
        "sharedSecretLength": 92,
        "created": "2014-06-30T04:57:49.000+0000",
        "updated": "2014-03-03T08:10:34.000+0000",
        "description": "sapien ut nunc vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae mauris",
        "name": "nam tristique tortor",
        "notifyAdminOverThrottle": false,
        "keyAdapter": "volutpat eleifend donec ut",
        "notifyDeveloperOverQuota": false,
        "notifyAdminEmails": "facilisi cras",
        "notifyAdminNearQuota": true,
        "notifyDeveloperOverThrottle": false,
        "nearQuotaThreshold": 67,
        "keyLength": 76
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "id": "9b8f5b63-2dd8-4cbc-ac22-86e5dc61d251",
        "sharedSecretLength": 30,
        "notifyDeveloperPeriod": "minute",
        "created": "2014-03-27T03:02:42.000+0000",
        "updated": "2014-01-19T12:16:42.000+0000",
        "description": "pulvinar sed nisl nunc rhoncus dui vel sem sed sagittis nam",
        "name": "a ipsum integer a",
        "notifyAdminPeriod": "month",
        "keyAdapter": "felis sed",
        "notifyAdminEmails": "aliquet pulvinar sed nisl",
        "nearQuotaThreshold": 86,
        "keyLength": 72
    }
]

fetch [GET]

Retrieves the Package, returning a Package

Parameters

Returns

Success

Package as identified If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "notifyAdminOverQuota": true,
        "notifyDeveloperPeriod": "hour",
        "notifyAdminPeriod": "minute",
        "notifyDeveloperNearQuota": true,
        "id": "1bf2ea76-9e3a-4673-83e7-900de3dedef5",
        "sharedSecretLength": 31,
        "created": "2014-03-26T11:34:49.000+0000",
        "updated": "2013-12-23T17:25:19.000+0000",
        "description": "eu tincidunt in leo maecenas pulvinar lobortis est phasellus sit amet erat nulla tempus vivamus",
        "name": "praesent id massa id",
        "notifyAdminOverThrottle": false,
        "keyAdapter": "etiam faucibus cursus",
        "notifyDeveloperOverQuota": false,
        "notifyAdminEmails": "fermentum",
        "notifyAdminNearQuota": false,
        "notifyDeveloperOverThrottle": false,
        "nearQuotaThreshold": 6,
        "keyLength": 65
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "id": "57a60859-3725-442c-8418-98d8a6f4f266",
        "sharedSecretLength": 81,
        "notifyDeveloperPeriod": "week",
        "created": "2013-08-17T21:35:21.000+0000",
        "updated": "2014-06-13T22:59:04.000+0000",
        "description": "ut volutpat sapien arcu sed augue aliquam erat volutpat in congue etiam justo etiam pretium iaculis",
        "name": "habitasse platea dictumst morbi",
        "notifyAdminPeriod": "month",
        "keyAdapter": "ipsum primis",
        "notifyAdminEmails": "vestibulum sit",
        "nearQuotaThreshold": 17,
        "keyLength": 57
    }
]

create [POST]

Creates a new Package in the given area.

Parameters

Returns

Success

Package as created If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"notifyAdminOverQuota":true,"notifyDeveloperPeriod":"hour","notifyAdminPeriod":"day","notifyDeveloperNearQuota":true,"id":"49f30479-3130-4959-977f-6f28a39e3622","sharedSecretLength":76,"created":"2013-12-01T22:02:36.000+0000","updated":"2014-03-05T19:38:24.000+0000","description":"nunc purus phasellus in felis donec semper sapien a libero nam dui proin leo odio porttitor id consequat","name":"bibendum morbi non quam","notifyAdminOverThrottle":true,"keyAdapter":"semper rutrum nulla","notifyAdminEmails":"fusce consequat nulla nisl","notifyDeveloperOverQuota":true,"keyLength":11,"nearQuotaThreshold":50,"notifyDeveloperOverThrottle":true,"notifyAdminNearQuota":false}

Response

[
    {
        "notifyAdminOverQuota": true,
        "notifyDeveloperPeriod": "hour",
        "notifyAdminPeriod": "day",
        "notifyDeveloperNearQuota": true,
        "id": "8f07b7b2-fff0-4f2b-b7b9-445bf0d422fd",
        "sharedSecretLength": 25,
        "created": "2013-12-25T14:01:52.000+0000",
        "updated": "2013-10-27T06:00:28.000+0000",
        "description": "nulla nisl nunc nisl duis bibendum felis sed interdum venenatis turpis enim blandit mi in porttitor pede justo eu",
        "name": "lectus",
        "notifyAdminOverThrottle": true,
        "keyAdapter": "non velit nec",
        "notifyDeveloperOverQuota": true,
        "notifyAdminEmails": "ipsum dolor sit amet",
        "notifyAdminNearQuota": false,
        "notifyDeveloperOverThrottle": true,
        "nearQuotaThreshold": 79,
        "keyLength": 75
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"id":"bb9060f6-c8a0-46bf-b0cd-e4674418f0be","sharedSecretLength":90,"notifyDeveloperPeriod":"week","updated":"2013-08-27T06:26:03.000+0000","created":"2013-07-28T06:16:22.000+0000","description":"gravida nisi at nibh in hac habitasse platea dictumst aliquam augue quam sollicitudin vitae consectetuer eget rutrum at lorem integer","notifyAdminPeriod":"week","name":"consequat metus sapien ut","keyAdapter":"orci luctus","notifyAdminEmails":"donec posuere metus vitae","keyLength":32,"nearQuotaThreshold":85}

Response

[
    {
        "id": "6cabbc77-dd41-4bc7-9389-5e266bdf6038",
        "sharedSecretLength": 70,
        "notifyDeveloperPeriod": "day",
        "created": "2013-10-09T02:43:51.000+0000",
        "updated": "2014-02-19T23:18:35.000+0000",
        "description": "id ornare imperdiet sapien urna pretium nisl ut volutpat sapien arcu sed augue aliquam erat volutpat in",
        "name": "felis fusce posuere",
        "notifyAdminPeriod": "hour",
        "keyAdapter": "tristique tortor eu pede",
        "notifyAdminEmails": "orci eget orci vehicula",
        "nearQuotaThreshold": 31,
        "keyLength": 32
    }
]

update [PUT]

Updates the identified Package.

Parameters

Returns

Success

Package as persisted If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"notifyAdminOverQuota":false,"notifyDeveloperPeriod":"week","notifyAdminPeriod":"day","notifyDeveloperNearQuota":false,"id":"9ec344b9-e5aa-4498-9477-04e8c234e08d","sharedSecretLength":10,"created":"2014-05-04T01:18:05.000+0000","updated":"2013-09-12T18:39:31.000+0000","description":"nisi vulputate nonummy maecenas tincidunt lacus at velit vivamus vel nulla eget","name":"elementum in hac habitasse","notifyAdminOverThrottle":false,"keyAdapter":"vitae","notifyAdminEmails":"nisl duis bibendum","notifyDeveloperOverQuota":true,"keyLength":80,"nearQuotaThreshold":4,"notifyDeveloperOverThrottle":true,"notifyAdminNearQuota":true}

Response

[
    {
        "notifyAdminOverQuota": false,
        "notifyDeveloperPeriod": "week",
        "notifyAdminPeriod": "day",
        "notifyDeveloperNearQuota": false,
        "id": "53757937-929a-462e-953c-98cca9959695",
        "sharedSecretLength": 68,
        "created": "2014-04-24T15:51:58.000+0000",
        "updated": "2014-04-28T13:11:08.000+0000",
        "description": "rhoncus sed vestibulum sit amet cursus id turpis integer aliquet massa",
        "name": "curabitur at",
        "notifyAdminOverThrottle": true,
        "keyAdapter": "at turpis",
        "notifyDeveloperOverQuota": true,
        "notifyAdminEmails": "eu nibh",
        "notifyAdminNearQuota": true,
        "notifyDeveloperOverThrottle": false,
        "nearQuotaThreshold": 95,
        "keyLength": 72
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"id":"309868d3-a6d7-45c4-9cf3-686853d6f592","sharedSecretLength":5,"notifyDeveloperPeriod":"day","updated":"2014-05-16T13:13:05.000+0000","created":"2013-11-27T11:18:19.000+0000","description":"augue vestibulum rutrum rutrum neque aenean auctor gravida sem praesent id","notifyAdminPeriod":"week","name":"curabitur at ipsum","keyAdapter":"libero ut massa","notifyAdminEmails":"et eros","keyLength":54,"nearQuotaThreshold":61}

Response

[
    {
        "id": "3f33b64f-7bda-44ac-b1a2-be11f3bea320",
        "sharedSecretLength": 74,
        "notifyDeveloperPeriod": "minute",
        "created": "2014-04-20T09:36:05.000+0000",
        "updated": "2013-08-31T14:37:45.000+0000",
        "description": "quis augue luctus tincidunt nulla mollis molestie lorem quisque ut erat curabitur gravida nisi",
        "name": "ipsum ac tellus",
        "notifyAdminPeriod": "hour",
        "keyAdapter": "convallis",
        "notifyAdminEmails": "volutpat quam pede",
        "nearQuotaThreshold": 67,
        "keyLength": 14
    }
]

delete [DELETE]

Deletes the identified Package.

Parameters

Returns

Success

Empty response

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]