UpdateWOHeader

Modifie certains champs d’en-tête d’un ordre de travail ouvert : ce que fait Modifier un ordre de travail dans TrakIT, pour les champs listés ci-dessous. Utilisez-le lorsque votre système apprend un détail après la création du dossier avec CreateJob, par exemple le numéro de conteneur d’une réservation ou le transporteur routier qui viendra l’enlever. Pour enregistrer des événements et des champs de données, utilisez plutôt SaveSeqData.

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

POST /api/v1/UpdateWOHeader
Token: your-token
Content-Type: application/json

{
  "WOID": 48211,
  "Fields": [
    { "ContNum": "ABCU1234560" },
    { "SealNum": "SL778812" },
    { "TransID": 2210 },
    { "Weight": 21450.5 }
  ]
}

Champ	Obligatoire	Signification
`WOID`	Oui	L’identifiant de l’ordre de travail, un nombre entier.
`Fields`	Oui	Les champs d’en-tête à modifier : une liste d’objets, chacun avec un champ du tableau ci-dessous et sa nouvelle valeur. Mettez un seul champ par objet : TrakIT ne lit que le premier.

TrakIT lit WOID et Fields par nom, et ces deux noms sont sensibles à la casse. Les noms des champs dans Fields ne le sont pas : ContNum et contnum sont identiques.

Champs d’en-tête modifiables

Nommez chaque champ comme ci-dessous. Les champs que vous omettez gardent leur valeur.

Champ	Signification
`ContNum`	Container No., 20 caractères au plus. TrakIT l’enregistre tel que vous l’envoyez : envoyez-le en majuscules, sans espaces. Une chaîne vide l’efface. Il n’est pas modifié tant que l’ordre de travail a une Yard Position.
`SealNum`	Seal Number, 100 caractères au plus : lettres de A à Z, chiffres, espaces et `# $ % + , - . / @ _`.
`Commodity`	Commodity, 500 caractères au plus.
`LoadType`	Load Type : le code ou le code alternatif d’un type de chargement actif, par exemple `22G1`. TrakIT enregistre le code propre du type de chargement.
`OpID`	Carrier : un identifiant d’entité, ou `0` pour retirer le transporteur.
`TransID`	Transporter : un identifiant d’entité, ou `0` pour le retirer.
`RetTransID`	Return Transporter : un identifiant d’entité, ou `0` pour le retirer.
`OwnCont`	Shipper Container : `true` quand le conteneur appartient au chargeur, sinon `false`.
`Resp`	Responsible Person : un identifiant utilisateur, par exemple `JSMITH`.
`Weight`	Weight, en kilogrammes, de 0 à 50 000 000.
`Priority`	La priorité de l’ordre de travail, un nombre entier : `1` Critical, `2` High, `3` Normal, `4` Low ou `5` Very Low. `0` donne `3`.

Envoyez les nombres comme des nombres JSON et OwnCont sous la forme true ou false. Une valeur null est refusée pour ces champs : pour retirer une entité, envoyez 0.

Les autres champs d’en-tête, comme le client, les agents, le volume ou le type de dossier, ne peuvent pas être modifiés ici. Une modification ne s’applique qu’à cet ordre de travail, pas aux autres ordres de travail de son dossier.

Règles

TrakIT lit les champs dans l’ordre où vous les envoyez et s’arrête au premier qu’il refuse. Il contrôle ensuite l’en-tête de l’ordre de travail tel qu’il serait après la modification : les contrôles du responsable, du poids, du type de chargement, de la marchandise, du numéro de scellé et de la priorité s’appliquent aussi aux valeurs que vous n’envoyez pas. Rien n’est enregistré à moins que tous les contrôles ne soient satisfaits.

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`
La requête a un corps JSON.	`No request body found`
`WOID` est un nombre entier.	`WOID missing or invalid`
`Fields` est une liste.	`No field list found`
Un ordre de travail a cet identifiant.	`No such work order`
L’ordre de travail est actif ou abandonné, ni clôturé ni annulé.	`WO ... is not open`
Chaque champ de `Fields` est l’un des champs ci-dessus.	`... is not recognized or supported`
`OpID`, `TransID`, `RetTransID`, `Weight` et `Priority` sont des nombres.	`OpID should be numeric`, `TransID should be numeric`, `RetTransID should be numeric`, `Weight should be numeric`, `Priority should be numeric`
`OwnCont` vaut `true` ou `false`.	`OwnCont must be boolean`
Le responsable n’est pas vide.	`Responsible Person must be specified.`
Le poids est compris entre 0 et 50 000 000.	`Weight must be in range 0 to 50,000,000 Kg`
Le type de chargement, s’il y en a un, est le code ou le code alternatif d’un type de chargement actif.	`Load Type is not valid`
Si le conteneur figure dans la liste des conteneurs avec un type de chargement vérifié, l’ordre de travail a ce type de chargement.	`Load Type '...' does not match Container Master`
La marchandise ne contient pas de script.	`Commodity contains invalid characters`
Le numéro de scellé ne contient que les caractères autorisés.	`Seal Number contains invalid characters`
La priorité est comprise entre 1 et 5.	`Priority must be between 1 (Urgent) and 5 (On Hold)`
Le numéro de scellé compte 100 caractères au plus.	`Seal Number can be a maximum of 100 characters`
Les validations de votre société pour Save WO Header et Save Job Header sont satisfaites.	Leurs propres messages
`Resp` est un identifiant utilisateur.	`Unable to save. User ... is not valid`
`OpID`, `TransID` et `RetTransID` sont des identifiants d’entités, et `ContNum` compte 20 caractères au plus.	`Unable to save`

Réponse

En cas de succès, Code vaut 1, Info est vide et RetInfo vaut null. Lisez l’ordre de travail avec GetWO pour le voir.

{
  "Code": 1,
  "Info": "",
  "RetInfo": null,
  "RowsAffected": 0,
  "Scalar": null,
  "Identity": 0
}

Notes

La modification est enregistrée dans le journal d’audit de l’ordre de travail au nom de l’utilisateur de l’API, lorsqu’une valeur a changé.
Les champs de données du transporteur, des transporteurs routiers et des agents de l’ordre de travail sont copiés dans ses événements et ses données lorsque votre société l’a configuré : voir Copier les valeurs dans les ordres de travail.
TrakIT exécute ensuite les actions de votre société pour Save WO Header, et avertit les utilisateurs abonnés aux notifications Update WO Header.
Envoyez les valeurs qu’exige votre workflow : un champ d’en-tête qu’il rend Mandatory dans son onglet Header Fields ne doit pas être effacé, une marchandise doit provenir de la liste du workflow s’il en a une, et un numéro de conteneur doit être valide pour le workflow.