| Required role: | Admin |
| POST | /worship_credits | ||
|---|---|---|---|
| POST | /worship_credits/create |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StudentId | body | int? | No | Filter by Abode Student PK (either StudentId -OR- Schoolid is required) |
| Schoolid | body | string | No | Filter by external School Student ID (either StudentId -OR- Schoolid is required) |
| WorshipOptionId | body | int? | No | Abode Internal WorshipOption PK (either WorshipOptionId -OR- WorshipCode is required) |
| WorshipCode | body | string | No | External WorshipOption identifier (either WorshipOptionId -OR- WorshipCode is required) |
| WorshipDate | body | DateTime | Yes | Worship date & time |
| Credits | body | int | No | Credits earned, defaults to 1 if omitted |
| IsPresenter | body | bool | No | True if student was a presenter at this worship (credit total should already include bonus), default: false |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WorshipCreditId | form | int | No | |
| WorshipCategoryId | form | int? | No | |
| WorshipOptionId | form | int? | No | |
| StudentId | form | int | No | |
| SchoolId | form | string | No | |
| Name | form | string | No | |
| WorshipDate | form | DateTime | No | |
| Credits | form | int | No | |
| IsPresenter | form | bool | No | |
| ReqTerm | form | int? | No | |
| ReqWeek | form | int? | No | |
| Imported | form | bool | No | |
| Excused | form | bool | No | |
| Comment | form | string | No | |
| OverrideLimit | form | bool | No | |
| OverlimitCredits | form | int | No | |
| Source | form | string | No | |
| CreatedBy | form | string | No | |
| CreatedDt | form | DateTime? | No | |
| ModifiedBy | form | string | No | |
| ModifiedDt | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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.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
}