Page History

...

• To put paging in the request, use these params:   resource?paging.pageNumber=5&paging.sortString=name&paging.ascending=false&paging.pageSize=200
  • Note: if the pageSize is too high the server can override the request and lower the pageSize.  However, the server should support at least a pagesize of 1000
• The folder path separator is colon.  If colons are in the parts of the name, URL escape them.  Group names need to be escaped for the group name, which can be put in the URL for certian operations
• Method is the HTTP method, unless the HTTP header: X-HTTP-Method-Override: DELETE  is set, which has a value of a valid method, e.g. GET, PUT, POST, DELETE
• If there are extra attributes, these in an extensions map

Versioning

The version of the API is an integer which is sent in the URL.  If the API is changed in a backwards compatible way (e.g. extra fields which do not change names or structure), then the version number doesn't change. However, there is also a dot version number which includes another integer for the revision number which is changed whenever the API is changed in a backwards compatible way.  The server dot version is sent in the response metadata. 

...

{
  "groups": [
    {
      "id": "123abc",
      "name": "a:b:c",
      "displayName": "A:B:C",
      "description": "This is the description",
      "status": "active"
    },
    {
      "id": "124abd",
      "name": "a:b:d",
      "displayName": "A:B:D",
      "description": "This is the description4",
      "status": "active"
    }
  ],
  "responseMeta": {
    "success": true,
    "serviceRootUrl": "https://groups.institution.edu/groupsApp/groupsApi",
    "serverVersion": "1.4",
    "resultCode": "SUCCESS"
  }
}

Filter the results:https://groups.institution.edu/groupsApp/groupsApi/v1/groups?groups.status=active^{Image Removed}
or: groups.name=a:b:*
or: groups.parentFolder=a:b&groups.parentFolderScope=ONE_LEVEL (or ALL_IN_SUBTREE)

...

The group resource: https://groups.institution.edu/groupsApp/groupsApi/v1/groups/a:b

This resource is available for GET, PUT, POST, DELETE

GET Sample response:

{
  "group":
    {
      "id": "123abc",
      "name": "a:b:c",
      "displayName": "A:B:C",
      "description": "This is the description",
      "status": "active"
    },
  "responseMeta": {
    "success": true,
    "serviceRootUrl": "https://groups.institution.edu/groupsApp/groupsApi",
    "serverVersion": "1.4",
    "resultCode": "SUCCESS"
  }
}

success is true if the URL is correct up until the group name part.

PUT Sample request:

{
  "group":
    {
      "id": "123abc",
      "name": "a:b:c",
      "displayName": "A:B:C",
      "description": "This is the description",
      "status": "active"
    }
}

sdf