MemberApplications

Resource URI

/members/{memberId}

Items in curly braces represent variables.

Description

Roles control access to and visibility of APIs and Package Plans in the Portal. The Mashery v3 API supports fetching roles. Please consult the V2 API documentation for creating, updating and deleting roles.

Resource Schema

Property Characteristics
id Type string
Sub-type
Create Rule Ignored
Update Rule Required (if not in context)
Fetch Rule Implicit
Description Object identifier (Application UUID).
name Type string
Sub-type
Create Rule Required
Update Rule Optional
Fetch Rule Implicit
Description Application name.
created Type string
Sub-type datetime
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Date/time the object was created.
updated Type string
Sub-type datetime
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Date/time the object was last updated.
username Type string
Sub-type
Create Rule Required
Update Rule Optional
Fetch Rule Implicit
Description Username of the membe that the application belongs to.
description Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Description of the application.
type Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Type of application; metadata used for tracking.
commercial Type boolean
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Whether or not the application is commercial in nature.
ads Type boolean
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Whether or not the application supports ads.
adsSystem Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Advertisement system.
usageModel Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Usage model.
tags Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Tags, i.e. tracking metadata.
notes Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Notes about the application.
howDidYouHear Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description How did someone hear about the API?
preferredProtocol Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Protocol preference of developer, e.g. REST or SOAP.
preferredOutput Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Output preference of developer, e.g. json or xml.
externalId Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description ID of the application in an external system, e.g. Salesforce
uri Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description URI of the application.
oauthRedirectUri Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description OAuth 2 redirect URI.
packageKeys Type array
Sub-type Packagekey
Create Rule Optional
Update Rule Optional
Fetch Rule Explicit
Description Keys that belong to the Application.

fetch all [GET]

Retrieves collection of Applications belonging to the given Member belonging to the given Area.

Parameters

Parameter Required Type Description
memberId true string Member identifier.
fields false string Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter false string Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort false string Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit false int Number of objects to return in the result. Defaults to 100.
offset false int 0-based index of first object in the list to return. Defaults to 0.

Returns

Success

Array of Roles 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/members/{memberId}/applications' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "ads": false,
        "adsSystem": "sed",
        "commercial": true,
        "created": "2015-02-16T00:07:43.000+0000",
        "description": "tellus in sagittis dui vel nisl duis ac nibh fusce lacus purus aliquet at feugiat non",
        "externalId": "sed augue aliquam erat",
        "howDidYouHear": "posuere nonummy integer non",
        "id": "9b63e92f-724c-4639-9636-7ad0589d8875",
        "name": "lacus purus aliquet",
        "notes": "leo odio",
        "oauthRedirectUri": "massa volutpat convallis",
        "preferredOutput": "eget eleifend",
        "preferredProtocol": "metus vitae ipsum",
        "tags": "elit ac nulla sed",
        "type": "eu est",
        "updated": "2015-07-28T15:33:03.000+0000",
        "uri": "convallis",
        "usageModel": "quis augue",
        "username": "ante"
    }
]

Request

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

Response

[
    {
        "ads": false,
        "adsSystem": "nibh in",
        "commercial": false,
        "created": "2015-09-22T21:12:02.000+0000",
        "description": "a pede posuere nonummy integer non velit donec diam neque vestibulum eget vulputate ut ultrices vel augue vestibulum ante",
        "externalId": "nisl duis",
        "howDidYouHear": "massa",
        "id": "5f3228bb-8de8-40ef-9214-eda005c4e851",
        "name": "consequat",
        "notes": "augue quam sollicitudin",
        "oauthRedirectUri": "ut",
        "preferredOutput": "ut nunc vestibulum ante",
        "preferredProtocol": "quis libero nullam",
        "tags": "integer tincidunt ante",
        "type": "aliquam",
        "updated": "2015-12-18T12:32:09.000+0000",
        "uri": "odio condimentum",
        "usageModel": "ante",
        "username": "condimentum id"
    }
]

update [PUT]

Retrieves the identified Application.

Parameters

Parameter Required Type Description
memberId true string Member identifier.
applicationId true string Application identifier.
application true object Application object

Returns

Success

ServiceDefinition 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/members/{memberId}/applications/{applicationId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"ads":false,"adsSystem":"consequat morbi a","commercial":false,"created":"2015-03-09T07:48:17.000+0000","description":"cubilia curae mauris viverra diam vitae quam suspendisse potenti nullam","externalId":"turpis nec","howDidYouHear":"quam a odio","id":"e4916b91-b014-4c19-a57e-cdf7f0afd337","name":"sed","notes":"quis odio","oauthRedirectUri":"nullam molestie nibh","preferredOutput":"convallis morbi odio","preferredProtocol":"quis","tags":"lorem vitae mattis nibh","type":"pede justo lacinia","updated":"2015-09-24T02:27:50.000+0000","uri":"praesent blandit","usageModel":"tempus vel pede","username":"nulla justo"}

Response

