POST api/v{version}/Meals/GetMealPaymentDetails

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

LunchPaymentModel
NameDescriptionTypeAdditional information
StudentId

integer

Required

DistrictId

integer

Required

FirstName

string

None.

LunchPaymentAmount

decimal number

None.

LunchBalance

decimal number

None.

TransactionId

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "StudentId": 1,
  "DistrictId": 2,
  "FirstName": "sample string 3",
  "LunchPaymentAmount": 4.1,
  "LunchBalance": 5.1,
  "TransactionId": 6.1
}

application/xml, text/xml

Sample:
<LunchPaymentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.APIModels">
  <DistrictId>2</DistrictId>
  <FirstName>sample string 3</FirstName>
  <LunchBalance>5.1</LunchBalance>
  <LunchPaymentAmount>4.1</LunchPaymentAmount>
  <StudentId>1</StudentId>
  <TransactionId>6.1</TransactionId>
</LunchPaymentModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LunchPaymentTransModelWithRecurringStatus
NameDescriptionTypeAdditional information
LunchPaymentTransactionModel

LunchPaymentTransactionModel

None.

IsRecurringEnabled

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "LunchPaymentTransactionModel": {
    "TransactionId": 1,
    "SchoolFeeId": 2,
    "StudentId": 1,
    "PaymentHistoryId": 1,
    "DirectDeposit": true,
    "Amount": 3.0
  },
  "IsRecurringEnabled": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.