Program items

External clients can fetch and handle project program items, download program schedule, get list of available program templates and import these to project.

Read more about how to update program items here.

Load program items

Fetch all project program items.
Loading program items is done through project keys as described here

URI: https://<im4>/projects/{projectId}/programitems/{'ordered'?}

• Request-type: GET
• Parameters:
  {projectId} (part of URI): ID of the project
  {'ordered'} (part of URI) (optional):Since 0.29 If 'ordered' included - program items is loaded from latest ordered booklet instead of getting projects program items
• Return data:{mixed} (JSON)

Download program schedule

Download program schedule as PDF

URI: https://<im4>/project/{projectId}/programitems/{'ordered'?}/download-schedule
?type={full?}

• Request-type: GET
• Parameters:
  {projectId} (part of URI): ID of the project
  {'ordered'} (part of URI) (optional):Since 0.29 If 'ordered' included - program items is loaded from latest ordered booklet instead of getting projects program items {type} (string): Type of schedule. If set to full song verses will be included
• Return data:{file} downloaded pdf file

Load program templates

Load a list of available program templates for project
A program template is a set of default program items used globally, by agency or by venue.
A program template can be imported to a project to make further manual setup easier

URI: https://<im4>/project/{projectId}/program_templates

• Request-type: GET
• Parameters: {projectId} (part of URI): ID of the project
• Return data: {mixed} (JSON) JSON list with template id, scope, name and number of program items

Read about how to import a program template here