Get Files

GET v2/{modelType}/{modelID}/files

Returns the file or list of files pertaining to the specific model object.

The Endpoints

v2/{modelType}/{modelID}/files/{fileID}

v2/{modelType}/{modelID}/files/

Examples

Get File

GET https://api.test.archer-app.com/v2/loads/999999/files/100001

Get Files

GET https://api.test.archer-app.com/v2/loads/999999/files

---

Body Object

None

ExampleBody

None

---

Response

Returns the file or an array of files pertaining to the object.

Response Properties

Name	Type	Description
id	int	File Id.
modelType	string	Model name.
modelId	int	Model Id.
description	string	Description Type Enum
name	string	The file name.

Possible values for description

• Accessorial Confirmation Backup

• Rate Confirmation

• POD

• Invoice

• PickUp Document

Example Response

The file will be returned if a single file is queried.

Returns all details of the files pertaining to the object:

[
  {
    "id": 1000001,
    "modelType": "Load",
    "modelId": 999999,
    "description": "Invoice",
    "name": "Load_999999_Invoice_1522351748.pdf",
    "token": "asdfadsf"
  },
  {
    "id": 1000002,
    "modelType": "Load",
    "modelId": 999999,
    "description": "Rate Confirmation",
    "name": "Load_999999_Rate Confirmation_1522785648.pdf",
    "token": "zzAow76x"
  }
]

Example Error Response

The file Id was not found.

{
  "message": "NoSuchKey: The specified key does not exist.....",
  "title": "Internal Error"
}

---

---