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 ssrsrun (http://api.3plcentral.com/rels/reportdefs/ssrsrun)
Operator: generate a base report
C# Rel Const:
URI template:
Obtain URI from:
Run a base report and get its output. HTTP Accept header specifies desired format and parameters.
Supported formats and parameters. Default value shown first, alternatives shown in parentheses:
- text/csv;header=present(absent);separator=comma(tab);encoding="utf-8";excelmode=true -- if version=2 is specified, the equivalent of ClassicView's CSV v.2 is emitted
- application/pdf;startpage=0;endpage=0
- application/vnd.ms-excel [if saving to file use ".xls" extension, not ".xlsx"]
- application/msword;autofit=default(false,true,never);fixedpagewidth=false [if saving to file use ".doc" extension, not ".docx"]
- application/xml
See Ssrs DeviceInfo Doc for description of parameter values.
Success status: 200
Name (* = required) Data Type Description
name * string base report name
parameters string report parameters formatted as name1:value1~name2:value2~...; consult RDL for parameter names
alternatepath string for access to reports not in the default path
Mechanism for giving content to media formatter. Clients won't use this model directly.
model returned if Accept: application/hal+json; otherwise response body is Content-Type as requested in Accept
Type Description
ContentType string
Content Object
Sample accept: application/hal+json
  "contentType": "str",
  "content": {}

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.