Fetching Data
System information
Fetch available file categories
Fetch list of file categories for agency. Since 0.34
URI: https://<im4>/filecategories
- Request-type:
GET - Parameters: none
- Return data
{mixed}(JSON)
Fetch available venues
Fetch list of all available venues.
URI: https://<im4>/venues
- Request-type:
GET - Parameters: none
- Return data
{mixed}(JSON)
Fetch available funeral types
Fetch list of all available funeral types.
URI: https://<im4>/funeraltypes
- Request-type:
GET - Parameters: none
- Return data
{mixed}(JSON)
Fetch available ceremony types
Fetch list of all available ceremony types.
URI: https://<im4>/ceremonytypes
- Request-type:
GET - Parameters: none
- Return data
{mixed}(JSON)
Fetch available text codes for project texts
Fetch lists of all available text codes available through api. All text codes with scope=public can be used by any agency.
URI: https://<im4>/textcodes/
- Request-type:
GET - Parameters: none
- Return data
{mixed}(JSON)
Fetch available autocomplete list for agency
Fetch all autocomplete lists available through api and available for agency
URI: https://<im4>/autocomplete/
- Request-type:
GET - Parameters: none
- Return data
{mixed}(JSON)
Agency specific - if cached locally – cache for each agency
Music-archive has author-information in connection to text. All authors is also available in authors-archive
Fetch available song archives
Fetch available song archives - either only archive info, archive info with songs or archive info with songs and text.
URI: https://<im4>/song_archives
?includeSongs=true|false
?includeTexts=true|false
- Request-type:
GET - Parameters:
{includeSongs}(boolean): If true – include songs in archive{includeTexts}(boolean): If true – and include songs – include texts as well - Return data
{mixed}(JSON)
Agency specific - if cached locally – cache for each agency Since 0.32
If you have a global API client with Archive access, you can include
Subsequently, for each agency, you can determine which archive should be accessible through their API client and apply the necessary filtering locally Since 0.33
?ignoreACL=true to load all song archives, regardless of whether they might be white or blacklisted for certain agencies.
This functionality can be useful for creating a local cache of our song archive.
Subsequently, for each agency, you can determine which archive should be accessible through their API client and apply the necessary filtering locally Since 0.33
Read about how to use song_id's from our archive when updating program items here.
API version
Fetch current API version.
URI: https://<im4>/version
- Request-type:
GET - Parameters: none
- Return data
{mixed}(JSON)