CreateJob

Crea un expediente con sus órdenes de trabajo, una por contenedor o carga, en una sola solicitud: lo que hace Crear un expediente en TrakIT. Utilícelo cuando los expedientes empiezan en otro sistema, como un sistema de reservas o de aduanas. Después, lea el expediente con GetJob, registre sus eventos con SaveSeqData y cambie la cabecera de una orden de trabajo con UpdateWOHeader.

Cómo iniciar sesión y leer la respuesta: Autenticación, Respuestas.

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

{
  "WFID": 12,
  "TD": "EXBL2610045",
  "CusID": 3021,
  "ShipperID": 3022,
  "ReceiverID": 3021,
  "JobType": [2],
  "CargoType": 0,
  "IncoTerms": "CIF",
  "Remarks": "Booking received from the customer portal",
  "WOList": [
    {
      "ContNum": "ABCU1234560",
      "TypeCode": "22G1",
      "SealNum": "SL778812",
      "Commodity": "Ceramic tiles",
      "Weight": 21450.5,
      "OpID": 1187,
      "TransID": 2210,
      "ClAgentID": 2304,
      "Resp": "JSMITH",
      "Priority": 3,
      "Remarks": "Check the seal at the gate",
      "CustRemarks": "Delivery before noon",
      "Services": [4, 6]
    },
    {
      "ContNum": "ABCU2345677",
      "TypeCode": "45G1",
      "SealNum": "SL778813",
      "Commodity": "Ceramic tiles",
      "Weight": 24310,
      "OpID": 1187,
      "Resp": "JSMITH",
      "Services": [4]
    }
  ]
}

TrakIT lee el cuerpo campo por campo, por su nombre, y los nombres distinguen entre mayúsculas y minúsculas: envíe WFID, no wfid. Un campo que no conoce se ignora. También se ignora un valor que no puede leer como el tipo del campo, por ejemplo texto en un campo numérico: TrakIT trata entonces el campo como no enviado. Envíe los números como números JSON y las listas como listas JSON. Un campo que no envíe queda vacío, salvo que su fila más abajo indique un valor predeterminado.

Los campos rellenan los campos de cabecera del expediente y de las órdenes de trabajo. La API los nombra como se indica a continuación.

Campos del expediente

Campo	Obligatorio	Significado
WFID	Sí	El flujo de trabajo del expediente: su identificador, un número entero, como en la columna ID de Definiciones de flujos de trabajo.
TD	No	La referencia del expediente, por ejemplo el número de conocimiento de embarque. TrakIT quita los espacios, la guarda en mayúsculas y conserva los 30 primeros caracteres. Solo se admiten las letras de la A a la Z, las cifras, -, _, , y /, y ningún otro expediente puede tener la misma referencia. Envíela con cada expediente: consulte Enviar expedientes completos.
CusID	No	El cliente: el identificador de la entidad, como en la columna ID de Gestión de entidades.
ShipperID	No	El cargador: un identificador de entidad.
ReceiverID	No	El receptor: un identificador de entidad.
JobType	No	Los tipos de expediente: una lista de identificadores de tipos de expediente, números enteros, también para uno solo: [2]. El soporte de TrakIT puede facilitarle los identificadores de sus tipos de expediente.
CargoType	No	El tipo de mercancía, como número: consulte Tipos de mercancía.
IncoTerms	No	Los Incoterms: uno o varios de EXW, FCA, FAS, FOB, CFR, CIF, CPT, CIP, DPU, DAP y DDP, separados por comas, por ejemplo CIF o FOB,CIF. Como máximo 100 caracteres.
Remarks	No	Remarks For Job, común a todas las órdenes de trabajo del expediente.
WOList	Sí	Las órdenes de trabajo: una lista de al menos un objeto, con los campos siguientes.

Campos de la orden de trabajo

Cada elemento de WOList es una orden de trabajo.

