GET /api/users/{UserID}/apps

Returns information about the apps for which the user is on the app team, and optionally also information about app versions. 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

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for the apps associated with a specific user.

Request URL

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

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.

Back to top

Request Headers

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

Header Description
Accept

application/json, text/xml

application/rss+xml

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.

Back to top

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).
IncludeTags Query boolean Optional Indicates whether tags should be returned in the response. If not specified, defaults to false.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation. The specified user has three apps.

Sample response headers: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 01 Apr 2015 20:07:08 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "My Apps",
    "link" : "../../acmepaymentscorp#/user/4f5535ce-7b7c-4e90-ba2c-20ad4352397e.acmepaymentscorp/applications",
    "description" : "List of applications by user",
    "item" : [ {
      "title" : "Helpify",
      "description" : "Documentation app",
      "category" : [ {
        "value" : "app",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp"
      },
      "pubDate" : "Thu, 02 Apr 2015 01:05:43 +0000",
      "Rating" : 0.0,
      "Followers" : 1,
      "Image" : {
        "Url" : "http://{hostname}/api/apps/b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp/avatar"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "Helpify (1)",
          "Guid" : "AciO7I7uhJQYNVL7q40iu5Ur.acmepaymentscorp",
          "Category" : [ {
            "value" : "app-version",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      },
      "EntityReference" : {
        "Title" : "Helpify (1)",
        "Guid" : "AciO7I7uhJQYNVL7q40iu5Ur.acmepaymentscorp",
        "Category" : [ {
          "value" : "app-version",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      },
      "Connections" : 2
    }, {
      "title" : "AinmhitheLookup",
      "description" : "Animal names in other languages",
      "category" : [ {
        "value" : "app",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp"
      },
      "pubDate" : "Thu, 02 Apr 2015 01:05:16 +0000",
      "Rating" : 0.0,
      "Followers" : 1,
      "Image" : {
        "Url" : "http://{hostname}/api/apps/e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp/avatar"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "AinmhitheLookup (1)",
          "Guid" : "4k2rSDPSkMA7F0QMIiKu6V5B.acmepaymentscorp",
          "Category" : [ {
            "value" : "app-version",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      },
      "EntityReference" : {
        "Title" : "AinmhitheLookup (1)",
        "Guid" : "4k2rSDPSkMA7F0QMIiKu6V5B.acmepaymentscorp",
        "Category" : [ {
          "value" : "app-version",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      },
      "Connections" : 2
    }, {
      "title" : "crosfhocal",
      "description" : "s",
      "category" : [ {
        "value" : "app",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp"
      },
      "pubDate" : "Wed, 01 Apr 2015 19:06:12 +0000",
      "Rating" : 0.0,
      "Followers" : 3,
      "Image" : {
        "Url" : "http://{hostname}/api/apps/ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp/avatar"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "crosfhocal (1.0)",
          "Guid" : "8CwiZZtw5PC4KXxBbkL7YT7D.acmepaymentscorp",
          "Category" : [ {
            "value" : "app-version",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      },
      "EntityReference" : {
        "Title" : "crosfhocal (1.0)",
        "Guid" : "8CwiZZtw5PC4KXxBbkL7YT7D.acmepaymentscorp",
        "Category" : [ {
          "value" : "app-version",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      },
      "Connections" : 1
    } ]
  },
  "version" : "1.0"

Back to top

Sample response headers: text/xml

Status Code: 200 OK
Content-Type: text/xml
Date: Wed, 01 Apr 2015 20:09:32 GMT

Sample response body: text/xml

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:ns10="http://soa.com/xsd/fault/1.0" xmlns:ns11="http://soa.com/xsd/api/1.0" 
xmlns:ns12="http://soa.com/xsd/board/1.0" xmlns:ns13="http://soa.com/xsd/alert/1.0" 
xmlns:ns14="http://soa.com/xsd/contract/1.0" xmlns:ns15="http://soa.com/xsd/ticket/1.0" 
xmlns:ns16="http://soa.com/xsd/app/1.0" xmlns:ns17="http://soa.com/xsd/discussion/1.0" 
xmlns:ns18="http://soa.com/xsd/review/1.0" xmlns:ns19="http://soa.com/xsd/search/1.0" 
xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns20="http://soa.com/xsd/workflow/1.0" 
xmlns:ns21="http://soa.com/xsd/client/services/1.0" xmlns:ns3="http://soa.com/xsd/user/1.0" 
xmlns:ns4="http://soa.com/xsd/rss/1.0" xmlns:ns5="http://soa.com/xsd/comment/1.0" 
xmlns:ns6="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns7="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns8="http://soa.com/xsd/resource/1.0" xmlns:ns9="http://soa.com/xsd/legals/1.0" version="1.0">
  <channel>
    <title>My Apps</title>
    <link>../../acmepaymentscorp#/user/4f5535ce-7b7c-4e90-ba2c-20ad4352397e.acmepaymentscorp/applications</link>
    <description>List of applications by user</description>
    <item>
      <title>Helpify</title>
      <description>Documentation app</description>
      <category domain="uddi:soa.com:resourcetype">app</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <guid>b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp</guid>
      <pubDate>Thu, 02 Apr 2015 01:05:43 +0000</pubDate>
      <ns4:Image>
        <Url>http://{hostname}/api/apps/b788f118-1789-4d8b-9744-8ab2970db482.acmepaymentscorp/avatar</Url>
      </ns4:Image>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Title>Helpify (1)</Title>
          <Guid>AciO7I7uhJQYNVL7q40iu5Ur.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:EntityReference>
        <Title>Helpify (1)</Title>
        <Guid>AciO7I7uhJQYNVL7q40iu5Ur.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
      </ns4:EntityReference>
      <ns4:Connections>2</ns4:Connections>
      <ns4:Followers>1</ns4:Followers>
      <ns4:Rating>0.0</ns4:Rating>
    </item>
    <item>
      <title>AinmhitheLookup</title>
      <description>Animal names in other languages</description>
      <category domain="uddi:soa.com:resourcetype">app</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <guid>e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp</guid>
      <pubDate>Thu, 02 Apr 2015 01:05:16 +0000</pubDate>
      <ns4:Image>
        <Url>http://{hostname}/api/apps/e6bc6955-4d8a-40db-a0f9-6a232d7a239a.acmepaymentscorp/avatar</Url>
      </ns4:Image>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Title>AinmhitheLookup (1)</Title>
          <Guid>4k2rSDPSkMA7F0QMIiKu6V5B.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:EntityReference>
        <Title>AinmhitheLookup (1)</Title>
        <Guid>4k2rSDPSkMA7F0QMIiKu6V5B.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
      </ns4:EntityReference>
      <ns4:Connections>2</ns4:Connections>
      <ns4:Followers>1</ns4:Followers>
      <ns4:Rating>0.0</ns4:Rating>
    </item>
    <item>
      <title>crosfhocal</title>
      <description>s</description>
      <category domain="uddi:soa.com:resourcetype">app</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <guid>ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp</guid>
      <pubDate>Wed, 01 Apr 2015 19:06:12 +0000</pubDate>
      <ns4:Image>
        <Url>http://{hostname}/api/apps/ce195b40-fa2f-4855-8ac7-169fc9a3c16e.acmepaymentscorp/avatar</Url>
      </ns4:Image>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Title>crosfhocal (1.0)</Title>
          <Guid>8CwiZZtw5PC4KXxBbkL7YT7D.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:EntityReference>
        <Title>crosfhocal (1.0)</Title>
        <Guid>8CwiZZtw5PC4KXxBbkL7YT7D.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
      </ns4:EntityReference>
      <ns4:Connections>1</ns4:Connections>
      <ns4:Followers>3</ns4:Followers>
      <ns4:Rating>0.0</ns4:Rating>
    </item>
  </channel>
</rss>

Back to top

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

Back to top

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"

Back to top

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
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. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header, or used the wrong HTTP verb.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics