REL documentation
customers ftpalertdefs (http://api.3plcentral.com/rels/customers/ftpalertdefs)
Resource:
Collection: of ftpalertdef
C# Rel Const:
Rels.CustomerSvc.FtpAlertDefs
URI template:
{id}/ftpalertdefs
Obtain URI from:
/rels/customers/customer
Get a list of existing ftp alerts defs for a given customer
Success status: 200
Name (* = required) Data Type Description
id * int customer id
Type Description
ResourceList IList<Customer.Models.FtpAlertDef>
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
Links IList<WebApi.Hal.Link>
- /rels/customers/customer
Sample accept: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/customers/ftpalertdef": [
      {
        "eventNotifyType": "str",
        "transformId": 1,
        "host": "str",
        "path": "str",
        "login": "str",
        "password": "str",
        "uploadFileName": "str"
      }
    ]
  }
}
Create a new ftp alert definition
Success status: 200
Name (* = required) Data Type Description
id * int
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.