REL documentation
orders batchfiles (http://api.3plcentral.com/rels/orders/batchfiles)
Resource:
Collection: of batchfile
C# Rel Const:
Rels.OrderSvc.BatchFiles
URI template:
batches/{id}/files{?name}
Obtain URI from:
/rels/orders/batchfilesummaries
Attach a file to a batch.
See OrderFiles for how to specify content-type, content and name.
Success status: 201
Name (* = required) Data Type Description
id * int batch id
name * string name to save the file as
content; see OrderFiles for 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/batchfile 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.