http://newlifesongs.jdbernard.com/api/v1
as a base
URL.
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:
If you run across any problems or have questions, feel free to send me an email at jdbernard@gmail.com
/songs
{ "id":8, "name":"Here I Am To Worship", "artists":[ "Tim Hughes", "Chris Tomlin", "Michael W. Smith" ] }
HTTP Action | Path | Description | Public? |
---|---|---|---|
GET | /songs |
Retrieve all songs. | yes |
POST | /songs |
Create a new song record. | no |
GET | /songs/<songId> |
Retrieve a single record. | yes |
PUT | /songs/<songId> |
Update a song record. | no |
DELETE | /songs/<songId> |
Delete a song record. | no |
GET | /songs/forService/<serviceId> |
Retrieve all songs performed in a given service. | yes |
GET | /songs/byArtist/<artist> |
Retrieve all songs performed by a given artist. | yes |
GET /songs
Retrieve all songs.
GET http://newlifesongs.jdbernard.com/api/v1/songs
HTTP/1.1 200 OK Content-Length: 5146 Content-Type: application/json Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS Server: Jetty(6.1.25) [{"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.
name
field is required. Any id
passed
in with the request will be ignored.
GET /songs/<songId>
Retrieve song data for the given song id.
PUT /songs/<songId>
Method description
DELETE /songs/<songId>
Method description
GET /songs/forService/<serviceId>
Method description
DELETE /songs/byArtist/<artist>
Method description
/services
/users