POST v4/networks/messagecenter/distributionlist/load

No documentation available.

Request Information

Parameters

Name	Description	Additional information
inVO	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "schoolID": "sample string 1",
  "distrListID": 2,
  "curUserId": "sample string 3",
  "isSSO": true,
  "requestHost": "sample string 5",
  "applicationPath": "sample string 6",
  "secureApplicationPath": "sample string 7",
  "absoluteApplicationPath": "sample string 8",
  "isHttps": true,
  "isMobileDevice": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 12",
  "clientOS": "sample string 13",
  "clientBuild": "sample string 14",
  "premiumAppId": "sample string 15",
  "clientWidth": 16,
  "clientHeight": 17,
  "timezone": 18
}

application/xml, text/xml

Sample:

<DistrListInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input.Network">
  <ClientHeight xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">17</ClientHeight>
  <ClientType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">Site</ClientType>
  <ClientWidth xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">16</ClientWidth>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 8</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 6</applicationPath>
  <cachedKey xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</cachedKey>
  <clientBuild xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 14</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 13</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 12</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 3</curUserId>
  <isFullEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isFullEmbed>
  <isHttps xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isHttps>
  <isMobileDevice xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isMobileDevice>
  <isSSO xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isSSO>
  <premiumAppId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 15</premiumAppId>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 5</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 7</secureApplicationPath>
  <timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">18</timezone>
  <DistrListID>2</DistrListID>
  <SchoolID>sample string 1</SchoolID>
</DistrListInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "schoolID": "sample string 1",
  "name": "sample string 2",
  "excludedMembers": "sample string 3",
  "distrList": [
    {
      "desc": "sample string 1",
      "type": 2,
      "idOrSql": "sample string 3",
      "count": 4,
      "email": "sample string 5",
      "cellPhone": "sample string 6"
    },
    {
      "desc": "sample string 1",
      "type": 2,
      "idOrSql": "sample string 3",
      "count": 4,
      "email": "sample string 5",
      "cellPhone": "sample string 6"
    },
    {
      "desc": "sample string 1",
      "type": 2,
      "idOrSql": "sample string 3",
      "count": 4,
      "email": "sample string 5",
      "cellPhone": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<MessageCenterHelper.DistributionListVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Utils.School">
  <DistrList>
    <MessageCenterHelper.MessageRecipientVO>
      <CellPhone>sample string 6</CellPhone>
      <Count>4</Count>
      <Desc>sample string 1</Desc>
      <Email>sample string 5</Email>
      <IdOrSql>sample string 3</IdOrSql>
      <Type>2</Type>
    </MessageCenterHelper.MessageRecipientVO>
    <MessageCenterHelper.MessageRecipientVO>
      <CellPhone>sample string 6</CellPhone>
      <Count>4</Count>
      <Desc>sample string 1</Desc>
      <Email>sample string 5</Email>
      <IdOrSql>sample string 3</IdOrSql>
      <Type>2</Type>
    </MessageCenterHelper.MessageRecipientVO>
    <MessageCenterHelper.MessageRecipientVO>
      <CellPhone>sample string 6</CellPhone>
      <Count>4</Count>
      <Desc>sample string 1</Desc>
      <Email>sample string 5</Email>
      <IdOrSql>sample string 3</IdOrSql>
      <Type>2</Type>
    </MessageCenterHelper.MessageRecipientVO>
  </DistrList>
  <ExcludedMembers>sample string 3</ExcludedMembers>
  <Name>sample string 2</Name>
  <SchoolID>sample string 1</SchoolID>
</MessageCenterHelper.DistributionListVO>