Campo	Obligatorio	Significado
ContNum	No	El número de contenedor, como máximo 20 caracteres. TrakIT lo guarda tal como lo envía: envíelo en mayúsculas y sin espacios. Dos órdenes de trabajo de una misma solicitud no pueden tener el mismo número de contenedor.
TypeCode	No	El tipo de carga: el código o el código alternativo de un tipo de carga activo, por ejemplo 22G1. TrakIT guarda el código propio del tipo de carga.
SealNum	No	El número de precinto, como máximo 100 caracteres: letras de la A a la Z, cifras, espacios y # $ % + , - . / @ _.
Commodity	No	La mercancía, como máximo 500 caracteres.
Weight	No	El peso en kilogramos, de 0 a 50 000 000. El valor predeterminado es 0.
OpID	No	El transportista: un identificador de entidad.
TransID	No	El transportista por carretera: un identificador de entidad.
BondAgentID	No	El agente de fianzas: un identificador de entidad.
ClAgentID	No	El agente de aduanas: un identificador de entidad.
Resp	No	El responsable: un identificador de usuario, por ejemplo JSMITH. El valor predeterminado es el usuario de la API.
Priority	No	La prioridad de la orden de trabajo, un número entero: 1 Critical, 2 High, 3 Normal, 4 Low o 5 Very Low. El valor predeterminado, también para 0, es 3.
Remarks	No	Internal Remarks.
CustRemarks	No	Remarks For Customer.
Services	No	Los servicios de la orden de trabajo: una lista de identificadores de servicios, números enteros, por ejemplo [4, 6]. Los administradores del sistema ven los identificadores en Workflow Services, en Tablas maestras. Un servicio que el flujo de trabajo no ofrece se omite.

CreateJob solo define los campos de cabecera anteriores. Defina después el transportista por carretera de retorno y Shipper Container con UpdateWOHeader, los eventos y los campos de datos con SaveSeqData, y los demás campos, como el volumen, los países y la lista de ubicaciones, en la orden de trabajo en TrakIT (Modificar una orden de trabajo).

Tipos de mercancía

CargoType	Tipo de mercancía en TrakIT	CargoType en GetJob
0	Full Container Load (FCL)	FCL
1	Less than Container Load (LCL)	LCL
2	Bulk	Bulk
3	Break-Bulk	BreakBulk
4	Air Freight	Air
5	Charter	Charter
6	Bags	Bags
7	Tanker	Tanker
8	Pallets	Pallets
9	Bales	Bales
10	Boxes/Cartons	Boxes
11	Bagged & Bulk	BagBulk
12	FMCG	FMCG
13	Drums	Drums
14	Jerrycans	Jerrycans
15	Units	Units
16	Vehicles	Vehicles
17	Big Bags	BigBags
18	Empty Container	Empty
99	Other	Other

Reglas

TrakIT comprueba primero el expediente y después cada orden de trabajo, en el orden de WOList. Si una comprobación falla, no se crea nada: ni el expediente ni ninguna de sus órdenes de trabajo. Info da el mensaje, pero no indica a qué orden de trabajo se refiere.

Su empresa también puede tener validaciones propias, configuradas por el soporte de TrakIT: consulte Validaciones y acciones. Las operaciones que se aplican aquí son Create Job, Save WO Header, Save Job Header y Create WO. Sus mensajes llegan de la misma forma en Info.

La solicitud y el expediente:

Regla	Info si no se cumple
El encabezado Token contiene un token válido.	Token missing in header, Token invalid or expired, u otra respuesta indicada en Token de inicio de sesión
El usuario es un administrador del sistema con acceso a la API.	API User must be SysAdmin with API Access
La solicitud tiene un cuerpo JSON.	No request body found
WOList es una lista de al menos una orden de trabajo.	No WO list found
TD solo contiene los caracteres admitidos.	... is not valid, que empieza por el nombre corto que su instalación da a la referencia del expediente: de forma predeterminada T/D is not valid
CusID, ShipperID y ReceiverID, si se envían, son identificadores de entidades.	No such entity
Sus campos de datos de entidad obligatorios están rellenos.	Error: Entity '...' Mandatory data field '...' is missing
Se cumplen las validaciones de su empresa para Create Job.	Sus propios mensajes
Ningún otro expediente tiene la misma referencia.	... '...' already exists in workflow ..., que empieza por el nombre que su instalación da a la referencia del expediente: de forma predeterminada Transport Document '...' already exists in workflow ...
WFID es el identificador de un flujo de trabajo, y IncoTerms tiene como máximo 100 caracteres.	Unable to create job

Cada orden de trabajo:

