Aller au contenu
Documentation TrakIT

CancelWO

Annule les ordres de travail que vous listez, comme le fait Cancel Work Order sur la page Ordre de travail. Utilisez-le lorsqu’un conteneur ou un chargement est retiré d’un dossier dans votre système. Pour clôturer plutôt des ordres de travail terminés, utilisez CloseWO ; pour rouvrir des ordres de travail annulés, utilisez ReopenWO.

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

POST /api/v1/CancelWO
Token: your-token
Content-Type: application/json
[48211, 48212, 48299]
Champ Obligatoire Signification
Le corps Oui Une liste JSON d’identifiants d’ordres de travail, des nombres entiers. Pas un objet : la liste elle-même est le corps.

TrakIT annule les ordres de travail un par un, dans l’ordre de la liste. Chacun est annulé ou refusé séparément : un refus n’arrête pas les autres et ne revient pas sur ceux déjà annulés. Les autres ordres de travail de leurs dossiers ne sont pas annulés.

Règles

Section intitulée « Règles »

Pour la requête :

Règle Info en cas d’échec
L’en-tête Token contient un jeton valide. Token missing in header, Token invalid or expired, ou une autre réponse listée dans Jeton de connexion
L’utilisateur est un administrateur système avec un accès à l’API. API User must be SysAdmin with API Access
Le corps est une liste d’au moins un identifiant. No WO IDs supplied

Pour chaque ordre de travail, dans le Info de son élément dans RetInfo :

Règle Info en cas d’échec
Un ordre de travail a cet identifiant. No such work order
Aucun de ses articles n’est confirmé dans un entrepôt. Cannot cancel Work Order with committed items
Les validations de votre société pour Save WO Header, Save Job Header et Cancel WO sont satisfaites. Leurs propres messages
L’ordre de travail est actif ou abandonné. Un ordre de travail clôturé doit être rouvert avant de pouvoir être annulé. Work Order is already cancelled, Work Order is already closed

Réponse

Section intitulée « Réponse »

RetInfo contient un élément pour chaque identifiant, dans l’ordre où vous les avez envoyés. RowsAffected est le nombre d’ordres de travail annulés. Code vaut 1 quand au moins un a été annulé, et 0 quand aucun ne l’a été ; Info est vide dans les deux cas. Lisez toujours les éléments.

{
  "Code": 1,
  "Info": "",
  "RetInfo": [
    { "WOID": 48211, "Success": true, "Info": "" },
    { "WOID": 48212, "Success": false, "Info": "Work Order is already closed" },
    { "WOID": 48299, "Success": false, "Info": "No such work order" }
  ],
  "RowsAffected": 1,
  "Scalar": null,
  "Identity": 0
}
Champ Signification
WOID L’identifiant de l’ordre de travail, tel que vous l’avez envoyé.
Success true quand l’ordre de travail a été annulé, false quand il a été refusé.
Info La raison du refus de l’ordre de travail. Vide quand il a été annulé.

Notes

Section intitulée « Notes »
  • Un ordre de travail annulé prend le statut Cancelled (2 dans GetWO), avec la date et l’utilisateur de l’API comme utilisateur qui l’a annulé. Son journal d’audit indique Cancelled via API. L’API n’enregistre aucun motif d’annulation.
  • L’ordre de travail sort du suivi des retards, et ses mouvements de parc ne lui sont plus liés.
  • Contrairement à une annulation dans TrakIT, l’API n’envoie aucun e-mail au responsable de l’ordre de travail.
  • Pour chaque ordre de travail annulé, TrakIT évalue ses champs de données calculés, exécute les actions d’événements et de données qui sont dues et les actions de votre société pour Cancel WO, et avertit les utilisateurs abonnés aux notifications Cancel WO.
  • Si une requête expire, vous pouvez la renvoyer : les ordres de travail déjà annulés sont refusés avec Work Order is already cancelled et restent annulés.