Aller au contenu

GetJobDocs

Liste les documents d’un dossier : ceux de tout le dossier et ceux de chacun de ses ordres de travail, comme dans l’onglet Documents de l’ordre de travail. Chacun est accompagné d’un lien pour le télécharger. Vous pouvez ne demander que les documents liés à certains éléments de la liste de contrôle des documents du dossier, par exemple les connaissements. Pour ajouter un document, utilisez UploadJobDoc.

Comment se connecter et lire la réponse : Authentification, Réponses.

GET /api/v1/GetJobDocs?JobID=30512&ChecklistType=Bill%20of%20Lading~Packing%20List
Token: your-token
Paramètre Obligatoire Signification
JobID Oui L’identifiant du dossier, un nombre entier.
ChecklistType Non Uniquement les documents liés à un élément de la liste de contrôle dont le nom contient l’un de ces textes, séparés par ~. Insensible à la casse. Les documents qui ne sont pas liés à la liste de contrôle sont alors omis. Sans ce paramètre, tous les documents du dossier sont listés.

Mettez JobID dans la chaîne de requête : sans lui, la requête n’atteint pas le point de terminaison et TrakIT répond avec le statut HTTP 404.

Règle Info en cas d’échec
JobID est un nombre entier supérieur à 0. Invalid JobID
Le dossier existe. Job not found

En cas de succès, Code vaut 1, RetInfo est la liste des documents, du plus ancien au plus récent, et RowsAffected indique leur nombre. Identity et Scalar ne sont pas utilisés. Si le dossier n’a aucun document, ou aucun lié aux éléments de la liste de contrôle demandés, Code vaut 0 et Info vaut No documents found.

{
"Code": 1,
"Info": "",
"RetInfo": [
{
"DocID": 304931,
"Title": "Bill of Lading",
"FileName": "EXSHIP-BL-2026-1187.pdf",
"FileSize": 248113,
"WorkOrderID": null,
"UploadedBy": "Jane Smith",
"UploadedOn": "2026-10-19T07:52:31.27",
"Cancelled": false,
"IsPublic": true,
"Latitude": null,
"Longitude": null,
"ChecklistItems": [ "Bill of Lading" ],
"Url": "https://trakit.example.com/getfile?preview=true&id=...&exp=..."
},
{
"DocID": 304977,
"Title": "Packing List",
"FileName": "packing-list-48211.pdf",
"FileSize": 96402,
"WorkOrderID": 48211,
"UploadedBy": "Jane Smith",
"UploadedOn": "2026-10-20T10:05:12.4",
"Cancelled": false,
"IsPublic": false,
"Latitude": null,
"Longitude": null,
"ChecklistItems": [ "Packing List" ],
"Url": "https://trakit.example.com/getfile?preview=true&id=...&exp=..."
}
],
"RowsAffected": 2,
"Scalar": null,
"Identity": 0
}
Champ Signification
DocID L’identifiant du document.
Title, FileName Le titre et le nom de fichier du document.
FileSize La taille du fichier en octets, telle que chargée.
WorkOrderID L’ordre de travail auquel le document est destiné, ou null pour un document de tout le dossier.
UploadedBy Le nom complet de l’utilisateur qui l’a chargé, ou null.
UploadedOn Le moment du chargement, en UTC. Voir Dates.
Cancelled true si le document a été annulé. Les documents annulés sont aussi listés.
IsPublic true si les utilisateurs externes, comme le client, peuvent le voir (Ext dans l’onglet Documents).
Latitude, Longitude L’endroit où le document a été capturé, s’il a été pris avec une position, ou null.
ChecklistItems Les noms des éléments de la liste de contrôle auxquels il est lié, ou null.
Url Un lien qui ouvre le document sans connexion à TrakIT, pendant 7 jours.
  • Toute personne qui a une Url peut ouvrir le document jusqu’à l’expiration du lien, sans se connecter. Gardez les liens aussi confidentiels que les documents. Chaque appel renvoie de nouveaux liens, valables 7 jours à compter de l’appel.
  • Tous les documents du dossier sont listés, y compris ceux réservés à certains rôles dans TrakIT.