AbodeONE

<back to all web services

CreateWorshipCredit

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/worship_credits
POST/worship_credits/create
CreateWorshipCredit Parameters:
NameParameterData TypeRequiredDescription
StudentIdbodyint?NoFilter by Abode Student PK (either StudentId -OR- Schoolid is required)
SchoolidbodystringNoFilter by external School Student ID (either StudentId -OR- Schoolid is required)
WorshipOptionIdbodyint?NoAbode Internal WorshipOption PK (either WorshipOptionId -OR- WorshipCode is required)
WorshipCodebodystringNoExternal WorshipOption identifier (either WorshipOptionId -OR- WorshipCode is required)
WorshipDatebodyDateTimeYesWorship date & time
CreditsbodyintNoCredits earned, defaults to 1 if omitted
IsPresenterbodyboolNoTrue if student was a presenter at this worship (credit total should already include bonus), default: false
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.

POST //worship_credits HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	studentId: 0,
	schoolid: String,
	worshipOptionId: 0,
	worshipCode: String,
	worshipDate: 0001-01-01,
	credits: 0,
	isPresenter: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
}