API changes: ACTION REQUIRED. Click the following for more info.
Thousands of requests each hour are currently being received with misspelled query parameters or otherwise ill-formed URL syntax.
The REST API currently silently ignores the invalid query params, so the developer isn't aware their intent is not well formed.
Frequent Mistakes Description
/orders?pgsize=100 (or orderspgsiz, pg_siz, pgziz) It must be spelled pgsiz. Close only counts in horseshoes and hand grenades.
/orders?order?pgsiz=100&pgnum=12 The ill-formed second ? makes "order?pgsiz" a query parameter. Therefore, the intended page size of 100 is ignored.
/orders?customerid=5&facilityid=7 Neither customerid nor facilityid are defined parameters for /orders. Numerous other examples similar to this for other URIs are received every day.
The customer/customeralertdefinitions rel has been replaced by the following rels:
Rel Description
customers/emailalertdef and customers/emailalertdefs To setup notitications via email for a customer (c2).
properties/emailtemplate To modify email templates at the threepl (c1) level.
customers/emailtemplate To create/modify email templates at the customer (c2) level
customers/ftpalertdef and customers/ftpalertdefs To setup notitications via ftp for a customer (c2)
reportdefs ssrsdefc11n (http://api.3plcentral.com/rels/reportdefs/ssrsdefc11n)
Resource:
base report's customization definition, with RDL
C# Rel Const:
Rels.ReportDefsSvc.SsrsDefC11n
URI template:
ssrs/{name}/{for}/{customname}{?customerid}
Obtain URI from:
Get a report customization's RDL. To be implemented when Reports Mgr converted to V2.
Success status: 200
Name (* = required) Data Type Description
name * string base report name
customname * string customization name
for * Common.Enum.CustomizedReportFor for whom the report is customized
- Customer
- CustomerAny
- TplOnly
customerid int required if 'for' is Customer
base report's customization definition, including RDL
Type Description
CustomName string name of this customization; name unique within base report+customizedReportFor+customerId
CustomizedReportType Common.Enum.CustomizedReportFor for whom report is customized
Common.Enum.CustomizedReportFor for whom a particular customization is made
- 0: Customer a specific customer; other parameters elsewhere specify the customer id
- 1: CustomerAny not a specific customer but any customer
- 2: TplOnly hidden from a customer's view, to be used internally within the threepl
CustomerId int? ... if customizedReportFor is Customer, the customer for whom it is customized
Rdl string RDL, sanitized on output, desanitized and validated on input.
Sample accept: application/hal+json
{
  "customName": "str",
  "customizedReportType": 0,
  "customerId": 1,
  "rdl": "str"
}
Updates a report customization's RDL. To be implemented when Reports Mgr converted to V2.
Success status: 200
Name (* = required) Data Type Description
name * string base report name
customname * string customization name
for * Common.Enum.CustomizedReportFor for whom the report is customized
- Customer
- CustomerAny
- TplOnly
customerid int required if 'for' is Customer
base report's customization definition, including RDL
modified customization
Type Description
CustomName string name of this customization; name unique within base report+customizedReportFor+customerId
CustomizedReportType Common.Enum.CustomizedReportFor for whom report is customized
Common.Enum.CustomizedReportFor for whom a particular customization is made
- 0: Customer a specific customer; other parameters elsewhere specify the customer id
- 1: CustomerAny not a specific customer but any customer
- 2: TplOnly hidden from a customer's view, to be used internally within the threepl
CustomerId int? ... if customizedReportFor is Customer, the customer for whom it is customized
Rdl string RDL, sanitized on output, desanitized and validated on input.
Sample content-type: application/hal+json
{
  "customName": "str",
  "customizedReportType": 0,
  "customerId": 1,
  "rdl": "str"
}
base report's customization definition, including RDL
Type Description
CustomName string name of this customization; name unique within base report+customizedReportFor+customerId
CustomizedReportType Common.Enum.CustomizedReportFor for whom report is customized
Common.Enum.CustomizedReportFor for whom a particular customization is made
- 0: Customer a specific customer; other parameters elsewhere specify the customer id
- 1: CustomerAny not a specific customer but any customer
- 2: TplOnly hidden from a customer's view, to be used internally within the threepl
CustomerId int? ... if customizedReportFor is Customer, the customer for whom it is customized
Rdl string RDL, sanitized on output, desanitized and validated on input.
Sample accept: application/hal+json
{
  "customName": "str",
  "customizedReportType": 0,
  "customerId": 1,
  "rdl": "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 [email protected] with any questions about this documentation.