Name
(* = required)
|
Data Type | Description |
alertids
*
|
string |
a comma-delmited list of alert ids |
|
Type |
Description |
ResourceList |
IList<Customer.Models.AlertContent>
|
|
AlertId |
int
|
|
ObjectId |
int
|
|
Email |
Customer.Models.AlertEmail
|
|
From |
string
|
|
SenderName |
string
|
|
ReplyToAddress |
string
|
|
Recipients |
string
|
|
CCRecipients |
string
|
|
BccRecipients |
string
|
|
Subject |
string
|
|
Body |
string
|
|
AttachmentBytes |
Byte[]
|
|
AttachmentFileName |
string
|
|
AttachmentContentType |
string
|
|
CustomerId |
int?
|
for emails only, we follow the EventNotifyQueue on a wild goose chase to determine the customer;
if we find a wild goose, we put its illusive yet avowed ID here
|
Export |
Customer.Models.AlertExport
|
|
ContentName |
string
|
for export via Ftp, the name of the file
|
Content |
string
|
|
Channel |
Customer.Models.Channel
|
|
SkipInvalid |
bool
|
true: create as many as possible; false: all or nothing
|
ReadOnly |
Customer.Models.ChannelReadOnly
|
|
ChannelId |
int
|
|
CreatedDate |
DateTime?
|
|
LastChangedDate |
DateTime?
|
|
CustomerIdentifier |
Generic.Models.CustomerIdentifier
|
|
ExternalId |
string
|
|
Name |
string
|
|
Id |
int
|
|
CustomerDeactivated |
bool
|
|
FacilityIdentifier |
Generic.Models.FacilityIdentifier
|
|
Name |
string
|
|
Id |
int
|
|
ResourceType |
Common.Enum.ChannelResourceType
|
|
|
- 0: Order |
|
|
- 1: Receiver |
|
|
- 2: Item |
|
Provider |
string
|
|
Name |
string
|
|
Deactivated |
bool
|
if true, this channel should not be used; either channel or customer is deactivated; see CustomerDeactivated to distinguish
|
ScheduleCron |
string
|
|
TransformIdentifier |
Generic.Models.TransformIdentifier
|
|
Name |
string
|
|
Id |
int
|
|
ProviderParams |
IEnumerable<Generic.Models.SavedElement>
|
parameters
|
Name |
string
|
|
Value |
string
|
|
Error |
Customer.Models.AlertContentError
|
|
Message |
string
|
|
StackTrace |
string
|
|
Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/customers/alert
|
|
|
-
/rels/customers/alertfailer
|
|
Sample accept: application/hal+json
{
"_embedded": {
"item": [
{
"alertId": 1,
"objectId": 2,
"email": {
"from": "str",
"senderName": "str",
"replyToAddress": "str",
"recipients": "str",
"ccRecipients": "str",
"bccRecipients": "str",
"subject": "str",
"body": "str",
"attachmentBytes": "QA==",
"attachmentFileName": "str",
"attachmentContentType": "str",
"customerId": 1
},
"export": {
"contentName": "str",
"content": "str",
"channel": {
"skipInvalid": true,
"readOnly": {
"channelId": 1,
"createdDate": "2016-12-25T23:00:00",
"lastChangedDate": "2016-12-25T23:00:00",
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"customerDeactivated": true,
"facilityIdentifier": {
"name": "str",
"id": 2
},
"resourceType": 0,
"provider": "str"
},
"name": "str",
"deactivated": true,
"scheduleCron": "str",
"transformIdentifier": {
"name": "str",
"id": 2
},
"providerParams": [
{
"name": "str",
"value": "str"
}
],
"_links": null
}
},
"error": {
"message": "str",
"stackTrace": "str"
}
}
]
}
}