AbodeONE

<back to all web services

GetCharge

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/charges/{Id}
GetCharge Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
GetChargeResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformChargeDTONo
ResponseStatusformResponseStatusNo
ChargeDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ChargeTypeIdformintNo
StudentIdformintNo
AmountformdecimalNo
ChargeDateformDateTimeNo
DescriptionformstringNo
BuildingIdformintNo
CheckedByformstringNo
DisciplineIdformint?No
CashPaidformdecimal?No
CashPaidDateformDateTime?No
AccountPaidformdecimal?No
SubmittedDateformDateTime?No
AppliedDateformDateTime?No
Tracked Parameters:
NameParameterData TypeRequiredDescription
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo

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 //charges/{Id} HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetChargeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel.Charges">
  <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>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">String</CreatedBy>
    <CreatedDt xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">0001-01-01T00:00:00</CreatedDt>
    <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">String</ModifiedBy>
    <ModifiedDt xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">0001-01-01T00:00:00</ModifiedDt>
    <AccountPaid>0</AccountPaid>
    <Amount>0</Amount>
    <AppliedDate>0001-01-01T00:00:00</AppliedDate>
    <BuildingId>0</BuildingId>
    <CashPaid>0</CashPaid>
    <CashPaidDate>0001-01-01T00:00:00</CashPaidDate>
    <ChargeDate>0001-01-01T00:00:00</ChargeDate>
    <ChargeTypeId>0</ChargeTypeId>
    <CheckedBy>String</CheckedBy>
    <Description>String</Description>
    <DisciplineId>0</DisciplineId>
    <Id>0</Id>
    <StudentId>0</StudentId>
    <SubmittedDate>0001-01-01T00:00:00</SubmittedDate>
  </Result>
</GetChargeResponse>