Rel doc - Rel

POST

Attach a file to an order.
OrderFile object can be populated by media formatter from content-type header and raw payload.
In your request, set the content-type header to file's mime type and send POST payload as file contents; i.e., don't use content-type: application/hal+json.
Though content-disposition header (rfc6266) conveys file name, it's a response header, not a request header. So name is specified as a URI query param.
Success status: 201

Name (* = required)	Data Type	Description
id *	int	order id
name *	string	name to save the file as

content; see method description about using content-type header and request payload

	Type	Description
ContentType	string
Content	Object

Sample content-type: application/hal+json

{
  "contentType": "str",
  "content": {}
}

	Type	Description
DocName	string
ContentType	string
DocLength	int
AttachedByIdentifier	Generic.Models.UserIdentifier
Name	string
Id	int
AttachedDate	DateTime
RemovedByIdentifier	Generic.Models.UserIdentifier
Name	string
Id	int
RemovedDate	DateTime? ...
Links	IList<WebApi.Hal.Link>
	- /rels/orders/orderfile	file content

Sample accept: application/hal+json

{
  "docName": "str",
  "contentType": "str",
  "docLength": 3,
  "attachedByIdentifier": {
    "name": "str",
    "id": 2
  },
  "attachedDate": "2016-12-25T23:00:00",
  "removedByIdentifier": {
    "name": "str",
    "id": 2
  },
  "removedDate": "2016-12-25T23:00:00"
}

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.