Alert Update V1

post

https://processor-api.uat1.pcaasa.com/?call=alert-update-v1

Update an alert and preserve a history of used/inactive alerts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

app

string

Defaults to customer-alert

customer-alert

object

string

Defaults to alert

alert

action

string

Defaults to update

update

version

int32

Defaults to 1

sessionUuid

string

The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

externalTranUuid

string

Identifier for tracking this API call

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

alertUuid

string

Unique identifier for the alert being updated. Not the record uuid. If the objectUuid or objectReferenceNumber is not provided, alertUuid will be required

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

objectUuid

string

The unique identifier of the object to which the alert is connected
If alertUuid or objectReferenceNumber is not provided, objectUuid will be required

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

objectReferenceNumber

string

The reference number of the object to which the alert is connected
If alertUuid or objectUuid is not provided, objectReferenceNumber will be required
Reference number format and length will vary depending on the object which it belongs to
Some allow alphaNumeric values, some only numeric and one capital alpha
Special characters allowed by some referenceNumbers: , . (comma, space, period)

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 5
Max: 50

objectType

string

enum

Object type to which the alert is attached
If the objecteferenceNumber is the only identifier provided, objectType will be required

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 1
Max: 40

Allowed:

alertTypeCode

string

enum

The code for the alert type being updated. If alertUuid is not provided, alertTypeCode will be required

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 3
Max: 50

Allowed:

startDate

date

Format used is yyyy-MM-dd
Special characters allowed:
hyphen (-)
colon (:)
period (.)

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 27

endDate

date

Format used is yyyy-MM-dd
Special characters allowed:
hyphen (-)
colon (:)
period (.)

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 27

gmtOffsetHours

int32

Valid values are -12 to 14
Special character allowed is a hyphen '-'

Data type: number
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 1
Max: 3

maxAmount

float

Data type: money
Required: no
Letters: no
Numbers: yes
Special: no
Min: 3
Max: 25

maxCount

int32

Data type: number
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 10

mccCodeList

string

Vaild special character: space (' ')

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 4
Max: 4000

namePrefixList

string

Invaild special character: comma (,)

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 4
Max: 4000

debug

boolean

Defaults to false

0 = debug off
1 = debug on
Default is set to 0

Data type: boolean
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

Response

200200