REL documentation
master threeplsummaries (http://api.3plcentral.com/rels/master/threeplsummaries)
Resource:
the list of third party logisitics company summaries
C# Rel Const:
Rels.MasterSvc.ThreePlSummaries
URI template:
threepls/summaries{?pgsiz,pgnum,rql,sort}
Obtain URI from:
Billboard
Get a list of threepls
Success status: 200; Response is cacheable
Name Data Type Description
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
Type Description
TotalResults int
ResourceList IList<Master.Models.ThreePlSummary>
CompanyName string
GuId string
ThreePlId int
Status Common.Enum.ThreePlRecordStatus
- 0: NewRecord
- 1: ConfEmailSent
- 2: ReadyToCreateDb
- 3: DbCreated
- 4: Deactivated
CreationDate DateTime? ...
Billable bool
UseCognitoLogin bool
SalesforceId string
Links IList<WebApi.Hal.Link>
- /rels/master/threepl the full record, including settings
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "item": [
      {
        "companyName": "str",
        "guId": "str",
        "threePlId": 3,
        "status": 0,
        "creationDate": "2016-12-25T23:00:00",
        "billable": true,
        "useCognitoLogin": true,
        "salesforceId": "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.