GET api/Circular/GetCircularList?InstituteYearId={InstituteYearId}&StudentId={StudentId}&AppVersion={AppVersion}

Request Information

URI Parameters

Name	Type	Additional information
InstituteYearId	string	Required
StudentId	string	Required
AppVersion	string	Required

Body Parameters

None.

Response Information

Resource Description

CircularListObject

Name	Type	Additional information
ResultFlag	string	None.
Message	string	None.
CircularList	Collection of CircularObject	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultFlag": "sample string 1",
  "Message": "sample string 2",
  "CircularList": [
    {
      "Id": "sample string 1",
      "MessageTitle": "sample string 2",
      "MessageText": "sample string 3",
      "Date": "sample string 4",
      "IsUrl": "sample string 5",
      "DateTime": "sample string 6",
      "IsUrlType": "sample string 7",
      "IsDelete": "sample string 8",
      "sName": "sample string 9"
    },
    {
      "Id": "sample string 1",
      "MessageTitle": "sample string 2",
      "MessageText": "sample string 3",
      "Date": "sample string 4",
      "IsUrl": "sample string 5",
      "DateTime": "sample string 6",
      "IsUrlType": "sample string 7",
      "IsDelete": "sample string 8",
      "sName": "sample string 9"
    }
  ]
}

text/html

Sample:

{"ResultFlag":"sample string 1","Message":"sample string 2","CircularList":[{"Id":"sample string 1","MessageTitle":"sample string 2","MessageText":"sample string 3","Date":"sample string 4","IsUrl":"sample string 5","DateTime":"sample string 6","IsUrlType":"sample string 7","IsDelete":"sample string 8","sName":"sample string 9"},{"Id":"sample string 1","MessageTitle":"sample string 2","MessageText":"sample string 3","Date":"sample string 4","IsUrl":"sample string 5","DateTime":"sample string 6","IsUrlType":"sample string 7","IsDelete":"sample string 8","sName":"sample string 9"}]}

application/xml, text/xml

Sample:

<CircularModels.CircularListObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartInstituteSoftware.Models">
  <CircularList>
    <CircularModels.CircularObject>
      <Date>sample string 4</Date>
      <DateTime>sample string 6</DateTime>
      <Id>sample string 1</Id>
      <IsDelete>sample string 8</IsDelete>
      <IsUrl>sample string 5</IsUrl>
      <IsUrlType>sample string 7</IsUrlType>
      <MessageText>sample string 3</MessageText>
      <MessageTitle>sample string 2</MessageTitle>
      <sName>sample string 9</sName>
    </CircularModels.CircularObject>
    <CircularModels.CircularObject>
      <Date>sample string 4</Date>
      <DateTime>sample string 6</DateTime>
      <Id>sample string 1</Id>
      <IsDelete>sample string 8</IsDelete>
      <IsUrl>sample string 5</IsUrl>
      <IsUrlType>sample string 7</IsUrlType>
      <MessageText>sample string 3</MessageText>
      <MessageTitle>sample string 2</MessageTitle>
      <sName>sample string 9</sName>
    </CircularModels.CircularObject>
  </CircularList>
  <Message>sample string 2</Message>
  <ResultFlag>sample string 1</ResultFlag>
</CircularModels.CircularListObject>