POST api/{version}/Students/GetStudentSavedEmailsForMobile

This method gets all emails available for the given student for mobile

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

The student details to whom the emails shoud be loaded

StudentEmail
NameDescriptionTypeAdditional information
StudentMailId

Gets or sets the student email Id. This is the primary key value of the 'StudentMails'

integer

None.

StudentId

Gets or sets the StduentId

integer

None.

MailSentDate

Gets or sets the mail sent date.

string

None.

MailSubject

Gets or sets the mail subject of the student mail

string

None.

ReadStatus

Gets or sets the status whether the email is read by the student or not

boolean

None.

HasAttachments

Gets or sets the status whether the email has any attachments or not. The value will be true if the mail has any attachments.

boolean

None.

MailSentTime

Gets or sets the mail sent or the received time. E.g) now, 2mins ago, 2 days ago....

string

None.

MailContentText

Gets or sets the mail content trimmed to limitted characters and plain text

string

None.

IsFromMobile

boolean

None.

CurrentPageNumber

integer

None.

PageSize

integer

None.

MailCategory

string

None.

MobileTimeFormat

string

None.

Request Formats

application/json, text/json

Sample:
{
  "StudentMailId": 1,
  "StudentId": 2,
  "MailSentDate": "sample string 3",
  "MailSubject": "sample string 4",
  "ReadStatus": true,
  "HasAttachments": true,
  "MailSentTime": "sample string 7",
  "MailContentText": "sample string 8",
  "IsFromMobile": true,
  "CurrentPageNumber": 10,
  "PageSize": 11,
  "MailCategory": "sample string 12",
  "MobileTimeFormat": "sample string 13"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of StudentInbox
NameDescriptionTypeAdditional information
MailCategories

Collection of string

None.

StudentEmails

Collection of StudentEmail

None.

UnreadMailCount

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "MailCategories": [
      "sample string 1",
      "sample string 2"
    ],
    "StudentEmails": [
      {
        "StudentMailId": 1,
        "StudentId": 2,
        "MailSentDate": "sample string 3",
        "MailSubject": "sample string 4",
        "ReadStatus": true,
        "HasAttachments": true,
        "MailSentTime": "sample string 7",
        "MailContentText": "sample string 8",
        "IsFromMobile": true,
        "CurrentPageNumber": 10,
        "PageSize": 11,
        "MailCategory": "sample string 12",
        "MobileTimeFormat": "sample string 13"
      },
      {
        "StudentMailId": 1,
        "StudentId": 2,
        "MailSentDate": "sample string 3",
        "MailSubject": "sample string 4",
        "ReadStatus": true,
        "HasAttachments": true,
        "MailSentTime": "sample string 7",
        "MailContentText": "sample string 8",
        "IsFromMobile": true,
        "CurrentPageNumber": 10,
        "PageSize": 11,
        "MailCategory": "sample string 12",
        "MobileTimeFormat": "sample string 13"
      }
    ],
    "UnreadMailCount": 1
  },
  {
    "MailCategories": [
      "sample string 1",
      "sample string 2"
    ],
    "StudentEmails": [
      {
        "StudentMailId": 1,
        "StudentId": 2,
        "MailSentDate": "sample string 3",
        "MailSubject": "sample string 4",
        "ReadStatus": true,
        "HasAttachments": true,
        "MailSentTime": "sample string 7",
        "MailContentText": "sample string 8",
        "IsFromMobile": true,
        "CurrentPageNumber": 10,
        "PageSize": 11,
        "MailCategory": "sample string 12",
        "MobileTimeFormat": "sample string 13"
      },
      {
        "StudentMailId": 1,
        "StudentId": 2,
        "MailSentDate": "sample string 3",
        "MailSubject": "sample string 4",
        "ReadStatus": true,
        "HasAttachments": true,
        "MailSentTime": "sample string 7",
        "MailContentText": "sample string 8",
        "IsFromMobile": true,
        "CurrentPageNumber": 10,
        "PageSize": 11,
        "MailCategory": "sample string 12",
        "MobileTimeFormat": "sample string 13"
      }
    ],
    "UnreadMailCount": 1
  }
]