POST api/CircularChange/GetCircularList

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Circular		Collection of StudentRequest	None.

Request Formats

application/json, text/json

Sample:

{
  "Circular": [
    {
      "StudentMasterId": "sample string 1",
      "ClassSectionInstituteYearId": "sample string 2",
      "LastUpdatedTick": "sample string 3"
    },
    {
      "StudentMasterId": "sample string 1",
      "ClassSectionInstituteYearId": "sample string 2",
      "LastUpdatedTick": "sample string 3"
    }
  ]
}

text/html

Sample:

{"Circular":[{"StudentMasterId":"sample string 1","ClassSectionInstituteYearId":"sample string 2","LastUpdatedTick":"sample string 3"},{"StudentMasterId":"sample string 1","ClassSectionInstituteYearId":"sample string 2","LastUpdatedTick":"sample string 3"}]}

application/xml, text/xml

Sample:

<StudentCircularRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartInstituteSoftware.Models">
  <Circular>
    <StudentRequest>
      <ClassSectionInstituteYearId>sample string 2</ClassSectionInstituteYearId>
      <LastUpdatedTick>sample string 3</LastUpdatedTick>
      <StudentMasterId>sample string 1</StudentMasterId>
    </StudentRequest>
    <StudentRequest>
      <ClassSectionInstituteYearId>sample string 2</ClassSectionInstituteYearId>
      <LastUpdatedTick>sample string 3</LastUpdatedTick>
      <StudentMasterId>sample string 1</StudentMasterId>
    </StudentRequest>
  </Circular>
</StudentCircularRequest>

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

Response Information

Resource Description

StudentCircularResponse

Name	Type	Additional information
Message	string	None.
ResultFlag	string	None.
StudentCirculars	Collection of StudentCircular	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "ResultFlag": "sample string 2",
  "StudentCirculars": [
    {
      "StudentMasterId": "sample string 1",
      "LastUpdatedTick": "sample string 2",
      "CircularList": [
        {
          "InstituteYearId": "sample string 1",
          "CircularId": "sample string 2",
          "CircularTitle": "sample string 3",
          "CircularText": "sample string 4",
          "CircularDate": "sample string 5",
          "CircularUrl": "sample string 6"
        },
        {
          "InstituteYearId": "sample string 1",
          "CircularId": "sample string 2",
          "CircularTitle": "sample string 3",
          "CircularText": "sample string 4",
          "CircularDate": "sample string 5",
          "CircularUrl": "sample string 6"
        }
      ]
    },
    {
      "StudentMasterId": "sample string 1",
      "LastUpdatedTick": "sample string 2",
      "CircularList": [
        {
          "InstituteYearId": "sample string 1",
          "CircularId": "sample string 2",
          "CircularTitle": "sample string 3",
          "CircularText": "sample string 4",
          "CircularDate": "sample string 5",
          "CircularUrl": "sample string 6"
        },
        {
          "InstituteYearId": "sample string 1",
          "CircularId": "sample string 2",
          "CircularTitle": "sample string 3",
          "CircularText": "sample string 4",
          "CircularDate": "sample string 5",
          "CircularUrl": "sample string 6"
        }
      ]
    }
  ]
}

text/html

Sample:

{"Message":"sample string 1","ResultFlag":"sample string 2","StudentCirculars":[{"StudentMasterId":"sample string 1","LastUpdatedTick":"sample string 2","CircularList":[{"InstituteYearId":"sample string 1","CircularId":"sample string 2","CircularTitle":"sample string 3","CircularText":"sample string 4","CircularDate":"sample string 5","CircularUrl":"sample string 6"},{"InstituteYearId":"sample string 1","CircularId":"sample string 2","CircularTitle":"sample string 3","CircularText":"sample string 4","CircularDate":"sample string 5","CircularUrl":"sample string 6"}]},{"StudentMasterId":"sample string 1","LastUpdatedTick":"sample string 2","CircularList":[{"InstituteYearId":"sample string 1","CircularId":"sample string 2","CircularTitle":"sample string 3","CircularText":"sample string 4","CircularDate":"sample string 5","CircularUrl":"sample string 6"},{"InstituteYearId":"sample string 1","CircularId":"sample string 2","CircularTitle":"sample string 3","CircularText":"sample string 4","CircularDate":"sample string 5","CircularUrl":"sample string 6"}]}]}

application/xml, text/xml

Sample:

<StudentCircularResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartInstituteSoftware.Models">
  <Message>sample string 1</Message>
  <ResultFlag>sample string 2</ResultFlag>
  <StudentCirculars>
    <StudentCircular>
      <CircularList>
        <CircularItem>
          <CircularDate>sample string 5</CircularDate>
          <CircularId>sample string 2</CircularId>
          <CircularText>sample string 4</CircularText>
          <CircularTitle>sample string 3</CircularTitle>
          <CircularUrl>sample string 6</CircularUrl>
          <InstituteYearId>sample string 1</InstituteYearId>
        </CircularItem>
        <CircularItem>
          <CircularDate>sample string 5</CircularDate>
          <CircularId>sample string 2</CircularId>
          <CircularText>sample string 4</CircularText>
          <CircularTitle>sample string 3</CircularTitle>
          <CircularUrl>sample string 6</CircularUrl>
          <InstituteYearId>sample string 1</InstituteYearId>
        </CircularItem>
      </CircularList>
      <LastUpdatedTick>sample string 2</LastUpdatedTick>
      <StudentMasterId>sample string 1</StudentMasterId>
    </StudentCircular>
    <StudentCircular>
      <CircularList>
        <CircularItem>
          <CircularDate>sample string 5</CircularDate>
          <CircularId>sample string 2</CircularId>
          <CircularText>sample string 4</CircularText>
          <CircularTitle>sample string 3</CircularTitle>
          <CircularUrl>sample string 6</CircularUrl>
          <InstituteYearId>sample string 1</InstituteYearId>
        </CircularItem>
        <CircularItem>
          <CircularDate>sample string 5</CircularDate>
          <CircularId>sample string 2</CircularId>
          <CircularText>sample string 4</CircularText>
          <CircularTitle>sample string 3</CircularTitle>
          <CircularUrl>sample string 6</CircularUrl>
          <InstituteYearId>sample string 1</InstituteYearId>
        </CircularItem>
      </CircularList>
      <LastUpdatedTick>sample string 2</LastUpdatedTick>
      <StudentMasterId>sample string 1</StudentMasterId>
    </StudentCircular>
  </StudentCirculars>
</StudentCircularResponse>