[
    {
        "ads": false,
        "adsSystem": "odio",
        "commercial": false,
        "created": "2015-01-17T11:34:30.000+0000",
        "description": "nisl aenean lectus pellentesque eget nunc donec quis orci eget orci",
        "externalId": "quam fringilla rhoncus",
        "howDidYouHear": "amet sapien dignissim vestibulum",
        "id": "ad5ce0da-564a-4d45-9684-0148c8eab2c1",
        "name": "donec posuere metus",
        "notes": "lectus in",
        "oauthRedirectUri": "id",
        "preferredOutput": "dui luctus rutrum nulla",
        "preferredProtocol": "turpis",
        "tags": "rutrum rutrum neque aenean",
        "type": "aliquam quis",
        "updated": "2015-03-13T05:03:03.000+0000",
        "uri": "praesent",
        "usageModel": "risus",
        "username": "venenatis tristique fusce"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/members/{memberId}/applications/{applicationId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"ads":false,"adsSystem":"ligula vehicula consequat morbi","commercial":false,"created":"2015-11-04T16:24:33.000+0000","description":"dolor morbi vel lectus in quam fringilla rhoncus mauris enim leo rhoncus sed vestibulum sit amet cursus id turpis","externalId":"pede venenatis","howDidYouHear":"erat volutpat in congue","id":"a3d30b24-520e-4615-8e89-87e4fe47ceda","name":"odio donec vitae nisi","notes":"et","oauthRedirectUri":"consequat varius integer","preferredOutput":"mauris non","preferredProtocol":"massa volutpat convallis morbi","tags":"habitasse","type":"molestie","updated":"2015-04-05T03:17:29.000+0000","uri":"id nisl venenatis","usageModel":"elementum pellentesque","username":"mollis molestie"}

Response

[
    {
        "ads": true,
        "adsSystem": "pellentesque quisque",
        "commercial": false,
        "created": "2015-07-31T00:30:46.000+0000",
        "description": "ac neque duis bibendum morbi non quam nec dui luctus rutrum nulla tellus in sagittis dui vel nisl",
        "externalId": "penatibus et magnis dis",
        "howDidYouHear": "parturient montes",
        "id": "4d3a6476-8a6b-464b-9d48-ed173be2c382",
        "name": "neque aenean auctor",
        "notes": "ullamcorper purus sit amet",
        "oauthRedirectUri": "vestibulum ac",
        "preferredOutput": "lorem id ligula suspendisse",
        "preferredProtocol": "ut suscipit a feugiat",
        "tags": "ut rhoncus aliquet",
        "type": "tortor sollicitudin mi sit",
        "updated": "2015-03-24T13:08:57.000+0000",
        "uri": "pharetra magna",
        "usageModel": "eu nibh quisque id",
        "username": "ac neque"
    }
]

create [POST]

Creates a new Application for the given Member..

Parameters

Parameter Required Type Description
memberId true string Member identifier.
application true object Application object

Returns

Success

ServiceDefinition 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/members/{memberId}/applications' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"ads":true,"adsSystem":"a ipsum","commercial":false,"created":"2015-08-30T10:18:57.000+0000","description":"dolor quis odio consequat varius integer ac leo pellentesque ultrices","externalId":"mauris morbi","howDidYouHear":"tincidunt ante","id":"154658ba-4ee5-49b7-8a9e-cd40c8ae9c12","name":"nisl","notes":"vestibulum rutrum","oauthRedirectUri":"et ultrices posuere","preferredOutput":"suspendisse","preferredProtocol":"amet consectetuer","tags":"sem duis","type":"diam","updated":"2015-03-11T04:16:41.000+0000","uri":"feugiat et eros","usageModel":"natoque penatibus","username":"orci luctus"}

Response

[
    {
        "ads": true,
        "adsSystem": "elementum",
        "commercial": true,
        "created": "2015-06-05T12:12:27.000+0000",
        "description": "turpis eget elit sodales scelerisque mauris sit amet eros suspendisse accumsan",
        "externalId": "id pretium",
        "howDidYouHear": "sem mauris",
        "id": "26e83b12-d027-4d5f-a8e8-790d6283efd8",
        "name": "nunc viverra dapibus nulla",
        "notes": "eu",
        "oauthRedirectUri": "varius nulla facilisi cras",
        "preferredOutput": "dolor quis odio consequat",
        "preferredProtocol": "nec",
        "tags": "mus",
        "type": "luctus nec",
        "updated": "2015-11-29T01:50:57.000+0000",
        "uri": "aliquam lacus",
        "usageModel": "fringilla rhoncus mauris enim",
        "username": "et"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/members/{memberId}/applications' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"ads":true,"adsSystem":"odio porttitor id","commercial":true,"created":"2015-04-08T11:43:29.000+0000","description":"porttitor pede justo eu massa donec dapibus duis at velit","externalId":"nulla","howDidYouHear":"vel","id":"0f32f199-ec80-48f7-af8a-3a2e5d7db126","name":"ipsum primis in","notes":"nisl duis ac nibh","oauthRedirectUri":"ac leo pellentesque ultrices","preferredOutput":"dolor sit","preferredProtocol":"felis sed lacus","tags":"etiam","type":"curae duis faucibus","updated":"2015-06-14T04:25:47.000+0000","uri":"pellentesque volutpat dui maecenas","usageModel":"est quam pharetra magna","username":"odio"}

Response

[
    {
        "ads": true,
        "adsSystem": "penatibus",
        "commercial": false,
        "created": "2015-06-17T03:13:45.000+0000",
        "description": "curabitur at ipsum ac tellus semper interdum mauris ullamcorper purus sit amet",
        "externalId": "ut mauris eget",
        "howDidYouHear": "adipiscing",
        "id": "f22090c3-38a7-4a23-ad52-4327249608c1",
        "name": "adipiscing elit proin",
        "notes": "ultrices vel augue vestibulum",
        "oauthRedirectUri": "justo",
        "preferredOutput": "est",
        "preferredProtocol": "bibendum felis sed",
        "tags": "laoreet",
        "type": "neque",
        "updated": "2015-08-18T20:54:43.000+0000",
        "uri": "in purus",
        "usageModel": "duis",
        "username": "donec dapibus duis"
    }
]

delete [DELETE]

Deletes the identified Application.

Parameters

Parameter Required Type Description
memberId true string Member identifier.
applicationId true string Application identifier.

Returns

Success

ServiceDefinition 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/members/{memberId}/applications/{applicationId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Request

curl -k 'https://api.mashery.com/v3/rest/members/{memberId}/applications/{applicationId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Docs Navigation