GET /api/apps

Returns a list of apps at the root level (not apps added in the context of a specific organization.) With an optional parameter, lists apps owned by the specified organization.

Supported Versions: 8.3 and later

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the resource. Versions prior to 8.4.8: Must be a Site Admin. Version 8.4.8 and later: Site Admin or Business Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps[?BusinessID={BusinessID}]

Back to top

Sample Request

The example below shows a request for information about the apps for a specific business organization.

Request URL

https://{hostname}/api/apps?BusinessID=8c7d0ba1-b73f-41ee-9144-b5a90173382d.acmepaymentscorp

Sample request headers

Accept: application/vnd.soa.v83+json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

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

Any of the following media types is valid for the Accept header:

application/vnd.soa.v83+json, application/vnd.soa.v83+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
BusinessID Query string Optional

The unique ID for a specific business organization on the platform.

If this parameter is included, apps relating to the specified organization are returned.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about apps for the organization.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v83+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v83+json
Date: Wed, 07 Sep 2016 14:33:31 GMT

Sample response body: application/vnd.soa.v83+json

{
  "Application" : [ {
    "AppID" : "0c194104-45ef-43aa-80f8-84c3e8b359d1.acmepaymentscorp",
    "Name" : "Billing App 1",
    "Description" : "Billing App 1",
    "Created" : "2016-09-07T14:25:52Z",
    "Updated" : "2016-09-07T14:25:52Z",
    "State" : "com.soa.app.state.active",
    "Visibility" : "Public",
    "AvatarURL" : "http://acmepaymentscorp/api/apps/avatar/_Vis6l3Un8ocFbID2QRgFVmg"
  }, {
    "AppID" : "83fe9c95-c1cd-488a-9e25-bdf1d89bcf9e.acmepaymentscorp",
    "Name" : "Billing App 2",
    "Description" : "Billing App 2",
    "Created" : "2016-09-07T14:26:20Z",
    "Updated" : "2016-09-07T14:26:20Z",
    "State" : "com.soa.app.state.active",
    "Visibility" : "Public",
    "AvatarURL" : "http://acmepaymentscorp/api/apps/avatar/_Vis6l3Un8ocFbID2QRgFVmg"
  } ]
}

Back to top

Sample response headers: application/vnd.soa.v83+xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v83+xml
Date: Wed, 07 Sep 2016 14:33:31 GMT

Sample response body: application/vnd.soa.v83+xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:AppInfos xmlns:ns2="http://soa.com/xsd/resource/1.0" xmlns:ns3="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns4="http://soa.com/xsd/app/1.0" xmlns:ns5="http://soa.com/xsd/business/1.0">
  <ns4:Application>
    <ns4:AppID>0c194104-45ef-43aa-80f8-84c3e8b359d1.acmepaymentscorp</ns4:AppID>
    <ns4:Name>Billing App 1</ns4:Name>
    <ns4:Description>Billing App 1</ns4:Description>
    <ns4:Created>2016-09-07T14:25:52Z</ns4:Created>
    <ns4:Updated>2016-09-07T14:25:52Z</ns4:Updated>
    <ns4:State>com.soa.app.state.active</ns4:State>
    <ns4:Visibility>Public</ns4:Visibility>
    <ns4:AvatarURL>http://acmepaymentscorp/api/apps/avatar/_Vis6l3Un8ocFbID2QRgFVmg</ns4:AvatarURL>
  </ns4:Application>
  <ns4:Application>
    <ns4:AppID>83fe9c95-c1cd-488a-9e25-bdf1d89bcf9e.acmepaymentscorp</ns4:AppID>
    <ns4:Name>Billing App 2</ns4:Name>
    <ns4:Description>Billing App 2</ns4:Description>
    <ns4:Created>2016-09-07T14:26:20Z</ns4:Created>
    <ns4:Updated>2016-09-07T14:26:20Z</ns4:Updated>
    <ns4:State>com.soa.app.state.active</ns4:State>
    <ns4:Visibility>Public</ns4:Visibility>
    <ns4:AvatarURL>http://acmepaymentscorp/api/apps/avatar/_Vis6l3Un8ocFbID2QRgFVmg</ns4:AvatarURL>
  </ns4:Application>
</ns4:AppInfos>

Back to top

Response Headers

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

Header Description
Content-Type application/vnd.soa.v83+json, application/vnd.soa.v83+xml

Back to top

Response Body

Name Type Description
AppInfos AppInfos Contains summary information about one or more apps.

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics