Rel doc - Rel

GET

Get the list of bill-of-lading templates defined for a given customer
Success status: 200; Response is cacheable

Params
Response body (Customer.Models.CustomerBolTemplateList)

Name (* = required)	Data Type	Description
id *	int	customer id

	Type	Description
ResourceList	IList<Customer.Models.CustomerBolTemplate>
TemplateId	int
Name	string
BolNumAsTransNum	bool
Field1MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string
Field2MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string
Field3MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/customers/customer
Links	IList<WebApi.Hal.Link>
	- /rels/customers/customer

Sample accept: application/hal+json

{
  "_embedded": {
    "http://api.3plCentral.com/rels/customers/customerboltemplate": [
      {
        "templateId": 1,
        "name": "str",
        "bolNumAsTransNum": true,
        "field1MessageInfo": {
          "id": 1,
          "text": "str"
        },
        "field2MessageInfo": {
          "id": 1,
          "text": "str"
        },
        "field3MessageInfo": {
          "id": 1,
          "text": "str"
        }
      }
    ]
  }
}

POST

/customers/{id}/boltemplates

Add a new bill-of-lading template for a given customer
Success status: 200; ETag response header supplied

Name (* = required)	Data Type	Description
id *	int	customer id

	Type	Description
TemplateId	int
Name	string
BolNumAsTransNum	bool
Field1MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string
Field2MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string
Field3MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string

Sample content-type: application/hal+json

{
  "templateId": 1,
  "name": "str",
  "bolNumAsTransNum": true,
  "field1MessageInfo": {
    "id": 1,
    "text": "str"
  },
  "field2MessageInfo": {
    "id": 1,
    "text": "str"
  },
  "field3MessageInfo": {
    "id": 1,
    "text": "str"
  }
}

	Type	Description
TemplateId	int
Name	string
BolNumAsTransNum	bool
Field1MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string
Field2MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string
Field3MessageInfo	Customer.Models.CustomerBolMessageInfo
Id	int
Text	string
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/customers/customer

Sample accept: application/hal+json

{
  "templateId": 1,
  "name": "str",
  "bolNumAsTransNum": true,
  "field1MessageInfo": {
    "id": 1,
    "text": "str"
  },
  "field2MessageInfo": {
    "id": 1,
    "text": "str"
  },
  "field3MessageInfo": {
    "id": 1,
    "text": "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.