Business - Filters

The Admin interface handles web service calls from the Admin web gui. The base url for this is at:

/api/business-admin

A JSON file with OpenAPI data about all business-related admin APIs can be downloaded here.

Get resource groups

Gets the list of resource groups to use as filters:

GET /v1/filters/resource-groups

Gets the list of resource groups to use as filters

Status Codes

Returns a Json positive response and a list of resource groups:

[
  {
    ID: 11                                         // Int
    CreatedDate: "2001-01-01T01:01:01Z",           // DateTime
    LastUpdated: "2001-01-01T01:01:01Z",           // DateTime
    Name: "Resource Group Demo",                   // String
    Guid: "53155c4a-b2a0-412f-ab41-552d9ccdf784",  // Guid
    Communities: [ ... ]                           // Guid Array
  },
  ...
]

Get user groups

Gets the list of user groups to use as filters:

GET /v1/filters/user-groups

Gets the list of user groups to use as filters

Status Codes

Returns a Json positive response and a list of user groups:

[
  {
    ID: 9,                                         // Int
    Guid: "53155c4a-b2a0-412f-ab41-552d9ccdf784",  // Guid
    Labels: "{"en":"a0001E","it":"a0001I2"}",      // String
    CreatedDate: "2001-01-01T01:01:01Z",           // DateTime
    Communities: [ ... ]                           // Guid Array
  },
  ...
]

Get categories

Gets the tree of categories to use as filters:

GET /v1/filters/categories

Gets the tree of categories to use as filters

Status Codes

Returns a Json positive response and the tree of categories:

[
  {
    "Guid": "32b297a5-8180-420f-9482-84bfc7f55efe",                      // Guid
    "Parent": null,                                                      // Guid (nullable)
    "Labels": "{\"en\":\"City Car\"}",                                   // String
    "OriginatorModule": "00000000-0000-0000-0000-000000000000",          // Guid
    "Children":                                                          // Category Array (nullable)
    [                                                                    //
      {                                                                  //
        "Guid": "2e601015-41ae-4670-9484-5da7a8bb9f2a",                  // Guid
        "Parent": "32b297a5-8180-420f-9482-84bfc7f55efe",                // Guid
        "Labels": "{\"en\":\"City Car\"}",                               // String
        "OriginatorModule": "00000000-0000-0000-0000-000000000000",      // Guid
        "Children": [ ... ]
        "IsRoot": false                                                  // Boolean (always false for childrens)
      },
      ...
    ],
    "IsRoot": true                                                       // Boolean
  },
  ...
]

The field Labels contains a stringified Json containing pairs “language code”:”localized value”

Get communities

Gets the tree of communities to use as filters:

GET /v1/filters/communities

Gets the tree of communities to use as filters

Status Codes

Returns a Json positive response and the tree of communities:

[
  {
    ID: 1,                                                 // Int
    Guid: "2e94fb9a-83bb-4f8a-badb-a5edd5cbe919",          // Guid
    Name: "Userbase",                                      // String
    Level: 0,                                              // Int
    Parent: null,                                          // Guid (nullable)
    Children:                                              // Community Array (nullable)
    [
      {
        ID: 14,                                            // Int
        Guid: "b2686bd5-5fa4-4cca-a904-d616faf86a74",      // Guid
        Name: "Sub-community",                             // String
        Level: 1,                                          // Int
        Parent: "2e94fb9a-83bb-4f8a-badb-a5edd5cbe919",    // Guid
        Children: [ ... ]
      },
      ...
    ]
  },
  ...
]