List Web Apps

Get the list of web apps for the current site sorted by create date.

Note: This operation does not support: pagination, filtering, or sorting parameters.

Request

  • Method: GET
  • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
    • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
  • Path: /api/v2/admin/sites/current/webapps
    • Alternatively use siteID instead of 'current'
  • Authorization header: This should contain the authorization token. Here is how to obtain the token.
  • Required Permissions: Webapp View

Response

An array of all webapps; each object has the following properties:

  • id - the id of the webapp in the current site (integer)
  • name - the name of the webapp (string)
  • slug - the SEO friendly slug generated for the webapp (string)
  • links - a collection of uris are provided for discoverability. Each object contains links to: (array)
    • self - a quick way of getting to the webapp detail page (GetWebappDetails API url)
    • items - points to the sub-api that lists all webapp items for a webapp
    • fields - points to the api that allows management of the custom fields
    • previewUrl - link to see the webapp in the site front-end. Composed from the site default domain and the slug
    • countries - if location is enabled for the webapp, a link to get the list of countries allowed for location.

Examples

Accepts and returns JSON as Content-Type.


Request:

GET /api/v2/admin/sites/current/webapps HTTPS/1.1
Authorization: 14f87f21c5ea4830a06a6314a8aad82b45bc61dc08f24a0fb55599cea83ca811
Connection: keep-alive
Content-Type: application/json

Response:

{
    "links": [{
        "rel": "self",
        "uri": "https://api-ava.worldsecuresystems.com/api/v2/admin/sites/246884/webapps?skip=0&limit=10"
    }],
    "items": [{
        "links": [{
            "rel": "self",
            "uri": "https://api-ava.worldsecuresystems.com/api/v2/admin/sites/246884/webapps/Test%20app2"
        }],
        "id": 35209,
        "name": "Test app2",
        "slug": "test-app2"
    }],
    "totalItemsCount": 1,
    "skip": 0,
    "limit": 10
}

Sample code

var request = $.ajax({
    url: "/api/v2/admin/sites/current/webapps",
    type: "get",
    contentType: "application/json",headers: {
        "Authorization": $.cookie('access_token')
    }
});
request.done(function (msg) {
    console.log(msg);
})
request.fail(function (jqXHR) {
    console.log("Request failed.");
    console.log("Error code: " + jqXHR.status);
    console.log("Error text: " + jqXHR.statusText);
    console.log("Response text: " + jqXHR.responseText);
})

Error codes

This method will return the following error codes:

  • 200 - success
  • 401 - unauthorized - when the Authorization header is not present, or contains an invalid site token
    • 101000 - sub-error code
  • 403 - forbidden : this is returned when the user trying to access the API does not have the proper permissions
  • 404 - if trying to access a webapp that does not exist - may happen for the following reasons:
    • Web App Name contains special characters: %,*,:,<,>,+,#,, ?,\
  • 500 - server error : this is returned when the call to the API is invalid due to the following reasons:
    • Web App contains 2 or more custom fields with exactly the same custom field name