New Life Songs API V1

Some of the service's endpoints require the client to authenticate itself to the server. See the section on authentication for details concerning authentication.

The endpoints that the API defines are:

• /songs
• /services
• /users

If you run across any problems or have questions, feel free to send me an email at jdbernard@gmail.com

/songs

Song object

id

An identifier unique to this song record among all song records. Type: integer

name

The name of the song. Type: string

artists

A list of the artists known to have written or performed this song. Type: list of strings

Example

{
  "id":8,
  "name":"Here I Am To Worship",
  "artists":[
    "Tim Hughes",
    "Chris Tomlin",
    "Michael W. Smith"
  ]
}

Method Summary

• GET /songs

  Retrieve all songs.

  Response

  A list of song objects

  Example

  GET http://newlifesongs.jdbernard.com/api/v1/songs

  HTTP/1.1 200 OK
  Content-Length: 433
  Content-Type: application/json
  Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
  
  [{"id":1,"name":"Welcome Holy Spirit","artists":["Mark Condon"]},
   {"id":3,"name":"Let's Sing Praises to our God","artists":["Traditional"]},
   {"id":5,"name":"Blessed Assurance","artists":["Frances J. Crosby"]},
   {"id":8,"name":"Here I Am To Worship","artists":["Tim Hughes", "Chris Tomlin", "Michael W.  Smith"]},
   {"id":12,"name":"Healer","artists":["Kari Jobe", "Hillsong"]},
   {"id":15,"name":"I Am Free","artists":["Newsboys"]}]
   

• POST /songs

  Create a new song record. In order to be allowed access to this method, the request must be made with a valid authentication token which belongs to a user with administrative priviliges. See Authentication for details.

  Request Body

  Must be a song object. The name field is required. Any id passed in with the request will be ignored.

  Reponse

  The newly-created song record. If a value is given in the request for the id attribute it is ignored. The attribute for new records is determined by the service and returned as part of the response.

  Example

  POST http://newlifesongs.jdbernard.com/api/v1/songs
  Content-Length: 60
  Content-Type: application/json
  
  {"id":22,"name":"This is How We Praise Him","artists":[""]}
  

  HTTP/1.1 201 Created
  Content-Length: 
  Content-Type: application/json
  
  
  

• GET /songs/<songId>

  Retrieve song data for the given song id.

  Response

  A song object.

  Example

  GET http://newlifesongs.jdbernard.com/api/v1/songs/1

  HTTP/1.1 200 OK
  Content-Length: 63
  Content-Type: application/json
  Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
  
  {"id":1,"name":"Welcome Holy Spirit","artists":["Mark Condon"]}
  

• PUT /songs/<songId>

  Method description

  Request Body

  Request body description

  Response

  Return value description

  Example

• DELETE /songs/<songId>

  Method description

  Request Body

  Request body description

  Response

  Return value description

  Example

• GET /songs/forService/<serviceId>

  Method description

  Request Body

  Request body description

  Response

  Return value description

  Example

  GET /api/v1/songs/forService/1 HTTP/1.1

  HTTP/1.1 200 OK
  Content-Length: 256
  Content-Type: application/json
  Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
  
  [{"id":7,"name":"Mighty God","artists":[""]},
   {"id":8,"name":"Here I Am To Worship","artists":["Tim Hughes: Chris Tomlin, Michael W.  Smith"]},
   {"id":9,"name":"Worthy","artists":[""]},
   {"id":4,"name":"I Am A Friend Of God","artists":["Israel Houghton"]}]j
                  

• GET /songs/byArtist/<artist>

  Method description

  Request Body

  Request body description

  Response

  Return value description

  Example

/services

Service object

id

An identifier unique to this service record among all service records. Type: integer

date

The date of the service. Type: Date

serviceType

Service type. Type: string Valid values:

Value	Description
SUN_AM	Sunday morning service.
SUN_PM	Sunday evening service
WED	Wednesday, midweek Bible study.

Example

{
  "id": 1,
  "date": 1235887200000,
  "serviceType": "SUN_PM"
}

Method Summary

/users

Authentication