POST api/GetEligibilityNotificationsByStudentIds

Request Information

URI Parameters

None.

Body Parameters

PersonList
NameDescriptionTypeAdditional information
PersonIds

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PersonIds": "sample string 1"
}

application/xml, text/xml

Sample: 
<PersonList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.EligibilityNotifications">
  <PersonIds>sample string 1</PersonIds>
</PersonList>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PersonList'.

Response Information

Resource Description

Collection of EligibilityNotificationsModel
NameDescriptionTypeAdditional information
LetterNotificationHistoryId

integer

None.
AcademicYear

string

None.
Date

string

None.
Subject

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "LetterNotificationHistoryId": 1,
    "AcademicYear": "sample string 2",
    "Date": "sample string 3",
    "Subject": "sample string 4"
  },
  {
    "LetterNotificationHistoryId": 1,
    "AcademicYear": "sample string 2",
    "Date": "sample string 3",
    "Subject": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfEligibilityNotificationsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.EligibilityNotifications">
  <EligibilityNotificationsModel>
    <AcademicYear>sample string 2</AcademicYear>
    <Date>sample string 3</Date>
    <LetterNotificationHistoryId>1</LetterNotificationHistoryId>
    <Subject>sample string 4</Subject>
  </EligibilityNotificationsModel>
  <EligibilityNotificationsModel>
    <AcademicYear>sample string 2</AcademicYear>
    <Date>sample string 3</Date>
    <LetterNotificationHistoryId>1</LetterNotificationHistoryId>
    <Subject>sample string 4</Subject>
  </EligibilityNotificationsModel>
</ArrayOfEligibilityNotificationsModel>