Rel doc - Rel

GET

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

Params
Response body (Customer.Models.CustomerBolTemplate)

Name (* = required)	Data Type	Description
id *	int	customer id
tid *	int	template 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
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"
  }
}

PUT

/customers/{id}/boltemplates/{tid}

Update an existing bill-of-lading template for a given customer
If-Match request header required; Success status: 200; ETag response header supplied

Name (* = required)	Data Type	Description
id *	int	customer id
tid *	int	customer bol template 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"
  }
}

DELETE

/customers/{id}/boltemplates/{tid}

Remove an existing bill-of-lading template for a given customer
If-Match request header required; Success status: 204

Params

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

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.