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 .jsv suffix or ?format=jsv

HTTP + JSV

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.abodehms.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			worshipCreditId: 0,
			worshipCategoryId: 0,
			worshipOptionId: 0,
			studentId: 0,
			schoolId: String,
			name: String,
			worshipDate: 0001-01-01,
			credits: 0,
			isPresenter: False,
			reqTerm: 0,
			reqWeek: 0,
			imported: False,
			excused: False,
			comment: String,
			overrideLimit: False,
			overlimitCredits: 0,
			source: String,
			createdBy: String,
			createdDt: 0001-01-01,
			modifiedBy: String,
			modifiedDt: 0001-01-01
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}