GET Api/Student/GetStudentNotificationDetailByID?student={student}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
student

string

Required

Body Parameters

None.

Response Information

Resource Description

StudentNotificationDetail
NameDescriptionTypeAdditional information
StudentID

globally unique identifier

None.

SchoolID

globally unique identifier

None.

ClientID

globally unique identifier

None.

NotificationDetailList

Dictionary of integer [key] and notification_type_setting [value]

None.

NotificationTypeList

Collection of integer

None.

NotificationSettingList

Collection of notification_type_setting

None.

Response Formats

application/json, text/json

Sample:
{
  "StudentID": "fde52f7e-7f07-4339-852d-9fcca9ccdfa8",
  "SchoolID": "3b2cc635-5df9-477e-9677-d9d65ef72181",
  "ClientID": "d6a942f6-4bdb-435a-a245-7985df7ed43c",
  "NotificationDetailList": {
    "1": {
      "IsNotifyUsingSms": true,
      "IsNotifyUsingEmail": true,
      "IsNotifyUsingPortal": true,
      "IsNotifyUsingMobileApp": true
    },
    "2": {
      "IsNotifyUsingSms": true,
      "IsNotifyUsingEmail": true,
      "IsNotifyUsingPortal": true,
      "IsNotifyUsingMobileApp": true
    }
  },
  "NotificationTypeList": [
    1,
    2
  ],
  "NotificationSettingList": [
    {
      "IsNotifyUsingSms": true,
      "IsNotifyUsingEmail": true,
      "IsNotifyUsingPortal": true,
      "IsNotifyUsingMobileApp": true
    },
    {
      "IsNotifyUsingSms": true,
      "IsNotifyUsingEmail": true,
      "IsNotifyUsingPortal": true,
      "IsNotifyUsingMobileApp": true
    }
  ]
}

application/xml, text/xml

Sample:
<StudentNotificationDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
  <ClientID>d6a942f6-4bdb-435a-a245-7985df7ed43c</ClientID>
  <NotificationDetailList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintnotification_type_setting1PBo5Qe6>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>
        <IsNotifyUsingEmail>true</IsNotifyUsingEmail>
        <IsNotifyUsingMobileApp>true</IsNotifyUsingMobileApp>
        <IsNotifyUsingPortal>true</IsNotifyUsingPortal>
        <IsNotifyUsingSms>true</IsNotifyUsingSms>
      </d2p1:Value>
    </d2p1:KeyValueOfintnotification_type_setting1PBo5Qe6>
    <d2p1:KeyValueOfintnotification_type_setting1PBo5Qe6>
      <d2p1:Key>2</d2p1:Key>
      <d2p1:Value>
        <IsNotifyUsingEmail>true</IsNotifyUsingEmail>
        <IsNotifyUsingMobileApp>true</IsNotifyUsingMobileApp>
        <IsNotifyUsingPortal>true</IsNotifyUsingPortal>
        <IsNotifyUsingSms>true</IsNotifyUsingSms>
      </d2p1:Value>
    </d2p1:KeyValueOfintnotification_type_setting1PBo5Qe6>
  </NotificationDetailList>
  <NotificationSettingList>
    <notification_type_setting>
      <IsNotifyUsingEmail>true</IsNotifyUsingEmail>
      <IsNotifyUsingMobileApp>true</IsNotifyUsingMobileApp>
      <IsNotifyUsingPortal>true</IsNotifyUsingPortal>
      <IsNotifyUsingSms>true</IsNotifyUsingSms>
    </notification_type_setting>
    <notification_type_setting>
      <IsNotifyUsingEmail>true</IsNotifyUsingEmail>
      <IsNotifyUsingMobileApp>true</IsNotifyUsingMobileApp>
      <IsNotifyUsingPortal>true</IsNotifyUsingPortal>
      <IsNotifyUsingSms>true</IsNotifyUsingSms>
    </notification_type_setting>
  </NotificationSettingList>
  <NotificationTypeList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </NotificationTypeList>
  <SchoolID>3b2cc635-5df9-477e-9677-d9d65ef72181</SchoolID>
  <StudentID>fde52f7e-7f07-4339-852d-9fcca9ccdfa8</StudentID>
</StudentNotificationDetail>