6. CUD Interfaces

The following are brief descriptions of available CUD interfaces intended to assist with selection of query for a given requirement.

More details, including the process to follow to request access are in http://www.oucs.ox.ac.uk/services/iam/cud/cud-interfaces-detail.xml

6.1. CUD UI

Typical use cases: ad-hoc lookups of data in CUD; preparation and testing of query to be used by server/service

The CUD UI is a web application which enables registered users to perform the following:

  • Searching using a query builder
  • Matching
  • Manage affiliations

All users are encouraged to use the CUD UI to familiarise themselves with CUD.

Documentation on the use of UI is available at http://www.oucs.ox.ac.uk/services/iam/cud/cud-ui-user-guide.xml

6.2. REST

Typical use-case: retrieve data for a college or department, saving to file for local processing

Representational State Transfer (REST) is the preferred method of querying CUD from a server or service. It allows data to be requested using a simple GET query communicated over HTTPS.

6.3. SOAP

Typical use-case: send data to/accept data from packaged application which supports SOAP for this purpose.

SOAP is currently supported as a means of pushing data to remote webservices. Requirements are specific to each service.

6.4. LDAP

Typical use case: Web application which requires a lookup of single records in CUD

CUD data can appear as an LDAP v3 directory, queryable by any LDAP client. Whilst this is possible it is not planned as this function is better served by existing and planned dedicated LDAP directories such as OAK and Groupstore.

Typical use case: provision accounts to local Active Directory, with account lifecycle managed by CUD

CUD can push data to an external LDAP directory, such as Microsoft Active Directory.

6.5. SQL

Typical use case: maintain data on a set of people in a table in a database for use locally

CUD can push data into a SQL database. Normally this involves storing data in a table or tables in the remote database which is dedicated to this task. This data is then processed by local procedures to update other data tables, or referenced as appropriate in queries.

Up: Contents Previous: 5. Services and Interfaces Next: 7. Further Documentation