inventory fileimport (http://api.3plcentral.com/rels/inventory/fileimport)
Resource:
Operator: see fileparse, import
C# Rel Const:
Rels.InventorySvc.FileImport
URI template:
receivers/fileimporter{?customerId,facilityId,transformId,channelId,skipInvalidReceivers}
Create receivers from contents of import file.
Use content-type: text/plain, with the request body being the contents of the file.
Exceptions: general System.Exception if parse failed, or ListException containing validation and creation errors of individual receivers.
If any exceptions occurred, none of the receivers are created.
Success status: 201
Name (* = required) Data Type Description
customerId * int
facilityId * int
transformId int
channelId int id of channel, if any, through whcih these receivers were imported
skipInvalidReceivers bool true: create as many as possible; false: all or nothing
this object model should not be used directly by the API client, but is assembled by the media formatter from the request's content-type and payload
Type Description
ContentType string obtained from the HTTP "Content-Type" header
Content Object obtained from the HTTP payload
Sample content-type: application/hal+json
{
  "contentType": "str",
  "content": {}
}
Links to each newly created receiver
if skip... is true, see SkippedReceivers in the response
Type Description
FaultedReceivers Generic.Models.Exceptions.ListException container of WmsExceptionBase-derived exceptions occuring during actions on lists, such as import or mass ops
Message string
Faults IList<Generic.Models.Exceptions.ListEntryFault>
EntryNumber int 1-indexed position in the source list
WmsException Generic.Models.Exceptions.WmsExceptionBase for more details at runtime see which WmsExceptionBase-derived exception it is
ErrorCode string could have been a number, but is a short string for human readability; not to be localized
Hint string helpful word or two if the thrower happens to know more things; not to be localized
Message string
InnerException System.Exception
ReceiverIdentifiers IEnumerable<Generic.Models.ReceiverIdentifier>
Id int
Sample accept: application/hal+json
{
  "faultedReceivers": {
    "message": "ListException: Faults [{EntryNumber 1, }]",
    "faults": [
      {
        "entryNumber": 1,
        "entryInfo": "str"
      }
    ],
    "data": {},
    "helpLink": "str",
    "source": "str",
    "hResult": 3
  },
  "receiverIdentifiers": [
    {
      "id": 1
    }
  ]
}

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.