Updating Data

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 fetch program items here.

Update program items

Updating program items is done through project keys as described here

Keep in mind the entire program will be replaced with the new payload
URI: https://<im4>/project/{projectId}
  • Request-type: POST
  • URI Parameters: {projectId}: ID of the project
  • Body Parameters:
{
  "data": {
    "programitems": [
      {
        "type": "String",
        "sortcode": "Integer",
        "data": "Object"
      }
    ]
  }
}
  • Return data: 200 OK
Program item of type song has a few different options.
  • If data-field song_id is used - we find a song in our archive
  • If data-field title is used and NOT text - we try to find a match in our archive

    If a song is found in our archive, values from that song will override other input values. The title is formatted based on agency preferences and data-field verses can be used to select a specific set of verses from our archive.

Import program template

Import a program template to project
This will replace all existing program items with program items from program template

URI: https://<im4>/project/{projectId}/programitems/import/{sourcetemplate}
  • Request-type: POST
  • Parameters:
    {projectId} (part of URI): ID of the project
    {sourcetemplate} (part of URI): Program template id
  • Return data: HTTP 200 on success

Read about how to fetch program template here