GET /api/users/{UserID}/apps

Returns information about the apps for which the user is on the app team, with optional additional information based on query parameters. The information is returned as an RSS feed.

Note: GET /api/users/{UserID}/apps (list apps, with custom Accept header) returns the same information as a JSON object. We recommend using that operation rather than this one.

Authorization Roles/Permissions: Must be logged in. Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

GET

URL

https://{hostname}/api/users/{UserID}/apps[?IncludeVersions=boolean][&start=int][&count=int][&VersionCount=int]
[&LimitToConnectedAppsWithAPIVersion={APIVersionID}][&LimitToAppsWithActivatedConnections={boolean}]
[&LimitToConnectedAppsInEnvironment={environment}]

Sample Request

Request URL #1

The example below shows a request for the apps associated with a specific user. No optional request parameters are used.

For the response, see Sample response body #1 below.

https://{hostname}/api/users/00904729-ae54-4a91-94bb-bde91ec6495d.acmepaymentscorp/apps

Request URL #2

The example below shows a request for the apps associated with a specific user. In this example, tags are also requested.

For the response, see Sample response body #2 below.

https://{hostname}/api/users/00904729-ae54-4a91-94bb-bde91ec6495d.acmepaymentscorp/apps?IncludeTags=true

Sample request headers

GET /api/users/00904729-ae54-4a91-94bb-bde91ec6495d.acmepaymentscorp/apps HTTP/1.1
Host: {hostname}
Accept: application/json

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, text/xml application/rss+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Header

Description

application/json, text/xml

application/rss+xml

AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.

X-Csrf-Token_{fedmemberID}

The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
UserID	Path	string	Required	The unique ID for a specific user.
IncludeVersions	Query	boolean	Optional	Indicates whether results should include information about app versions. Defaults to false, so app versions are not included unless this parameter is set to true.
start	Query	integer	Optional	An index number indicating the starting point for the results to be returned. If not specified, results start at position 0, the first result.
count	Query	integer	Optional	The number of results to be returned, from the specified starting point. If not specified, all matching results are returned.
versionCount	Query	integer	Optional	Indicates the number of versions to be included in the results. If not specified, defaults to 0, so versions are not included.
LimitToConnectedAppsWithAPIVersion	Query	string	Optional	Limits the results to apps that are connected with the specified APIVersionID.
LimitToAppsWithActivatedConnections	Query	boolean	Optional	Indicates whether results should be limited to apps that have activated connections. If set to false, apps with connections in all states are included.
LimitToConnectedAppsInEnvironment	Query	string	Optional	Limits the results to apps that are connected in the specified environment (Sandbox or Production).

Response

If successful, this operation returns HTTP status code 200, with information about the apps for which the user is on the app team.

Sample Response

The sample responses below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 09 Apr 2019 21:16:07 GMT

Sample response body #1

The example below shows the response to Request URL #1. The user has two apps.

