vas_package.list

The vas_package.list command retrieves a list of VAS packages.

TR50 Request

{
  "cmd": {
    "command": "vas_package.list",
    "params": {
      "sort": "+name",
      "offset": 0,
      "limit": 10,
      "published": false
    }
  }
}

Request Parameters

Name Type Required Description
sort String sort is an optional parameter that defines the sort order of the result set. It allows to arrange the list in either ascending(+) or descending(-) order. It is possible to sort vas_package.list in the following categories:
  • name
  • code (default)
  • mno
  • published
offset Integer The starting list offset, used for pagination. Defaults to 0 if not specified.
limit Integer Limits the number of results returned. The maximum limit you can set is 2000. Defaults to 2000.
published Boolean If the VAS packages is in a published state.

TR50 Response

If the command is sent successfully a success message and the list of VAS package objects is returned. Otherwise, an error and error message will be returned.

{
  "cmd": {
    "success": true,
    "params": {
      "count": 10,
      "result": [
        {
          "id": "500000000000000000000001"
          "name": "The VAS Package Name",
          "code": "thevaspackagecode",
          "mno": "The MNO",
          "comments": "A comment",
          "published": true,
          "orgId": "500000000000000000000001",
          "createdBy": "user@example.com",
          "createdOn": "2014-01-31T13:03:15.31-05:00",
          "updatedBy": "user@example.com",
          "updatedOn": "2014-01-31T13:03:15.31-05:00"
        },
        ...
      ]
    }
  }
}

Response Parameters

Name Type Description
count Integer The total number of VAS packages.
result Array The array of VAS package objects.

Result Array Object

Name Type Description
id String The object id of the VAS package.
name String The name of the VAS package.
mno String The MNO of the VAS package.
comments String Comments associated with the VAS package.
published Boolean If the VAS package is in a published state, and can be associated to things and connections.
orgId String The object ID of the organization associated with the VAS package.
createdBy String The email address of the user who created the VAS package.
createdOn String The timestamp that the VAS package was created.
updatedBy String The email address of the user who last updated the VAS package.
updatedOn String The timestamp that the VAS package was updated.