WebAudit API - Registry

Old Version

This documentation is for version Framework 4.1. When developing new sites, please refer to 5.0 Framework Documentation.

Skill Level: 
Advanced

Resource URI

GET https://webaudit.unl.edu/registry/?format=json&query={query}

The query must be URL encoded.

Resource Properties

Property Description
query String: The URL encoded query. This can either be a URL or a user with the format of {username}@{provider}

Returns

A set of site objects. The most specific results will be returned first and then progress to the least specific results.

A site object


"base_url": {
  "support_email": null,
  "support_groups": null,
  "title": "The title of the site",
  "members": {
    "id (internal id of the user)": {
      "provider": "the provider name",
      "uid": "the uid that was provided by the provider",
      "roles": [
        "admin",
        "operator"
      ]
    },
    //more members
},

Site object example


"http:\/\/acreage.unl.edu\/": {
    "support_email": null,
    "support_groups": null,
    "title": "Acreage\nInsights",
    "members": {
        "5926": {
            "provider": "UNL",
            "uid": "aholz4",
            "roles": [
                "admin"
            ]
        },
        "6638": {
            "provider": "UNL",
            "uid": "jabele3",
            "roles": [
                "admin"
            ]
        },
        "5923": {
            "provider": "UNL",
            "uid": "s-mfairch4",
            "roles": [
                "admin"
            ]
        },
        "5925": {
            "provider": "UNL",
            "uid": "nstoner2",
            "roles": [
                "admin"
            ]
        },
        "5924": {
            "provider": "UNL",
            "uid": "sbrowning2",
            "roles": [
                "admin"
            ]
        }
    }
}

URL Query Example

https://webaudit.unl.edu/registry/?format=json&query=http%3A%2F%2Fwww.unl.edu%2Fenglish%2F

Person Query Example

https://webaudit.unl.edu/registry/?format=json&query=s-mfairch4%40unl.edu
Contributed By: 
IIM