JISM API


API v1 - Original

Anchor: https://mouat.net.au/ism/api/v1/

The first API written back in 2015, driven by JISM-XML format datafiles and used for the original mobile apps, debugging transcription, comparison tools, sheet builders, graphing tools and feed-system for commercial product formats.
Module Path Switches Description / Use
Switch/Attribute Globals ?release=[release] Define the release-file to load. Most modules support defining this attribute, if not the default (latest publication) will be used. Example: ?release=201504
Releases /releases/ ?drafts=[bool]Get a list of the avaliable publications from JISM-XML files.
/releases/detail ?release=[release]Using release switch, get Publication details from one release.
Control /control/ - Get all controls for a release
/control/list/ ?number=[number] Using the control number, get a single control
Example: ?release=201709&number=0123
/control/words/ - Get a frequency-ordered list of all words used in all controls within this release
/control/stats/ Never implemented
control/classifications/ ?number=[number] Using the control number, get the classification markings applicable to a single control
Example: ?release=201709&number=0123
/control/compare/ ?compare=[number] Get the control changes between two publications
Example: ?release=201402&compare=201709
Content /content/table/ ?depth=[depth]Specify how deep to decend from document root.
Example: ?depth=2
/content/tree/ ?depth=[depth]Example: ?depth=2
/content/block/ Never implemented


API v2 - ONLINE

Anchor: https://mouat.net.au/ism/api/v2/

The modern rebuild of JISM-APIv1 in 2019 to support the new ACSC formatted XML files (modern format), as well as JISM XML files (classic format).
Module Path Switches Description / Use Example Link
Switch/Attribute Globals ?release=[release] Define the release-file to load. Most modules support defining this attribute, if not the default (latest publication) will be used.
Example: ?release=202001
none
?format=[format] Optionally choose what 'format' of publications to get.
Example: ?format=classic
?drafts=[bool] Optionally include any draft versions ofthe ISM which are being transcribed and unreleased.
Example: ?drafts=1
Content /content/table/ [DISABLED]
/content/tree/ -Provides a full document tree to reconstruct the publication or create a table of contents. Tree
/content/block/ Still not implemented - lol
Releases /releases/ ?format=[format] Get a list of the avaliable publications from JISM-XML files. Classic
Modern
/releases/detail ?release=[release]Using release switch, get Publication details from one release. 2020-01
Control /control/ [DISABLED]
/control/list/ [DISABLED]
control/classifications/ ?release=[release] Get the classification markings applicable to this publication.
Example: ?release=201709
Default
/control/compare/ [DISABLED]
/control/words/ -Obtains all text from all Controls in the latest publication and returns a list of the frequency those words are used.Words


API v3

Anchor: https://mouat.net.au/ism/api/v3/

yet to be documented...
Module Path Switches Description / Use Example Link


API v4

Anchor: https://mouat.net.au/ism/api/v4/

The API version used by the TISM application - This dataset frequently changes. Relational database containing multiple publications and frameworks - in active development since 2017.
Module API Path Attributes Description / Use Example
Global Attributes&publication=[uid]Define the publication UID to use for the query. When undefined, either returns all publication results or just the latest publication, depending on the module requested.
Publication /publication/?publication=[uid]Get the details of the latest publication from the TISM Database, or a specifc publication if defined.Latest
/publications/-Returns a list of 'enabled' publications.Enabled List
/publication/outline/?publication=[uid]Get the hirachial outline of the latest publication, or a specific one if defined.Outline
Control/control/?index=[index]Get a specific control using the index, from all publications that this control exists in.Index 1234.1
?number=[number]Gets most-recent revision of this control, using the number.Control 1234
?number=[number]&publication=[uid]Returns the control from a specific publication.-
/control/list/ -Get a list of controls for a defined publication, or latest if 'publication' is undefined.List
/control/words -Obtains all text from all Controls in the latest publication and returns a list of the frequency those words are used.Words
Content /content/ -Returns a list of Content objects from current (or specific) publication.-
/content/blocks/ -Return a list of Blocks from a specific Content object.-
/content/block/ -Get a specific Block and all child Blocks.-


All opinions expressed and works presented on this website remain the copyright of the owner.
- © James Mouat 2013-2021 -