songs/getAll

Get a list of songs. The fields listed here will be returned when this method is called.

POST https://api.elvanto.com/v1/songs/getAll.{json|xml|php}

Parameters

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
title string Search for songs with specific titles.
artist string Search for songs with specific artist.
lyrics string Search for songs with specific lyrics.
files boolean Return attached files.
Expected request JSON HTTP POST
{
    "page": 1,
    "page_size": 100,
    "files": true
}
Expected response JSON XML PHP
{
    "generated_in": "0.021",
    "status": "ok",
    "songs": {
        "on_this_page": 100,
        "page": 1,
        "per_page": 100,
        "total": 668,
        "song": [
            {
                "id": "84937df8-e993-11e2-b739-a20c5589acc5",
                "status": 1,
                "date_added": "2016-02-24 11:56:22",
                "date_modified": "2016-08-27 16:17:57",
                "title": "Adonai",
                "permalink": "adonai",
                "number": "12345678",
                "item": 1,
                "learn": 0,
                "allow_downloads": 1,
                "artist": "Mia Fieldes, Raymond Badham",
                "album": "",
                "notes": "",
                "categories": {
                    "category": [
                        {
                            "id": "dhe398d8-a251-102c-a245-1559817ce81a",
                            "name": "Praise"
                        }
                    ]
                },
                "locations": {
                    "location": [
                        {
                            "id": "d7r998d8-a251-102c-a245-1559817ce81a",
                            "name": "South Campus"
                        }
                    ]
                }
            }
        ]
    }
}
Error responses:

Please see our response status codes documentation for details of potential error responses for any API request.

  • 250: Invalid page number The page number you have provided is invalid.
  • 250: Invalid page size The page size must be between 10 and 1000.
  • 404: No songs match your criteria The system could not find any songs based on your criteria.