{
  "channel":{
    "title":"My Apps",
    "link":"../../atmosphere#/user/1c9caf2c-cced-42cf-ab0e-b31645c66cef.acmepaymentscorp/applications",
    "description":"List of applications by user",
    "item":[
      {
        "title":"Jenga",
        "description":"Puzzle game",
        "category":[
          {
            "value":"app",
            "domain":"uddi:soa.com:resourcetype"
          },
          {
            "value":"Public",
            "domain":"uddi:soa.com:visibility"
          }
        ],
        "guid":{
          "value":"98dd5f5d-dea6-4c10-a873-1b708e80fa0c.acmepaymentscorp"
        },
        "pubDate":"Tue, 09 Apr 2019 19:52:35 +0000",
        "EntityReferences":{
          "EntityReference":[
            {
              "Title":"Jenga (v1)",
              "Guid":"k7j4fJHm61HZkJSpZJBTk1c8t7adgjyV1JjXUIBS.acmepaymentscorp",
              "Category":[
                {
                  "value":"app-version",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        },
        "Connections":0,
        "Rating":0,
        "EntityReference":{
          "Title":"Jenga (v1)",
          "Guid":"k7j4fJHm61HZkJSpZJBTk1c8t7adgjyV1JjXUIBS.acmepaymentscorp",
          "Category":[
            {
              "value":"app-version",
              "domain":"uddi:soa.com:resourcetype"
            }
          ]
        },
        "Image":{
          "Url":"http://test.acmepaymentscorp.com/api/apps/avatar/_VTSYjyKyfCubBKF8selZU1g"
        },
        "Followers":1
      },
      {
        "title":"Peile Android",
        "description":"Game app",
        "category":[
          {
            "value":"app",
            "domain":"uddi:soa.com:resourcetype"
          },
          {
            "value":"Public",
            "domain":"uddi:soa.com:visibility"
          }
        ],
        "guid":{
          "value":"f44f511f-e743-4148-8fdf-dd79f0c4bd0e.acmepaymentscorp"
        },
        "pubDate":"Tue, 09 Apr 2019 19:13:09 +0000",
        "EntityReferences":{
          "EntityReference":[
            {
              "Title":"Peile Android (v2)",
              "Guid":"jQW0pyRIlPTp4zILah5yWnoL2Z7xYtnQCJUbZjcq.acmepaymentscorp",
              "Category":[
                {
                  "value":"app-version",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        },
        "Connections":0,
        "Rating":0,
        "EntityReference":{
          "Title":"Peile Android (v2)",
          "Guid":"jQW0pyRIlPTp4zILah5yWnoL2Z7xYtnQCJUbZjcq.acmepaymentscorp",
          "Category":[
            {
              "value":"app-version",
              "domain":"uddi:soa.com:resourcetype"
            }
          ]
        },
        "Image":{
          "Url":"http://test.acmepaymentscorp.com/api/apps/avatar/_VTSYjyKyfCubBKF8selZU1g"
        },
        "Followers":1
      }
    ]
  },
  "version":"1.0"
}

Sample response body #2

The example below shows the response to Request URL #2. The request includes the optional IncludeTags parameter, so tags are included in the response.

{
  "channel":{
    "title":"My Apps",
    "link":"../../atmosphere#/user/1c9caf2c-cced-42cf-ab0e-b31645c66cef.acmepaymentscorp/applications",
    "description":"List of applications by user",
    "item":[
      {
        "title":"Jenga",
        "description":"Puzzle game",
        "category":[
          {
            "value":"app",
            "domain":"uddi:soa.com:resourcetype"
          },
          {
            "value":"Public",
            "domain":"uddi:soa.com:visibility"
          },
          {
            "value":"game",
            "domain":"uddi:soa.com:tag"
          },
          {
            "value":"puzzle",
            "domain":"uddi:soa.com:tag"
          }
        ],
        "guid":{
          "value":"98dd5f5d-dea6-4c10-a873-1b708e80fa0c.acmepaymentscorp"
        },
        "pubDate":"Tue, 09 Apr 2019 19:52:35 +0000",
        "EntityReferences":{
          "EntityReference":[
            {
              "Title":"Jenga (v1)",
              "Guid":"k7j4fJHm61HZkJSpZJBTk1c8t7adgjyV1JjXUIBS.acmepaymentscorp",
              "Category":[
                {
                  "value":"app-version",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        },
        "Connections":0,
        "Rating":0,
        "EntityReference":{
          "Title":"Jenga (v1)",
          "Guid":"k7j4fJHm61HZkJSpZJBTk1c8t7adgjyV1JjXUIBS.acmepaymentscorp",
          "Category":[
            {
              "value":"app-version",
              "domain":"uddi:soa.com:resourcetype"
            }
          ]
        },
        "Image":{
          "Url":"http://test.acmepaymentscorp.com/api/apps/avatar/_VTSYjyKyfCubBKF8selZU1g"
        },
        "Followers":1
      },
      {
        "title":"Peile Android",
        "description":"Game app",
        "category":[
          {
            "value":"app",
            "domain":"uddi:soa.com:resourcetype"
          },
          {
            "value":"Public",
            "domain":"uddi:soa.com:visibility"
          },
          {
            "value":"puzzle",
            "domain":"uddi:soa.com:tag"
          },
          {
            "value":"language",
            "domain":"uddi:soa.com:tag"
          },
          {
            "value":"learning",
            "domain":"uddi:soa.com:tag"
          },
          {
            "value":" iOS",
            "domain":"uddi:soa.com:tag"
          },
          {
            "value":"Android",
            "domain":"uddi:soa.com:tag"
          }
        ],
        "guid":{
          "value":"f44f511f-e743-4148-8fdf-dd79f0c4bd0e.acmepaymentscorp"
        },
        "pubDate":"Tue, 09 Apr 2019 19:13:09 +0000",
        "EntityReferences":{
          "EntityReference":[
            {
              "Title":"Peile Android (v2)",
              "Guid":"jQW0pyRIlPTp4zILah5yWnoL2Z7xYtnQCJUbZjcq.acmepaymentscorp",
              "Category":[
                {
                  "value":"app-version",
                  "domain":"uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        },
        "Connections":0,
        "Rating":0,
        "EntityReference":{
          "Title":"Peile Android (v2)",
          "Guid":"jQW0pyRIlPTp4zILah5yWnoL2Z7xYtnQCJUbZjcq.acmepaymentscorp",
          "Category":[
            {
              "value":"app-version",
              "domain":"uddi:soa.com:resourcetype"
            }
          ]
        },
        "Image":{
          "Url":"http://test.acmepaymentscorp.com/api/apps/avatar/_VTSYjyKyfCubBKF8selZU1g"
        },
        "Followers":1
      }
    ]
  },
  "version":"1.0"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, text/xml application/rss+xml

Header

Description

Content-Type

application/json, text/xml

application/rss+xml

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS Channel is My Apps, and the channel includes a link to the app and a text description of the RSS channel. Each item in the RSS channel represents an app that the specified user is associated with, and includes the information below.

Name	Description
title	The text title of the app.
description	Text description of the app.
category[ ]	An array of sets of two name/value pairs, each including Value and Domain, with a value for each. For example: "value" : "app", "domain" : "uddi:soa.com:resourcetype" The example above indicates a resource type of app.
GUID	GUID for the app; the AppID.
pubdate	The date/timestamp when the app was created.
rating	The overall rating for the app.
followers	The number of users following the app.
image	URL to the app's avatar, if applicable. If the app has no custom avatar, the URL to the default app avatar is included.
Entity reference	An array of one or more entity references for the app, with information about the app versions. Each includes: Title: the title of the app version, GUID: the AppVersionID. Category[ ]: an array of sets of two name/value pairs, each including Value and Domain, with a value for each. For example: "value" : "app-version", "domain" : "uddi:soa.com:resourcetype"

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.
500	An error occurred processing the call.

Item

Value

401

Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.

You would also get this response if you hadn't completed login before running the operation, or if you had the wrong UserID.

405

Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.

500

An error occurred processing the call.

More information about Akana API Platform API error messages.