Regla	Info si no se cumple
Services solo contiene números enteros.	Service IDs must be integers
Resp, si se envía, no está vacío.	Responsible Person must be specified.
Weight está entre 0 y 50 000 000.	Weight must be in range 0 to 50,000,000 Kg
TypeCode, si se envía, es el código o el código alternativo de un tipo de carga activo.	Load Type is not valid
Si el contenedor está en la lista de contenedores con un tipo de carga verificado, TypeCode es ese tipo de carga.	Load Type '...' does not match Container Master
Commodity no contiene ningún script.	Commodity contains invalid characters
SealNum solo contiene los caracteres admitidos.	Seal Number contains invalid characters
Priority está entre 1 y 5.	Priority must be between 1 (Urgent) and 5 (On Hold)
SealNum tiene como máximo 100 caracteres.	Seal Number can be a maximum of 100 characters
Ninguna orden de trabajo anterior de la solicitud tiene el mismo número de contenedor.	WO already exists
Se cumplen las validaciones de su empresa para Save WO Header y Save Job Header.	Sus propios mensajes
No se ha alcanzado el límite mensual de órdenes de trabajo nuevas de su instalación, si lo tiene.	Monthly limit on WO creation has been reached
Se cumplen las validaciones de su empresa para Create WO.	Sus propios mensajes
TransID, BondAgentID y ClAgentID, si se envían, son identificadores de entidades cuyos campos de datos de entidad obligatorios están rellenos.	No such entity, Error: Entity '...' Mandatory data field '...' is missing
Resp es un identificador de usuario, OpID el identificador de una entidad, ContNum tiene como máximo 20 caracteres y Commodity como máximo 500.	Unable to add new Work Order

Respuesta

Si tiene éxito, Identity es el identificador del nuevo expediente, y RetInfo contiene el identificador del expediente, su referencia y los identificadores de sus órdenes de trabajo. RowsAffected es 0 y Scalar es null.

{
  "Code": 1,
  "Info": "",
  "RetInfo": {
    "JobID": 10457,
    "BOLNum": "EXBL2610045",
    "WOList": [48211, 48212]
  },
  "RowsAffected": 0,
  "Scalar": null,
  "Identity": 10457
}

Campo	Significado
JobID	El identificador del expediente, el mismo que Identity.
BOLNum	La referencia del expediente tal como la ha guardado TrakIT: en mayúsculas, sin espacios, con 30 caracteres como máximo. Lea el expediente con GetJob?Num= y este valor.
WOList	Los identificadores de las nuevas órdenes de trabajo, en el orden de WOList en la solicitud. Lea cada una con GetWO.

Notas

Qué hace TrakIT con un expediente nuevo

• Cada orden de trabajo recibe los eventos, los campos de datos y los KPI (indicadores clave de rendimiento) de su flujo de trabajo que se aplican a su cliente, sus tipos de expediente y sus servicios, con sus valores predeterminados.
• Los campos de datos de las entidades del expediente y de la orden de trabajo se copian en los eventos y los datos de la orden de trabajo cuando su empresa lo ha configurado así: consulte Copiar valores en las órdenes de trabajo.
• El expediente recibe su Workflow Serial si el flujo de trabajo numera sus expedientes: consulte el Serial Format de la configuración del flujo de trabajo.
• Un número de contenedor enviado con un tipo de carga se añade a la lista de contenedores si todavía no está en ella.
• Una vez guardado el expediente, TrakIT obtiene el valor de los campos de datos calculados, ejecuta las acciones de eventos y datos que correspondan y, después, las acciones de su empresa para Create Job y Create WO. Los usuarios que se han suscrito a las notificaciones Create Job reciben un aviso por cada orden de trabajo nueva.
• El expediente y sus órdenes de trabajo quedan registrados como creados por el usuario de la API.

Enviar expedientes completos

Envíe lo que un usuario tendría que introducir en Crear un expediente:

• la referencia del expediente, con cada expediente;
• los campos de cabecera que su flujo de trabajo hace Mandatory en su pestaña Header Fields;
• una mercancía de la lista del flujo de trabajo, si la tiene;
• números de contenedor válidos para el flujo de trabajo, y tipos de expediente y servicios que este admita.

Reintentos

Una referencia de expediente solo se puede usar una vez. Si una solicitud agota el tiempo de espera y no sabe si se ha creado el expediente, búsquelo con GetJob antes de volver a enviarla. Si la vuelve a enviar, la solicitud se rechaza con ... already exists in workflow ....