Search
Data Web-Service API List
In my other life, I am data scientist at the University of Pennsylvania. I believe in a philosophy of open-source technology and sharing of data resources. To that end, this is a page of data web-services to datamine https://www.thechoirmaster.com (I know that no one wold really ever need my data - so lets call it documentation as well). To use these services, you will need a registered user account. I write all of my code (PHP) by hand - I don't believe in frameworks, so these are not full web-services with all the verbs - only the 'POST' verb is available for data returns ('GET' is reserved for the display website). All data returns are in JSON format and all example code on this page uses Linux cURL. The list of data web-services end-points are below.
Fifty Nine web-services have been found.
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
audio-content-file
Service Name
File Contents: Audio File
Service Description
A return of the file contents of an audio file encoded in BASE64 format
Payload Required
Specify the audio file to read
{"file":"","control":""}
Data Element
Type
Explanantion/Example
file
[STRING]
NAME-OF-FILE-ON-SERVER-NO-EXTENTION [ex. 9_ChristWhoseGlory]
control
STRING
PLAYER-CONTROL-ID [ex. ex1uSZU84LLUYNn] / This is a holder value for the website functionality
Return Response Example
Example of Return
{"MESSAGE":[],"ITEMSFOUND":1,"DATA":{"controlref":"ex1uSZU84LLUYNn","audiosrc":"data:audio/mpeg;base64,SUQzBABAAAABFQAAA...}}
Data Element
Type
Explanantion/Example
MESSAGE
[Array]
Any messages from the server about the failure or success of the data service are listed in an array at the beginning of the package
ITEMSFOUND
[Integer]
Count of top-level data objects found by the request. Default is zero, zero does not indicate a null or failure.
DATA
[Array]
An array of data objects and/or elements requested by the service. Data structure is outlined in this continued listing.
controlref
[String]
The control reference passed to the service is passed back. This is a placeholder reference.
audiosrc
[Long String]
The file contents of the requested audio file (if found and accessible) in a Base64 Encoded format .
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
curl -X POST -k -H 'Authorization: Basic ACCOUNT-CREDENTIALS' -i 'https://www.thechoirmaster.com/audio-content-file' --data '{"file":"9_ChristWhoseGlory","control":"ex1uSZU84LLUYNn"}'
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
blog
Service Name
Data Return for Thoughts/Blog
Service Description
A return of the data record of the listing and/or the blog (thought) entry depending on the payload passed to the service
Payload Required
Blog abstract page. Each page contains five entries. This default to page 1.
{"requestarr":"["","blog"]"}
requestarr
[Array]
Array values (non-associative): 1) zero-length string; 2) the string value "blog"
Blog abstract specific page. Each page contains five entries.
{"requestarr":"["","blog","page",1]"}
requestarr
[Array]
Array values (non-associative): 1) zero-length string; 2) the string value "blog", 3) the string value "page", 4) an integer value of the abstract page requested - null value defaults to 1.
Blog Text
{"requestarr":"["","blog","blogid-uri"]"}
requestarr
[Array]
Array values (non-associative) : 1) zero-length string; 2) the string value "blog", 3) the string value of the blogid uri listed in the abstract data return
Return Response Example
Example of Return (Abstract Page: First two Payloads above)
{"MESSAGE":[],"ITEMSFOUND":1,"DATA":{"blogdisplay":"LISTING","blogabstracts":[{"blogid":"...","bydate":"...","byline":"...","representationpic":"...","blogtitle":"...","abstract":"...","tags":[]}],"completeblogtotal":1,"totalpages":1,"bloglistpage":1,"blogliststart":1,"bloglistend":1}}
Data Element
Type
Explanantion/Example
MESSAGE
[Array]
Any messages from the server about the failure or success of the data service are listed in an array at the beginning of the package
ITEMSFOUND
[Integer]
Count of top-level data objects found by the request. Default is zero, zero does not indicate a null or failure.
DATA
[Array]
An array of data objects and/or elements requested by the service. Data structure is outlined in this continued listing.
» blogdisplay
[String]
List of Values: LISTING | BLOG; For abstract request this value will be LISTING.
» completeblogtotal
[Integer]
Total number of blog entries found
» totalpages
[Integer]
Blog entries divided by five to give the number of abstract pages available. Default is 1. Floor of value is displayed
» bloglistpage
[Integer]
The page requested from the data payload
» blogliststart
[Integer]
The blog count start value - example page 2 begins at 6 page 3 begins at 12 etc
» bloglistend
[Integer]
The blog count end value - five above blogliststart
» blogabstracts
[Array]
Associative Array of values - see continued list for explanations of data elements
»» blogid
[string]
The URI of the blog under the common tree top of the data website
»» bydate
[string]
Date of the blog entry
»» representationpic
[string]
Database key of the picture selector for a respresentative picture
»» blogtitle
[string]
The Title of the Blog
»» abstract
[string]
Stripped of html tags (except bold, underlines and italics) 350 character-length string (if blog is shorter than 350 variable-length string).
»» tags
[array]
Array of terms for tagging the blog
Example of Return (Blog Page: Third Payload Request above)
{"MESSAGE":[] ,"ITEMSFOUND":1 ,"DATA":{"blogdisplay":"BLOG" ,"response":200 ,"blogcontent":{"blogid":"..." ,"title":"..." ,"byline":"..." ,"byweekday":"..." ,"bymonth":"..." ,"byday":"..." ,"byyear":"..." ,"byondsp":"..." ,"toppicture":"..." ,"text":"..." ,"tags":[] ,"picturewidth":1 ,"pictureheight":1 ,"picture":1 ,"caption":"..." ,"takenby":"..." ,"takenon":"..." ,"toppicbytecode":"url('data:image/png;base64,...')"}}}
Data Element
Type
Explanantion/Example
MESSAGE
[Array]
Any messages from the server about the failure or success of the data service are listed in an array at the beginning of the package
ITEMSFOUND
[Integer]
Count of top-level data objects found by the request. Default is zero, zero does not indicate a null or failure.
DATA
[Array]
An array of data objects and/or elements requested by the service. Data structure is outlined in this continued listing.
» blogdisplay
[String]
List of Values: LISTING | BLOG; For blog entry request this value will be BLOG.
» response
[Integr]
If a blog is found the response is 200
» blogcontent
[Array]
Associative Array of values - see continued list for explanations of data elements
»» blogid
[String]
URI of blog entry
»» title
[String]
Title of blog entry
»» byline
[String]
By-Line of Blog Entry
»» byweekday / bymonth / byday / byyear / byondsp
[String]
Component values of the blog's written date (dsp stands for display)
»» toppicture
[String]
If a picture has been specified for the blog's top picture the database selector value is listed here.
»» text
[String]
Complete text of the blog as a PHP HTML encoded string - must be HTML decoded to display correctly.
»» tags
[Array]
Non-Associative Array of Terms to tag the blog
»» picturewidth / pictureheight / picture
[Integer]
Values Integers of the true dimension of the picture file as viewed on the server
»» caption / takenby / takenon
[String]
Entries about the toppicture (if applicable) from the database
»» toppicbytecode
[Long-String]
The file content of the specified picture as a URI-source, base64 encoded string
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
curl -X POST -k -H 'Authorization: Basic ACCOUNT-CREDENTIALS' -i 'https://dev.thechoirmaster.com/blog' --data '{"requestarr":"[\"\",\"blog\",\"\"]"}'
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
church-details
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
church-list
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
dialog-subscribe-blog
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
gen-captcha
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
generate-hymn-metric-graphic
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
get-blog-title
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
get-church-display-name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
get-institution-name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
get-music-album-title
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
get-picture-gallery-title
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
get-video-gallery-title
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
get-video-title
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
hymnal-search
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
hymn-info-gather
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
latest-blog-post
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
latest-video
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
music-album-listing
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
music-schedules
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
music-schedules-display
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
next-or-last-service
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
picture-by-selector
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
picture-gallery
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
post-these-comments
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
preprocess-run-curl
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
public-comment-list
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
random-audio-album
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
random-photo-gallery
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
random-short-quote
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
search-request
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
search-result-data
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
service-count-day
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
service-metrics
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
subscribe-website
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
template-function
Service Name
Programming Interface Template
Service Description
A basic template for programming against. This web-service does nothing for the system and generates no data. Use as a communication test only.
Payload Required
NO PAYLOAD REQUIRED
Return Response Example
{"MESSAGE":[],"ITEMSFOUND":0,"DATA":[]}
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
curl -X POST -k -H 'Authorization: Basic ACCOUNT-CREDENTIALS' -i 'https://www.thechoirmaster.com/template-function'
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
Method Name
video-channel
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
Method Name
web-services
Service Name
List of Web Services
Service Description
A list of available thechoirmaster.com web service APIs
Payload Required
NO PAYLOAD REQUIRED
Return Response Example
{"MESSAGE":[],"ITEMSFOUND":0,"DATA":[{"methodName":"..."}]}
Possible Return Codes
Possible Return Codes
Code
Value
Explanation
200
Success
Unsuccesful responses may include a message in the return response MESSAGE data element
400
Bad Request
See data element MESSAGE for specifics. Check data payload that all elements exist and contain the correct value
401
User Not Authorized
Incorrect and/or expired user credentials passed in request header
404
Service/Method Not Found
End-point URI was not found in the service. Check URI for correct value
503
Service Unavailable
Contact Zack - There is an issue with the choirmaster website
cURL example
curl -X POST -k -H 'Authorization: Basic ACCOUNT-CREDENTIALS' -i 'https://www.thechoirmaster.com/web-services'
Method Name
youtube-by-selector
Service Name
Service Description
Payload Required
Return Response Example
Possible Return Codes
cURL example
2016-2024 code & web-content: Zack von Menchhofen. (Use of code and content can be licensed under a 