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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreateWorshipCredit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <Credits>0</Credits>
  <IsPresenter>false</IsPresenter>
  <Schoolid>String</Schoolid>
  <StudentId>0</StudentId>
  <WorshipCode>String</WorshipCode>
  <WorshipDate>0001-01-01T00:00:00</WorshipDate>
  <WorshipOptionId>0</WorshipOptionId>
</CreateWorshipCredit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorshipCreditDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <Comment>String</Comment>
  <CreatedBy>String</CreatedBy>
  <CreatedDt>0001-01-01T00:00:00</CreatedDt>
  <Credits>0</Credits>
  <Excused>false</Excused>
  <Imported>false</Imported>
  <IsPresenter>false</IsPresenter>
  <ModifiedBy>String</ModifiedBy>
  <ModifiedDt>0001-01-01T00:00:00</ModifiedDt>
  <Name>String</Name>
  <OverlimitCredits>0</OverlimitCredits>
  <OverrideLimit>false</OverrideLimit>
  <ReqTerm>0</ReqTerm>
  <ReqWeek>0</ReqWeek>
  <SchoolId>String</SchoolId>
  <Source>String</Source>
  <StudentId>0</StudentId>
  <WorshipCategoryId>0</WorshipCategoryId>
  <WorshipCreditId>0</WorshipCreditId>
  <WorshipDate>0001-01-01T00:00:00</WorshipDate>
  <WorshipOptionId>0</WorshipOptionId>
</WorshipCreditDTO>