GET api/Data/CommunicationConfig

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
CustomerId	integer	None.
CustomerCode	string	None.
CustomerName	string	None.
ErrorMsg	string	None.
Settings	SchoolConfigSettings	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "CustomerCode": "sample string 2",
  "CustomerName": "sample string 3",
  "ErrorMsg": "sample string 4",
  "Settings": {
    "CanSendEmail": true,
    "CanSendSMS": true,
    "CanSendNotifications": true,
    "CanSendTimeline": true,
    "Preferences": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  }
}

application/xml, text/xml

Sample:

<ApiSchoolConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models">
  <CustomerCode>sample string 2</CustomerCode>
  <CustomerId>1</CustomerId>
  <CustomerName>sample string 3</CustomerName>
  <ErrorMsg>sample string 4</ErrorMsg>
  <Settings>
    <CanSendEmail>true</CanSendEmail>
    <CanSendNotifications>true</CanSendNotifications>
    <CanSendSMS>true</CanSendSMS>
    <CanSendTimeline>true</CanSendTimeline>
    <Preferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Preferences>
  </Settings>
</ApiSchoolConfigResponse>