Integration

To enable ease of integration with internal Australian Data Archive and external partner services, CADRE's React frontend has a number of routes with query parameters. All routes with additional integration support are documented here for future reference.

Resource Searching

URL

  • {Target-CADRE-Server}/catalogue

Description

Redirect the user to this URL from your application when integrating with CADRE if you wish users to be able to manually create their DSR application. This page can be given query parameters to prefill the page and narrow down the search options for the user.

Query Parameters

id (optional)

Examples:

  • https://cadre.ada.edu.au/catalogue?id=doi:10.26193/SKK7EV

Note! There is no limit imposed by CADRE for the number of IDs which can be requested to this page and you can combine them with names.

name (optional)

Examples:

  • https://cadre.ada.edu.au/catalogue?name=Australian%20Survey%20of%20Social%20Attitudes%2C%202022

Note! There is no limit imposed by CADRE for the number of names which can be requested to this page and you can combine them with IDs.

DSR Applications

URL

  • {Target-CADRE-Server}/catalogue/application

Description

Redirect the user to this URL when you want automatic creation of DSRs based on their IDs. This page requires valid IDs to be provided via query parameters otherwise the page will throw an error to users.

Query Parameters

id (mandatory)

Examples:

  • https://cadre.ada.edu.au/catalogue/application?id=doi:10.26193/SKK7EV
  • https://cadre.ada.edu.au/catalogue/application?id=doi:10.26193/SKK7EV&id=doi:10.26193/WRHDUL&id=doi:10.26193/YOARTT

Note! There is no limit imposed by CADRE for the number of IDs which can be requested to this page.

redirect (optional)

Default:

  • If the redirect query parameter is not provided to the URL, then the user will be redirected to the newly created DSR on a successful POST request. This means that you can omit the redirect query parameter if you want the user to always be redirected to be access form.

Examples:

  • https://cadre.ada.edu.au/catalogue/application?id=doi:10.26193/SKK7EV&redirect=true
  • https://cadre.ada.edu.au/catalogue/application?id=doi:10.26193/SKK7EV&redirect=false

Note! If (for whatever reason) multiple duplicate query parameters with the redirect key are given, all duplicates must be true for CADRE to redirect the user on successful. Furthermore, if multiple id keys are provided on the request, the redirect key is disregarded as it's ambigious which id to redirect to.

combine (optional)

Default:

  • If the combine parameter is not provided to the URL, then all applications with the same workflow ID (wfid) will be put into the same application. This means that you can omit the combine query parameter if you want the user's resources (that have the same approvers) to be combined into a single application.

Examples:

  • https://cadre.ada.edu.au/catalogue/application?id=doi:10.26193/SKK7EV&combine=true
  • https://cadre.ada.edu.au/catalogue/application?id=doi:10.26193/SKK7EV&combine=false
3. Production configuration