APIs

CantusDB APIs

CantusDB's APIs are defined in main_app/views/views.py (code).

csv_export

The CSV Export API is used to share information for all chants/sequences in a source in CSV format. It can be accessed via /csv/<source_id> (for example, http://206.12.93.196/csv/123610). It corresponds to OldCantus's csv API.

Each row in the returned CSV file represents a single chant or sequence. It has the following columns:

• siglum: The value of the chant's siglum field. A string.
• marginalia: The value of the chant's marginalia field. A string.
• folio: The value of the chant's folio field. A string.
• sequence: The value of the chant's sequence_number field. An integer.
• incipit: The value of the chant's incipit field. A string.
• feast: The name field of the chant's Feast. A string.
• office: The name field of the chant's Office. A string.
• genre: The name field of the chant's Genre. A string.
• position: The value of the chant's position field. A string.
• cantus_id: The value of the chant's cantus_id field. A string.
• mode: The value of the chant's mode field. A string.
• finalis: The value of the chant's folio field. A string.
• differentia: The value of the chant's differentia field. A string.
• differentia_new: The value of the chant's differentia_new field. A string.
• fulltext_standardized: The value of the chant's manuscript_full_text_std_spelling field. A string.
• fulltext_ms: The value of the chant's manuscript_full_text field. A string.
• volpiano: The value of the chant's volpiano field. A string.
• image_link: The value of the chant's manuscript_full_text field. A URL.
• melody_id: The value of the chant's melody_id field. A string.
• cao_concordances: The value of the chant's cao_concordances field. A string.
• addendum: The value of the chant's addendum field. A string.
• extra: The value of the chant's extra field. A string.
• node_id: The chant's ID. An integer.

json_melody_export

The JSON Melody Export API exports information on all chants/sequences in the database with a given Cantus ID in JSON format. It can be accessed via /json-melody/<cantus_id> (for example, http://206.12.93.196/json-melody/002085). It corresponds to OldCantus's json-melody API. It corresponds to OldCantus's json-melody API.

The returned file is an array of JSON objects. Each object represents a single chant. Each object has the following keys:

• "mid": The value of the chant's melody_id field. A string.
• "nid": The chant's ID. An integer.
• "cid": The value of the chant's cantus_id field. A string.
• "siglum": The value of the chant's siglum field. A string.
• "srcnid": The ID of the chant's Source. An integer.
• "folio": The value of the chant's folio field. A string.
• "incipit": The value of the chant's incipit field. A string.
• "fulltext": The value of the chant's manuscript_full_text field. A string.
• "volpiano": The value of the chant's volpiano field. A string.
• "mode": The value of the chant's mode field. A string.
• "feast": The ID of the chant's Feast. An integer.
• "office": The ID of the chant's Office. An integer.
• "genre": The ID of the chant's Genre. An integer.
• "position": The value of the chant's position field. A string.

json_node_export

The JSON Node Export API exports all information on a Chant, Sequence, Source or Indexer in JSON format. It can be accessed via /json-node/<id> (for example, http://206.12.93.196/json-node/123610). It corresponds to OldCantus's json-node API.

json_sources_export

The JSON Sources Export API exports information on each published source in the database in JSOn format. For each source, it includes the source's id along with a link to the source's CSV Export. It can be accessed via /json-sources (for example, http://206.12.93.196/json-sources/). It corresponds to OldCantus's json-sources API.

json_nextchants

The JSON Next Chants API exports information on which chants tend to follow chants with a given Cantus ID. It returns a list of Cantus IDs along with a tally of how many times chants with that Cantus ID followed chants with the given Cantus ID in the database. It can be accessed via /json-nextchants/<cantus_id> (for example, http://206.12.93.196/json-nextchants/007840b). It corresponds to OldCantus's json-nextchants API.

OldCantus APIs

csv

Corresponds to CantusDB's csv_export API. It can be accessed via /sites/default/files/csv/<source_id> (for example, https://cantus.uwaterloo.ca/sites/default/files/csv/123610).

json-melody

Corresponds to CantusDB's json_melody_export API. It can be accessed via /json-melody/<cantus_id> (for example, https://cantus.uwaterloo.ca/json-melody/002085).

json-node

Corresponds to CantusDB's json_node_export API. It can be accessed via /json-node/<pk> (for example, https://cantus.uwaterloo.ca/json-node/123610).

OldCantus's json-node API is used extensively in the scripts used to migrate data from OldCantus to Cantus DB.

json-sources

Corresponds to CantusDB's json_sources API. It can be accessed via /json-sources/ (for example, https://cantus.uwaterloo.ca/json-sources/).

json_nextchants

Corresponds to CantusDB's json_nextchants API. It can be accessed via /json-nextchants/<cantus_id> (for example, http://cantus.uwaterloo.ca/json-nextchants/007840b).