Get a list of services. The fields listed here will be returned when this method is called.
POSThttps://api.elvanto.com/v1/services/getAll.{json|xml|php}
| Name | Type | Description |
|---|---|---|
| page | integer | The results page to retrieve. Default: 1 |
| page_size | integer | The number of records to retrieve per results page. Default: 1000 |
| all | string | Set this to yes if you would like to retrieve past services as well as future services. Defaults to no. This parameter is ignored when either "start" and "end" parameters are included. |
| start | date | The date to start retrieving services from. Needs to be a valid date field. E.g: 2024-12-30 |
| end | date | The date to stop retrieving services. Needs to be a valid date field. E.g: 2024-12-30 |
| status | string | This can be set to published or draft. Default shows both published and draft services. |
| service_types | string|array | The ID of the service types you'd like to include people from. Can be a string or array of ID's. |
| fields | array | Optional fields you would like to retrieve for each service. More information on service fields. |
{
"page": 1,
"page_size": 100,
"all": "yes",
"status": "published",
"fields": [
"series_name",
"service_times",
"plans",
"volunteers",
"songs",
"files",
"notes"
]
}page=1&page_size=100&all=yes&status=published&fields[0]=series_name&fields[1]=service_times&fields[2]=plans&fields[3]=volunteers&fields[4]=songs&fields[5]=files&fields[6]=notes{
"generated_in": "0.021",
"status": "ok",
"services": {
"on_this_page": 100,
"page": 1,
"per_page": 100,
"total": 668,
"service": [
{
"id": "b0b0d8d2-48dc-426e-aaba-774936274c99",
"status": 1,
"date_added": "2024-02-24 11:56:22",
"date_modified": "2024-08-27 16:17:57",
"name": "Sunday Morning",
"series_name": "The Good Fight Of Faith",
"date": "2024-08-24 09:30:00",
"description": "This service will be held outside, weather permitting!",
"service_type": {
"id": "8a631195-8914-4136-858c-f160885ab60d",
"name": "Sunday Mornings"
},
"location": {
"id": "8a631195-8914-4136-858c-f160885ab60d",
"name": "Central Campus"
},
"service_times": {
"service_time": [
{
"id": "6276c128-1fd9-11e3-8b45-5e1036dfbe18",
"date_added": "2024-02-24 11:56:22",
"date_modified": "2024-08-27 16:17:57",
"name": "First Service",
"starts": "2024-08-24 09:30:00",
"ends": "2024-08-24 11:00:00"
},
{
"id": "8ba96d3c-2a6c-11e3-92e6-005dd410cfe0",
"date_added": "2024-02-24 11:56:22",
"date_modified": "2024-08-27 16:17:57",
"name": "Second Service",
"starts": "2024-08-24 12:00:00",
"ends": "2024-08-24 13:30:00"
}
]
},
"plans": {
"plan": [
{
"time_id": "6276c128-1fd9-11e3-8b45-5e1036dfbe18",
"service_length": 5400,
"service_length_formatted": "90:00",
"total_length": 9000,
"total_length_formatted": "150:00",
"items": {
"item": [
{
"id": "f1d85614-15f2-11e4-acc9-d60ec099bdeb",
"heading": 0,
"duration": "05:00",
"when": "during",
"title": "Intro video",
"song": "",
"description": "<p>Play intro video</p>"
},
{
"id": "fae8aede-15f2-11e4-acc9-d60ec099bdeb",
"heading": 1,
"duration": "00:00",
"when": "during",
"title": "Praise & Worship",
"song": "",
"description": ""
},
{
"id": "11e4aede-15f2-fae8-acc9-d60ec099bdeb",
"heading": 0,
"duration": "05:00",
"when": "during",
"title": "How Great Is Our God",
"song": {
"id": "07327f00-c4f8-11e2-a836-d99a7990664d",
"ccli_number": "1234567",
"title": "How Great Is Our God",
"artist": "Chris Tomlin",
"album": "How Great Is Our God",
"arrangement": {
"id": "0732cbc2-c4f8-11e2-a836-d99a7990664d",
"title": "Default Arrangement",
"bpm": "78",
"duration": "05:00",
"sequence": "",
"key_name": "",
"key": "G"
}
},
"description": ""
}
]
}
}
]
},
"volunteers": {
"plan": [
{
"time_id": "6276c128-1fd9-11e3-8b45-5e1036dfbe18",
"positions": {
"position": [
{
"department_id": "ceb5ee64-8895-102d-80ee-95364de284f0",
"department_name": "Music",
"sub_department_id": "f00c45c2-8895-102d-80ee-95364de284f0",
"sub_department_name": "Vocals",
"position_id": "f00c68ea-8895-102d-80ee-95364de284f0",
"position_name": "BV1",
"volunteers": {
"volunteer": [
{
"person": {
"id": "dc37a11e-8d49-102d-815d-7f9c91035bbf",
"firstname": "John",
"preferred_name": "Jonny",
"lastname": "Smith"
},
"status": "Confirmed"
},
{
"person": {
"id": "3d3630da-9cfd-102d-bd08-842c500d506d",
"firstname": "Sandra",
"preferred_name": "",
"lastname": "Cook"
},
"status": "Unconfirmed"
}
]
}
}
]
}
}
]
},
"songs": {
"song": [
{
"id": "a3dbaee0-b84b-11e2-bcbc-2c3ca68fd88f",
"ccli_number": "12345678",
"title": "All I Need Is You",
"artist": "",
"album": "",
"arrangement": {
"id": "d88fee0-b84b-11e2-bcbc-2c3ca68fa3dba",
"title": "Default Arrangement",
"bpm": "5",
"duration": "4:56",
"sequence": "",
"key_id": "",
"key_name": "",
"key": ""
}
}
]
},
"files": {
"file": [
{
"id": "d2a59ffe-15fc-11e4-acc9-d60ec099bdeb",
"title": "Google",
"type": "File",
"html": 0,
"content": "http://www.google.com"
}
]
},
"notes": {
"note": [
{
"id": "3e88b32a-609d-11e3-9b6b-9ace39b5dd37",
"date_added": "2024-12-09 06:43:42",
"date_modified": "",
"note": "<p>A random note!</p>"
}
]
}
}
]
}
}<?xml version="1.0" encoding="UTF-8"?>
<rsp generated_in="0.021" status="ok">
<services on_this_page="100" page="1" per_page="100" total="668">
<service id="b0b0d8d2-48dc-426e-aaba-774936274c99" status="1">
<date_added>2024-02-24 11:56:22</date_added>
<date_modified>2024-08-27 16:17:57</date_modified>
<name>Sunday Morning</name>
<series_name>The Good Fight Of Faith</series_name>
<date>2024-08-24 09:30:00</date>
<description>This service will be held outside, weather permitting!</description>
<service_type id="8a631195-8914-4136-858c-f160885ab60d">
<name>Sunday Mornings</name>
</service_type>
<location id="8a631195-8914-4136-858c-f160885ab60d">
<name>Central Campus</name>
</location>
<service_times>
<service_time id="6276c128-1fd9-11e3-8b45-5e1036dfbe18">
<date_added>2024-02-24 11:56:22</date_added>
<date_modified>2024-08-27 16:17:57</date_modified>
<name>First Service</name>
<starts>2024-08-24 09:30:00</starts>
<ends>2024-08-24 11:00:00</ends>
</service_time>
<service_time id="8ba96d3c-2a6c-11e3-92e6-005dd410cfe0">
<date_added>2024-02-24 11:56:22</date_added>
<date_modified>2024-08-27 16:17:57</date_modified>
<name>Second Service</name>
<starts>2024-08-24 12:00:00</starts>
<ends>2024-08-24 13:30:00</ends>
</service_time>
</service_times>
<plans>
<plan time_id="6276c128-1fd9-11e3-8b45-5e1036dfbe18" service_length="5400" service_length_formatted="90:00" total_length="9000" total_length_formatted="150:00">
<items>
<item id="f1d85614-15f2-11e4-acc9-d60ec099bdeb" heading="0" duration="05:00">
<title>Intro video</title>
<when>during</when>
<song></song>
<description><![CDATA[<p>Play intro video</p>]]></description>
</item>
<item id="fae8aede-15f2-11e4-acc9-d60ec099bdeb" heading="0" duration="20:00">
<title>Praise &amp; Worship</title>
<when>during</when>
<song></song>
<description></description>
</item>
<item id="11e4aede-15f2-fae8-acc9-d60ec099bdeb" heading="0" duration="05:00">
<title>How Great Is Our God</title>
<when>during</when>
<song id="07327f00-c4f8-11e2-a836-d99a7990664d" ccli_number="1234567">
<title>How Great Is Our God</title>
<artist>Chris Tomlin</artist>
<album>How Great Is Our God</album>
<arrangement id="0732cbc2-c4f8-11e2-a836-d99a7990664d" bpm="78" duration="05:00">
<title>Default Arrangement</title>
<sequence></sequence>
<key_name></key_name>
<key>G</key>
</arrangement>
</song>
<description></description>
</item>
</items>
</plan>
</plans>
<volunteers>
<plan time_id="6276c128-1fd9-11e3-8b45-5e1036dfbe18">
<positions>
<position department_id="ceb5ee64-8895-102d-80ee-95364de284f0" sub_department_id="f00c45c2-8895-102d-80ee-95364de284f0" position_id="f00c68ea-8895-102d-80ee-95364de284f0">
<department_name>Music</department_name>
<sub_department_name>Vocals</sub_department_name>
<position_name>BV1</position_name>
<volunteers>
<volunteer>
<person id="dc37a11e-8d49-102d-815d-7f9c91035bbf">
<firstname>John</firstname>
<preferred_name>Jonny</preferred_name>
<lastname>Smith</lastname>
</person>
<status>Confirmed</status>
</volunteer>
<volunteer>
<person id="3d3630da-9cfd-102d-bd08-842c500d506d">
<firstname>Sandra</firstname>
<preferred_name></preferred_name>
<lastname>Cook</lastname>
</person>
<status>Unconfirmed</status>
</volunteer>
</volunteers>
</position>
</positions>
</plan>
</volunteers>
<songs>
<song>
<id>a3dbaee0-b84b-11e2-bcbc-2c3ca68fd88f</id>
<ccli_number>12345678</ccli_number>
<title>All I Need Is You</title>
<artist></artist>
<album></album>
<arrangement>
<id>d88fee0-b84b-11e2-bcbc-2c3ca68fa3dba</id>
<title>Default Arrangement</title>
<bpm>5</bpm>
<duration>4:56</duration>
<sequence></sequence>
<key_id></key_id>
<key_name></key_name>
<key></key>
</arrangement>
</song>
</songs>
<files>
<file id="d2a59ffe-15fc-11e4-acc9-d60ec099bdeb" html="0">
<title>Google</title>
<type>File</type>
<content>http://www.google.com</content>
</file>
</files>
<notes>
<note id="3e88b32a-609d-11e3-9b6b-9ace39b5dd37">
<date_added>2024-12-09 06:43:42</date_added>
<date_modified></date_modified>
<note><![CDATA[<p>A random note!</p>]]></note>
</note>
</notes>
</service>
</services>
</rsp>
stdClass Object
(
[generated_in] => 0.021
[status] => ok
[services] => stdClass Object
(
[on_this_page] => 100
[page] => 1
[per_page] => 100
[total] => 668
[service] => stdClass Object
(
[0] => stdClass Object
(
[id] => b0b0d8d2-48dc-426e-aaba-774936274c99
[status] => 1
[date_added] => 2024-02-24 11:56:22
[date_modified] => 2024-08-27 16:17:57
[name] => Sunday Morning
[series_name] => The Good Fight Of Faith
[date] => 2024-08-24 09:30:00
[description] => This service will be held outside, weather permitting!
[service_type] => stdClass Object
(
[id] => 8a631195-8914-4136-858c-f160885ab60d
[name] => Sunday Mornings
)
[location] => stdClass Object
(
[id] => 8a631195-8914-4136-858c-f160885ab60d
[name] => Central Campus
)
[service_times] => stdClass Object
(
[service_time] => stdClass Object
(
[0] => stdClass Object
(
[id] => 6276c128-1fd9-11e3-8b45-5e1036dfbe18
[date_added] => 2024-02-24 11:56:22
[date_modified] => 2024-08-27 16:17:57
[name] => First Service
[starts] => 2024-08-24 09:30:00
[ends] => 2024-08-24 11:00:00
)
[1] => stdClass Object
(
[id] => 8ba96d3c-2a6c-11e3-92e6-005dd410cfe0
[date_added] => 2024-02-24 11:56:22
[date_modified] => 2024-08-27 16:17:57
[name] => Second Service
[starts] => 2024-08-24 12:00:00
[ends] => 2024-08-24 13:30:00
)
)
)
[plans] => stdClass Object
(
[plan] => stdClass Object
(
[0] => stdClass Object
(
[time_id] => 6276c128-1fd9-11e3-8b45-5e1036dfbe18
[service_length] => 5400
[service_length_formatted] => 90:00
[total_length] => 9000
[total_length_formatted] => 150:00
[items] => stdClass Object
(
[item] => stdClass Object
(
[0] => stdClass Object
(
[id] => f1d85614-15f2-11e4-acc9-d60ec099bdeb
[heading] => 0
[duration] => 05:00
[when] => during
[title] => Intro video
[song] =>
[description] => <p>Play intro video</p>
)
[1] => stdClass Object
(
[id] => fae8aede-15f2-11e4-acc9-d60ec099bdeb
[heading] => 1
[duration] => 00:00
[when] => during
[title] => Praise & Worship
[song] =>
[description] =>
)
[2] => stdClass Object
(
[id] => 11e4aede-15f2-fae8-acc9-d60ec099bdeb
[heading] => 0
[duration] => 05:00
[when] => during
[title] => How Great Is Our God
[song] => stdClass Object
(
[id] => 07327f00-c4f8-11e2-a836-d99a7990664d
[ccli_number] => 1234567
[title] => How Great Is Our God
[artist] => Chris Tomlin
[album] => How Great Is Our God
[arrangement] => stdClass Object
(
[id] => 0732cbc2-c4f8-11e2-a836-d99a7990664d
[title] => Default Arrangement
[bpm] => 78
[duration] => 05:00
[sequence] =>
[key_name] =>
[key] => G
)
)
[description] =>
)
)
)
)
)
)
[volunteers] => stdClass Object
(
[plan] => stdClass Object
(
[0] => stdClass Object
(
[time_id] => 6276c128-1fd9-11e3-8b45-5e1036dfbe18
[positions] => stdClass Object
(
[position] => stdClass Object
(
[0] => stdClass Object
(
[department_id] => ceb5ee64-8895-102d-80ee-95364de284f0
[department_name] => Music
[sub_department_id] => f00c45c2-8895-102d-80ee-95364de284f0
[sub_department_name] => Vocals
[position_id] => f00c68ea-8895-102d-80ee-95364de284f0
[position_name] => BV1
[volunteers] => stdClass Object
(
[volunteer] => stdClass Object
(
[0] => stdClass Object
(
[person] => stdClass Object
(
[id] => dc37a11e-8d49-102d-815d-7f9c91035bbf
[firstname] => John
[preferred_name] => Jonny
[lastname] => Smith
)
[status] => Confirmed
)
[1] => stdClass Object
(
[person] => stdClass Object
(
[id] => 3d3630da-9cfd-102d-bd08-842c500d506d
[firstname] => Sandra
[preferred_name] =>
[lastname] => Cook
)
[status] => Unconfirmed
)
)
)
)
)
)
)
)
)
[songs] => stdClass Object
(
[song] => stdClass Object
(
[0] => stdClass Object
(
[id] => a3dbaee0-b84b-11e2-bcbc-2c3ca68fd88f
[ccli_number] => 12345678
[title] => All I Need Is You
[artist] =>
[album] =>
[arrangement] => stdClass Object
(
[id] => d88fee0-b84b-11e2-bcbc-2c3ca68fa3dba
[title] => Default Arrangement
[bpm] => 5
[duration] => 4:56
[sequence] =>
[key_id] =>
[key_name] =>
[key] =>
)
)
)
)
[files] => stdClass Object
(
[file] => stdClass Object
(
[0] => stdClass Object
(
[id] => d2a59ffe-15fc-11e4-acc9-d60ec099bdeb
[title] => Google
[type] => File
[html] => 0
[content] => http://www.google.com
)
)
)
[notes] => stdClass Object
(
[note] => stdClass Object
(
[0] => stdClass Object
(
[id] => 3e88b32a-609d-11e3-9b6b-9ace39b5dd37
[date_added] => 2024-12-09 06:43:42
[date_modified] =>
[note] => <p>A random note!</p>
)
)
)
)
)
)
)
Please see our response status codes documentation for details of potential error responses for any API request.