AbodeONE

<back to all web services

FindWorshipCredits

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/worship_credits
FindWorshipCredits Parameters:
NameParameterData TypeRequiredDescription
StudentIdqueryint?NoFilter by Abode Student PK (AND)
SchoolidquerystringNoFilter by external School Student ID (AND, but usually send Schoolid -OR- StudentId)
TermIdqueryint?NoFilter by Abode Term PK (AND)
TermCodequerystringNoFilter by external School Term Code (AND, but send only TermId -OR- TermCode)
WorshipOptionIdqueryint?NoFilter by Abode WorshipOption PK (AND)
WorshipDatequeryDateTime?NoFilter by Abode Date of Worship (AND)
WorshipCreditsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<WorshipCreditDTO>No
ResponseStatusformResponseStatusNo
WorshipCreditDTO Parameters:
NameParameterData TypeRequiredDescription
WorshipCreditIdformintNo
WorshipCategoryIdformint?No
WorshipOptionIdformint?No
StudentIdformintNo
SchoolIdformstringNo
NameformstringNo
WorshipDateformDateTimeNo
CreditsformintNo
IsPresenterformboolNo
ReqTermformint?No
ReqWeekformint?No
ImportedformboolNo
ExcusedformboolNo
CommentformstringNo
OverrideLimitformboolNo
OverlimitCreditsformintNo
SourceformstringNo
CreatedByformstringNo
CreatedDtformDateTime?No
ModifiedByformstringNo
ModifiedDtformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET //worship_credits HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'WorshipCreditsResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)