Notifications

NO_01: Success Notices

• Version: 1.0.0
• Interface: notifications
• Action: no_01

Payload Definition

Type: NotificationPayload

{
  "Version": "String",
  "Interface": "String",
  "Action": "String",
  "Code": "String",
  "Parameters": {
    "Key": null,
    "Value": null
  }
}

Example definition

Type: NotificationPayload

{
  "Version": "1.0.0",
  "Interface": "file_management",
  "Action": "fm_01",
  "Code": "F000001",
  "Parameters": {
    "key": "value",
    "param_1": "test"
  }
}

Response Codes

Code	Description
S00000	Action was received from Front End.
S00001	Action from Front End has completed.
F00000	Error executing the supplied function
F00001	Function is not defined
F00006	Action did not execute within an allotted time
F00008	Function is not found
F00011	The payload supplied is invalid

NO_02: Failure Notices

• Version: 1.0.0
• Interface: notifications
• Action: no_02

Payload Definition

Type: NotificationPayload

{
  "Version": "String",
  "Interface": "String",
  "Action": "String",
  "Code": "String",
  "Parameters": {
    "Key": null,
    "Value": null
  }
}

Example definition

Type: NotificationPayload

{
  "Version": "1.0.0",
  "Interface": "file_management",
  "Action": "fm_01",
  "Code": "F000001",
  "Parameters": {
    "key": "value",
    "param_1": "test"
  }
}

Response Codes

Code	Description
S00000	Action was received from Front End.
S00001	Action from Front End has completed.
F00000	Error executing the supplied function
F00001	Function is not defined
F00006	Action did not execute within an allotted time
F00008	Function is not found
F00011	The payload supplied is invalid

NO_03: Advisory Notices

• Version: 1.0.0
• Interface: notifications
• Action: no_03

Payload Definition

Type: NotificationPayload

{
  "Version": "String",
  "Interface": "String",
  "Action": "String",
  "Code": "String",
  "Parameters": {
    "Key": null,
    "Value": null
  }
}

Example definition

Type: NotificationPayload

{
  "Version": "1.0.0",
  "Interface": "file_management",
  "Action": "fm_01",
  "Code": "F000001",
  "Parameters": {
    "key": "value",
    "param_1": "test"
  }
}

Response Codes

Code	Description
S00000	Action was received from Front End.
S00001	Action from Front End has completed.
F00000	Error executing the supplied function
F00001	Function is not defined
F00006	Action did not execute within an allotted time
F00008	Function is not found
F00011	The payload supplied is invalid

NO_04: Information Notices

• Version: 1.0.0
• Interface: notifications
• Action: no_04

Payload Definition

Type: NotificationPayload

{
  "Version": "String",
  "Interface": "String",
  "Action": "String",
  "Code": "String",
  "Parameters": {
    "Key": null,
    "Value": null
  }
}

Example definition

Type: NotificationPayload

{
  "Version": "1.0.0",
  "Interface": "file_management",
  "Action": "fm_01",
  "Code": "F000001",
  "Parameters": {
    "key": "value",
    "param_1": "test"
  }
}

Response Codes

Code	Description
S00000	Action was received from Front End.
S00001	Action from Front End has completed.
F00000	Error executing the supplied function
F00001	Function is not defined
F00006	Action did not execute within an allotted time
F00008	Function is not found
F00011	The payload supplied is invalid