| Required role: | Admin |
| GET | /worship_credits |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StudentId | query | int? | No | Filter by Abode Student PK (AND) |
| Schoolid | query | string | No | Filter by external School Student ID (AND, but usually send Schoolid -OR- StudentId) |
| TermId | query | int? | No | Filter by Abode Term PK (AND) |
| TermCode | query | string | No | Filter by external School Term Code (AND, but send only TermId -OR- TermCode) |
| WorshipOptionId | query | int? | No | Filter by Abode WorshipOption PK (AND) |
| WorshipDate | query | DateTime? | No | Filter by Abode Date of Worship (AND) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | List<WorshipCreditDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| 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.
GET //worship_credits HTTP/1.1 Host: api.lsu-staging.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
}
}
}