UserNotifications / Client / exceptions / ValidationException

ValidationException¶

class UserNotifications.Client.exceptions.ValidationException¶

This exception is thrown when the notification event fails validation.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)

response¶

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'reason': 'fieldValidationFailed'|'other',
    'fieldList': [
        {
            'name': 'string',
            'message': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) –

This exception is thrown when the notification event fails validation.
- message (string) –
- reason (string) –
  
  The reason why your input is considered invalid.
- fieldList (list) –
  
  The list of input fields that are invalid.
  - (dict) –
    
    Stores information about a field passed inside a request that resulted in an exception.
    - name (string) –
      
      The field name where the invalid entry was detected.
    - message (string) –
      
      A message with the reason for the validation exception error.
- Error (dict) – Normalized access to common exception attributes.
  - Code (string) – An identifier specifying the exception type.
  - Message (string) – A descriptive message explaining why the exception occured.