REL documentation
customers ftpalertdef (http://api.3plcentral.com/rels/customers/ftpalertdef)
Resource:
customer ftp alert definition
C# Rel Const:
Rels.CustomerSvc.FtpAlertDef
URI template:
{id}/ftpalertdefs/{faid}
Obtain URI from:
Get the definition of an ftp alert
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int customer id
faid * int event notify id
Type Description
EventNotifyType string Domain: Adjustment, OrderCreate, OrderCustCreate, CustOrderShip, OrderFtpOrderCreate, OrderFtpOrderUpdate, OrderFtpOrderConfirm, OrderFtpOrderCancel, ReceiveConfirmation, OrderFtpReceiveCreate, OrderFtpReceiveUpdate, OrderFtpReceiveConfirm, OrderFtpReceiveCancel
TransformId int? ...
Host string
Path string
Password string
UploadFileName string
Links IList<WebApi.Hal.Link>
- /rels/customers/customer
Sample accept: application/hal+json
{
  "eventNotifyType": "str",
  "transformId": 1,
  "host": "str",
  "path": "str",
  "login": "str",
  "password": "str",
  "uploadFileName": "str"
}
Update the definition of an ftp alert
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int customer id
faid * int event notify id
Type Description
EventNotifyType string Domain: Adjustment, OrderCreate, OrderCustCreate, CustOrderShip, OrderFtpOrderCreate, OrderFtpOrderUpdate, OrderFtpOrderConfirm, OrderFtpOrderCancel, ReceiveConfirmation, OrderFtpReceiveCreate, OrderFtpReceiveUpdate, OrderFtpReceiveConfirm, OrderFtpReceiveCancel
TransformId int? ...
Host string
Path string
Password string
UploadFileName string
Sample content-type: application/hal+json
 
{
  "eventNotifyType": "str",
  "transformId": 1,
  "host": "str",
  "path": "str",
  "login": "str",
  "password": "str",
  "uploadFileName": "str"
}
Type Description
EventNotifyType string Domain: Adjustment, OrderCreate, OrderCustCreate, CustOrderShip, OrderFtpOrderCreate, OrderFtpOrderUpdate, OrderFtpOrderConfirm, OrderFtpOrderCancel, ReceiveConfirmation, OrderFtpReceiveCreate, OrderFtpReceiveUpdate, OrderFtpReceiveConfirm, OrderFtpReceiveCancel
TransformId int? ...
Host string
Path string
Password string
UploadFileName string
Links IList<WebApi.Hal.Link>
- /rels/customers/customer
Sample accept: application/hal+json
{
  "eventNotifyType": "str",
  "transformId": 1,
  "host": "str",
  "path": "str",
  "login": "str",
  "password": "str",
  "uploadFileName": "str"
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.