account::get_notification_settings

1. Index
2. > Function reference
3. > account::get_notification_settings

Description

Get settings related to balance warning, usage summary and usage level notifications.

Request details

• Method

  GET

• URL

  https://api.hostingreborn.com/account/get_notification_settings/

Arguments

key

API key

Responses

<?xml version="1.0" encoding="utf-8"?>
<notificationsettings>
  <balance>
    <warning>
      <enabled>true</enabled>
      <level>120</level>
    </warning>
    <summary>
      <value>daily</value>
      <value>monthly</value>
      <value>weekly</value>
    </summary>
  </balance>
  <usagealerts>
    <disk>
      <value>70</value>
      <value>80</value>
      <value>90</value>
    </disk>
    <bandwidth>
      <value>70</value>
      <value>80</value>
      <value>90</value>
    </bandwidth>
  </usagealerts>
</notificationsettings>
	

balance

A container for balance-related notification settings

warning

A container for balance warning-related notification settings, not present if no such settings are enabled

enabled

Either true or false, indicating whether the subsequent level element is enabled.

If enabled=false and level is blank, there will be no warning element in the response.

level

The balance level, in pence, below which a 'your balance is too low' notification should be sent out.

summary

A container for balance summary-related notification settings, not present if no such settings are enabled

value

Any number of potential value elements may be present to indicate the wish to receive a usage summary report for a given period. Each value element represents a period-specific report type.

daily

Receive daily usage summary notifications

weekly

Receive weekly usage summary notifications

monthly

Receive monthly usage summary notifications

usagealerts

A container for usage alert-related notification settings, not present if no such settings are enabled

disk

A container for disk usage alert-related notifications

value

Any number of potential value elements may be present to indicate the wish to receive a usage summary report for a given period. Each value element represents a period-specific report type.

90

Receive notifications when hosting accounts reach 90% of their storage limits.

80

Receive notifications when hosting accounts reach 80% of their storage limits.

70

Receive notifications when hosting accounts reach 70% of their storage limits.

bandwidth

A container for bandwidth usage alert-related notifications

value

Any number of potential value elements may be present to indicate the wish to receive a usage summary report for a given period. Each value element represents a period-specific report type.

90

Receive notifications when hosting accounts reach 90% of their bandwidth limits.

80

Receive notifications when hosting accounts reach 80% of their bandwidth limits.

70

Receive notifications when hosting accounts reach 70% of their bandwidth limits.

Exceptions

• database

• access

Examples

Get notifcations for an account that … has all settings enabled

GET /account/get_notification_settings/?key=acbd18db4cc2f85cedef654fccc4a4d8

<?xml version="1.0" encoding="utf-8"?>
<notificationsettings>
  <balance>
    <warning>
      <enabled>true</enabled>
      <level>120</level>
    </warning>
    <summary>
      <value>daily</value>
      <value>monthly</value>
      <value>weekly</value>
    </summary>
  </balance>
  <usagealerts>
    <disk>
      <value>70</value>
      <value>80</value>
      <value>90</value>
    </disk>
    <bandwidth>
      <value>70</value>
      <value>80</value>
      <value>90</value>
    </bandwidth>
  </usagealerts>
</notificationsettings>
	

… has no balance warning notification enabled, but all other notifications enabled

GET /account/get_notification_settings/?key=acbd18db4cc2f85cedef654fccc4a4d8

<?xml version="1.0" encoding="utf-8"?>
<notificationsettings>
  <balance>
    <summary>
      <value>daily</value>
      <value>monthly</value>
      <value>weekly</value>
    </summary>
  </balance>
  <usagealerts>
    <disk>
      <value>70</value>
      <value>80</value>
      <value>90</value>
    </disk>
    <bandwidth>
      <value>70</value>
      <value>80</value>
      <value>90</value>
    </bandwidth>
  </usagealerts>
</notificationsettings>
	

… has no usage alert notifications enabled, but all other notifications enabled

GET /account/get_notification_settings/?key=acbd18db4cc2f85cedef654fccc4a4d8

<?xml version="1.0" encoding="utf-8"?>
<notificationsettings>
  <balance>
    <warning>
      <enabled>true</enabled>
      <level>120</level>
    </warning>
    <summary>
      <value>daily</value>
      <value>monthly</value>
      <value>weekly</value>
    </summary>
  </balance>
</notificationsettings>
	

… has only a 90% bandwidth usage notification enabled

GET /account/get_notification_settings/?key=acbd18db4cc2f85cedef654fccc4a4d8

<?xml version="1.0" encoding="utf-8"?>
<notificationsettings>
  <usagealerts>
    <bandwidth>
      <value>90</value>
    </bandwidth>
  </usagealerts>
</notificationsettings>
	

See also

• account::get

  Get summary details (email address, balance, status) for an account

• account::set_notification_settings

  Set settings related to balance warning, usage summary and usage level notifications