Jump to

• Request
• Response
• Examples

Get Email Notification Configuration

get

/documents/api/1.2/config/notification/email

Retrieve the email notification configuration for this service instance.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : GetNotificationEmailResponse

Type: object

Get email notification configuration response.

Show Source

• disableEmailNotifications(optional): string
  Returns true if email notification is disabled. Returns false otherwise.
• errorCode(optional): number
  An error code of zero (0) indicates no errors.
• type(optional): string
  Item type config.

{
    "description":"Get email notification configuration response.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "disableEmailNotifications":{
            "type":"string",
            "description":"Returns <code>true</code> if email notification is disabled. Returns <code>false</code> otherwise."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>config</code>."
        }
    }
}

Example Response (application/json)

{
    "errorCode":"0",
    "disableEmailNotifications":"false",
    "type":"config"
}

Back to Top

Examples

The following example retrieves the email notification configuration for this service instance.

GET .../config/notification/email

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
   "errorCode":"0",
   "disableEmailNotifications":"false",
   "type":"config"
}

Back to Top