/files/{id} (GET)
Get a specific file, based on the Cargosnap ID with the /files/id route. This works well if you know/have the specific id that refers to the Cargosnap file. If you do not have the Cargosnap reference, but your own, use the /Files route to query the data and/or the ID.
Parameters
the /files/id endpoint takes no further parameters. You will get the full file information in response.
Response values
All response values, except Boolean and Integers, are provided as string values and are appropriately escaped. The content of the response will depend on the query parameters, the implemented features on Cargosnap as well as the actual available data. The most common data fields are:
id (int)
Unique ID of the Cargosnap file.
scan_code (string)
String value, of the file number which is queried: your reference code.
scan_code_format (string)
In case a barcode was scanned to provide the file number, this value displays the type of barcode that was scanned.
created_at (date)
Date/timestamp of the time the first Cargosnap or Form was uploaded and registered in the platform, in the time zone UTC.
data.uploads: (array)
- id: Unique ID of the Cargosnap image/upload.
- device_id : Unique ID of the Cargosnap device, used to take the image.
- created_at : Date/timestamp of the time the Cargosnap was uploaded and registered in the platform, in the time zone UTC.
- scan_date_time: Date/timestamp of the time the Cargosnap was taken on the app, in the time zone UTC.
- upload_type: String representation of the type of data. Possible values include “snap”, “manual” and “document”.
- damage_type_desc: Indicates if the Cargosnap app user indicated if any damage is to be seen on the image. The value will be displayed in text, in the language provided in the lang parameter (if available and if supplied).
- has_damage: Indicates if the Cargosnap app user indicated if any damage is to be seen on the image. Value=1 indicates such a case.
- document_type_desc: Indicates the selected type of document, in case the user selected to create a document scan.
- latitude: Latitude of the user, when creating the Cargosnap.
- longitude: Longitude of the user, when creating the Cargosnap.
- image_name: Filename of the Snap
- image_mime: Snap Image type. Typically the image/jpeg
- comment: If available, provides the comment the Cargosnap app user provided with the Cargosnap.
- image_url: URL path of the full, uncompressed, original image.
- image_thumb: URL path of ‘thumbnail’ of the image. The thumbnail contains the full content of the file, but is significantly reduced in filesize, making the presentation to the end-user significantly more responsive on most internet connections.
- workflow_id: If the image was taken as a part of a workflow, a unique identifyer of the workflow is indicated here.
- workflow_description: If the image was taken as a part of a workflow, the description -as given in the platform- of the workflow is indicated here.
- workflow_step_id: If the image was taken as a part of a workflow, a unique identifyer of the specific step in the workflow is indicated here.
- workflow_step_description: If the image was taken as a part of a workflow, the description of the specific step -as given in the platform- of the workflow is indicated here.
data.form_submits[] (array):
- id: Unique reference for the data to the submitted form.
- form.id: Unique number of the specific form that was filled in, at the specific submit
- form.title: Title of the form, as given
- fields.label & id: Label of the specific question, for the specific ID
- answers.value & id: Title of the form, as filled in, for the specific ID
data.fields[] (array):
- id (note: this field is currently depricated! The value is incorrectly mapped. The functionality of this field will be corrected/changed in a target release on Jan 1st, 2023)
- field_id: the unique ID given to the field
- donotuse : well... please do not use this value. it is for temporary use in a internal use case. In the future this value will be transferred to the ID field of the same object
- name: Field name, as given
- value: Value, as submitted
- snap_id: in case the value was 'scanned' from an image, this value may contain the ID of the specific snap the value was scanned from
Example Request
GET https://api.cargosnap.com/api/v2/files/12345
This query will:
- return a single file, or none (if not found/deleted etc.)
- Include details of all uploads, forms and fields
Response
The response follows this Schema:
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"scan_code": {
"type": "string"
},
"closed": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"uploads": {
"type": [
"array"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"upload_type": {
"type": "string"
},
"created_at": {
"type": "string"
},
"scan_date_time": {
"type": "string"
},
"image_path": {
"type": "string"
},
"image_url": {
"type": "string"
},
"image_thumb": {
"type": "string"
}
},
"required": [
"id",
"file_id",
"tenant_id",
"upload_type",
"created_at",
"scan_date_time",
"image_path",
"image_url",
"image_thumb"
]
}
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"field_id": {
"type": "integer"
},
"file_id": {
"type": "integer"
},
"snap_id": {
"type": ["integer","null"]
},
"value": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name",
"field_id",
"file_id",
"snap_id",
"value",
"created_at",
"updated_at"
]
}
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"location": {
"type": "string"
}
},
"required": [
"id",
"location"
]
}
},
"workflow_runs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"workflow_id": {
"type": "integer"
},
"submit_date_time": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"completed_at": {
"type": "string"
},
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"workflow_id": {
"type": "integer"
},
"order": {
"type": "integer"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"allow_skip": {
"type": "boolean"
},
"platform_description": {
"type": "string"
}
},
"required": [
"id",
"workflow_id",
"order",
"description",
"type",
"allow_skip",
"platform_description"
]
}
}
}
},
"workflow_run_steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"entity_type": {
"type": "string"
},
"status": {
"type": "string"
},
"entity_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"device_id": {
"type": "integer"
},
"workflow_step_id": {
"type": "integer"
},
"workflow_run_id": {
"type": "integer"
},
"submit_date_time": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"entity_type",
"status",
"entity_ids",
"device_id",
"workflow_step_id",
"workflow_run_id",
"submit_date_time",
"created_at",
"updated_at"
]
}
}
},
"required": [
"id",
"workflow_id",
"file_id",
"submit_date_time",
"created_at",
"updated_at",
"completed_at",
"workflow",
"workflow_run_steps"
]
}
}
}
}