POST api/v{version}/RecurringPayment/AddRecurringPayment

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

RecurringBindingModel

Name	Type	Additional information
DistrictId	integer	Required
RecurringStudentCollection	Collection of RecurringStudentModel	None.
RecurringParentCollection	RecurringParentModel	None.

Request Formats

application/json, text/json

Sample:

{
  "DistrictId": 1,
  "RecurringStudentCollection": [
    {
      "StudentId": 1,
      "StudentName": "sample string 2",
      "Amount": 3.0,
      "IdConfirmed": "sample string 4"
    },
    {
      "StudentId": 1,
      "StudentName": "sample string 2",
      "Amount": 3.0,
      "IdConfirmed": "sample string 4"
    }
  ],
  "RecurringParentCollection": {
    "Recurwalletid": 1,
    "RecurFrequency": "sample string 2",
    "RecurCount": 3,
    "RecurNextDt": "2024-05-20T00:17:02.7779081-04:00",
    "RecurLowBalanceAmt": 5
  }
}

application/xml, text/xml

Sample:

<RecurringBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.APIModels">
  <DistrictId>1</DistrictId>
  <RecurringParentCollection>
    <RecurCount>3</RecurCount>
    <RecurFrequency>sample string 2</RecurFrequency>
    <RecurLowBalanceAmt>5</RecurLowBalanceAmt>
    <RecurNextDt>2024-05-20T00:17:02.7779081-04:00</RecurNextDt>
    <Recurwalletid>1</Recurwalletid>
  </RecurringParentCollection>
  <RecurringStudentCollection>
    <RecurringStudentModel>
      <Amount>3</Amount>
      <IdConfirmed>sample string 4</IdConfirmed>
      <StudentId>1</StudentId>
      <StudentName>sample string 2</StudentName>
    </RecurringStudentModel>
    <RecurringStudentModel>
      <Amount>3</Amount>
      <IdConfirmed>sample string 4</IdConfirmed>
      <StudentId>1</StudentId>
      <StudentName>sample string 2</StudentName>
    </RecurringStudentModel>
  </RecurringStudentCollection>
</RecurringBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperationResult

Name	Description	Type	Additional information
result		string	None.

Response Formats

application/json, text/json

Sample:

{
  "result": "sample string 1"
}

application/xml, text/xml

Sample:

<OperationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models">
  <Result>sample string 1</Result>
</OperationResult>