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 .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.

GET //worship_credits HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorshipCreditsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <WorshipCreditDTO>
      <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>
  </Result>
</WorshipCreditsResponse>