get https://platform.nstech.com.br/api/mdm/entities/vehicle/queryByTemplate/queryByDataIdentifier?paramCountryId=¶mVehiclePlate=
Este tema contém os padrões MDM para tipos de veículos, modelos de veículos, tipos de carrocerias, tipos de tração, composições de tração, combustíveis, tipos de identificações veiculares e a base de veículos cadastrados no MDM
Tipos de veículos (vehicleType)
-
Descrição
Esta entidade padroniza os seguintes atributos de tipos de veículos:- Id
- nome
- modal logístico
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId identificador do tipo de veículo int name nome do tipo de veículo string transportationTypeId data.id (identificador) do modal logístico associado ao tipo de veículo int transportationTypeId transportationTypeName nome do modal logístico associado ao tipo de veículo string transportationTypeName dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "641b0dbcccef2b9e4ea7e4c1", "entityType": "vehicleType", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "VehicleType Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "This entity provides the default most commom model used at nstech Platform", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "An integer value", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "the composition of the document object", "$id": "#/properties/data", "type": "object", "required": [ "name", "transportationType" ], "properties": { "name": { "title": "Name of vehicle type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 }, "transportationType": { "$id": "#/properties/data/properties/transportationType", "type": "object", "examples": [ "{\"customer_code\": \"11222333000199\"}" ], "required": [ "dataId", "name" ], "properties": { "dataId": { "title": "id of transportation type", "$id": "#/properties/data/properties/transportationType/properties/dataId", "type": "integer" }, "name": { "title": "Name of transportation type.", "$id": "#/properties/data/properties/transportationType/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 } } }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "vehicleType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-03-22T14:16:28.495Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636fec9bdd04eb0288a17e1d", "entityType": "vehicleType", "revision": 1, "data": { "name": "Cavalo mecânico", "transportationType": { "dataId": 1, "name": "Transporte rodoviário" }, "dataId": 1, "dataIdentifier": { "name": "Cavalo mecânico" } }, "createdAt": "2022-11-12T18:57:31.032Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:57:31.032Z" }, { "_id": "636feca6dd04eb0288a17e1f", "entityType": "vehicleType", "revision": 1, "data": { "name": "Toco", "transportationType": { "dataId": 1, "name": "Transporte rodoviário" }, "dataId": 2, "dataIdentifier": { "name": "Toco" } }, "createdAt": "2022-11-12T18:57:42.686Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:57:42.686Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/vehicleType/queryByTemplate/all?page=2&limit=2" }
Modelos de veículos (vehicleModel)
-
Descrição
Esta entidade padroniza os seguintes atributos de modelos do veículos:- Id
- nome
- fabricante
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId identificador do modelo de veículo int name nome do modelo de veículo string companyId data.id (identificador) da empresa fabricante do veículo int companyId companyName nome da empresa fabricante do veículo string companyName dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e48c2fdf838348471eec", "entityType": "vehicleModel", "revision": 2, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "Vehicle Model Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "Vehicle Model Entity", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object.", "required": [ "name", "company" ], "$id": "#/properties/data", "type": "object", "properties": { "name": { "title": "Name of Vehicle Model.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 }, "company": { "$id": "#/properties/data/properties/company", "type": "object", "required": [ "dataid", "name" ], "properties": { "dataid": { "title": "Value of company dataId.", "$id": "#/properties/data/properties/company/properties/dataId", "type": "integer" }, "name": { "title": "Company name.", "$id": "#/properties/data/properties/company/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 } } }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "vehicleModel": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [ "name", "company.dataid", "company.name" ], "effectiveDate": "2023-01-23T17:54:20.354Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "63cecd4df055e538ed175946", "entityType": "vehicleModel", "revision": 1, "data": { "name": "MARRUÁ 2.8 12V 132cv TDI Diesel", "company": { "dataid": 24, "name": "Agrale" }, "dataId": 1, "dataIdentifier": { "name": "MARRUÁ 2.8 12V 132cv TDI Diesel" } }, "createdAt": "2023-01-23T18:09:17.470Z", "updatedAt": "2023-01-23T18:09:17.470Z", "deleted": false, "userCreator": "service-account-mdm" }, { "_id": "63cecd57f055e538ed175948", "entityType": "vehicleModel", "revision": 1, "data": { "name": "MARRUÁ AM 100 2.8 CS TDI Diesel", "company": { "dataid": 24, "name": "Agrale" }, "dataId": 2, "dataIdentifier": { "name": "MARRUÁ AM 100 2.8 CS TDI Diesel" } }, "createdAt": "2023-01-23T18:09:27.507Z", "updatedAt": "2023-01-23T18:09:27.507Z", "deleted": false, "userCreator": "service-account-mdm" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/vehicleModel/queryByTemplate/all?page=2&limit=2" }
Tipos de carrocerias (bodyworkType)
-
Descrição
Esta entidade padroniza o seguinte atributos de tipos de carroceria de veículos:- Id
- nome
- modal logístico
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId identificador do tipo de carroceria int name nome do tipo de carroceria string transportationTypeId data.id (identificador) do modal logístico associado ao tipo de carroceria int transportationTypeId transportationTypeName nome do modal logístico associado ao tipo de carroceria string transportationTypeName dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "641b0a22ccef2b9e4ea6aa72", "entityType": "bodyworkType", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "BodyworkType Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "This entity provides the default most commom model used at nstech Platform", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "An integer value", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object", "$id": "#/properties/data", "type": "object", "required": [ "name", "transportationType" ], "properties": { "name": { "title": "Name of bodywork type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 }, "transportationType": { "$id": "#/properties/data/properties/transportationType", "type": "object", "examples": [ "{\"customer_code\": \"11222333000199\"}" ], "required": [ "dataId", "name" ], "properties": { "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/transportationType/properties/dataId", "type": "integer" }, "name": { "title": "Name of transportation type.", "$id": "#/properties/data/properties/transportationType/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 } } }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "bodyworkType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-03-22T14:01:06.244Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636febfb062b1fff9d9d02f4", "entityType": "bodyworkType", "revision": 1, "data": { "name": "Baú", "transportationType": { "dataId": 1, "name": "Transporte rodoviário" }, "dataId": 1, "dataIdentifier": { "name": "Baú" } }, "createdAt": "2022-11-12T18:54:51.529Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:54:51.529Z" }, { "_id": "636fec05062b1fff9d9d02f6", "entityType": "bodyworkType", "revision": 1, "data": { "name": "Sider", "transportationType": { "dataId": 1, "name": "Transporte rodoviário" }, "dataId": 2, "dataIdentifier": { "name": "Sider" } }, "createdAt": "2022-11-12T18:55:01.028Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:55:01.028Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/bodyworkType/queryByTemplate/all?page=2&limit=2" }
Tipos de tração (tractionType)
-
Descrição
Esta entidade padroniza os seguintes atributos de tipos de tração de veículos:- Id
- nome
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId identificador do tipo de tração int name nome do tipo de tração string dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e48b2fdf838348471eea", "entityType": "tractionType", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "tractionType", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object.", "$id": "#/properties/data", "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Name of traction type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 3, "maxLength": 200 }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "tractionType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-25T18:42:26.785Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636ff323ce9d5627804ceb32", "entityType": "tractionType", "revision": 1, "data": { "name": "Motor de combustão", "dataId": 1, "dataIdentifier": { "name": "Motor de combustão" } }, "createdAt": "2022-11-12T19:25:23.133Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:25:23.133Z" }, { "_id": "636ff34dcff33738b4078bfc", "entityType": "tractionType", "revision": 1, "data": { "name": "Elétrico", "dataId": 2, "dataIdentifier": { "name": "Elétrico" } }, "createdAt": "2022-11-12T19:26:05.116Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:26:05.116Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/tractionType/queryByTemplate/all?page=2&limit=2" }
Composições de tração (tractionComposition)
-
Descrição
Esta entidade padroniza os seguintes atributos de composições de tração de veículos:- Id
- nome
- texto complementar
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador da composição de tração do veículo int name nome da composição de tração do veículo string complement texto complementar sobre a composição de tração do veículo string dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e48b2fdf838348471ee9", "entityType": "tractionComposition", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "tractionComposition", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object.", "$id": "#/properties/data", "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Name of vehicle traction composition type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 3, "maxLength": 200 }, "alternativeName": { "title": "Common name about the vehicle traction composition", "$id": "#/properties/data/properties/alternativeName", "type": "string", "minLength": 3, "maxLength": 200 }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "tractionComposition": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-25T18:39:06.022Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636ff976cff33738b4078e9b", "entityType": "tractionComposition", "revision": 1, "data": { "name": "4x2", "complement": "Toco", "dataId": 1, "dataIdentifier": { "name": "4x2" } }, "createdAt": "2022-11-12T19:52:22.488Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:52:22.488Z" }, { "_id": "636ff982cff33738b4078e9d", "entityType": "tractionComposition", "revision": 1, "data": { "name": "4x4", "dataId": 2, "dataIdentifier": { "name": "4x4" } }, "createdAt": "2022-11-12T19:52:34.686Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:52:34.686Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/tractionComposition/queryByTemplate/all?page=2&limit=2" }
Combustíveis (fuel)
-
Descrição
Esta entidade padroniza os seguintes atributos de combustíveis:- Id
- nome
- sigla
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador do combustível int name nome do combustível string abbrev sigla do combustível string dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e4862fdf838348471ed7", "entityType": "fuel", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "Fuel Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "This entity provides the default most commom model used at nstech Platform", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "the composition of the document object", "$id": "#/properties/data", "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Name of fuel type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 40 }, "abbrev": { "title": "Abbreviation of Fuel type.", "$id": "#/properties/data/properties/abbrev", "type": "string", "minLength": 1, "maxLenght": 10 }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "fuel": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-24T19:10:13.002Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636fbb44dd04eb0288a17dae", "entityType": "fuel", "revision": 1, "data": { "name": "Etanol", "dataId": 1, "dataIdentifier": { "name": "Etanol" } }, "createdAt": "2022-11-12T15:27:00.555Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:27:00.555Z" }, { "_id": "636fbb51062b1fff9d9d028a", "entityType": "fuel", "revision": 1, "data": { "name": "Gasolina", "dataId": 2, "dataIdentifier": { "name": "Gasolina" } }, "createdAt": "2022-11-12T15:27:13.170Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:27:13.170Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/fuel/queryByTemplate/all?page=2&limit=2" }
Tipos de identificações (identificationType)
-
Descrição
Esta entidade padroniza os seguintes atributos de tipos de identificadores:- Id
- nome
- modais logísticos associados ao identificador
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId identificador do tipo de identificação int name nome do tipo de identificação string transportationTypeId [array] array de identificadores dos modais logísticos associados ao documento int transportationTypeId transportationTypeName [array] array de nome dos modais logísticos associados ao documento string transportationTypeName dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e4862fdf838348471ed9", "entityType": "identificationType", "revision": 2, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "identificationType Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "Device Model Entity", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object.", "required": [ "name", "transportationType" ], "$id": "#/properties/data", "type": "object", "properties": { "name": { "title": "Name of Device Model.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 }, "transportationType": { "$id": "#/properties/data/properties/transportationType", "type": "array", "items": { "type": "object", "properties": { "transportationTypeId": { "$id": "#/properties/data/properties/accessoryType/properties/transportationTypeId", "type": "integer" }, "transportationTypeName": { "$id": "#/properties/data/properties/accessoryType/properties/transportationTypeName", "type": "string", "minLength": 1, "maxLenght": 200 } } } }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "identificationType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [ "name", "transportationType" ], "effectiveDate": "2023-01-23T22:08:58.937Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "63cf05851dde420cf9960b72", "entityType": "identificationType", "revision": 1, "data": { "name": "Placa", "transportationType": [ { "transportationTypeId": 1, "transportationTypeName": "Transporte rodoviário" } ], "dataId": 1, "dataIdentifier": { "name": "Placa" } }, "createdAt": "2023-01-23T22:09:09.191Z", "updatedAt": "2023-01-23T22:09:09.191Z", "deleted": false, "userCreator": "service-account-mdm" }, { "_id": "63cf05851dde420cf9960b74", "entityType": "identificationType", "revision": 1, "data": { "name": "Chassi", "transportationType": [ { "transportationTypeId": 1, "transportationTypeName": "Transporte rodoviário" } ], "dataId": 2, "dataIdentifier": { "name": "Chassi" } }, "createdAt": "2023-01-23T22:09:09.215Z", "updatedAt": "2023-01-23T22:09:09.215Z", "deleted": false, "userCreator": "service-account-mdm" } ], "page": 1, "limit": 2, "nextPageURL": "Last Page" }
Base de veículos cadastrados (vehicle)
-
Descrição
Esta entidade é uma base de dados veículos. Cada veículo cadastrado tem um identificador único (Id), além de outros atributos, tais como:
Ano de fabricação, modelo de fabricação, país, estado, cidade, dados de identificação como número da placa e chassi, proprietário, dados do documento principal, cor, tipo, fabricante, modelo, combustível, informações sobre tração, carroceria, capacidade de carga, acessórios e dispositivos -
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador do veículo int manufacturingYear ano de fabricação int modelYear ano do modelo int countryId data.id (identificador) do país int countryId countryName nome do país string countryName provinceId identificador do estado int provinceId provinceName nome do estado string provinceName cityId identificador da cidade int cityId cityName nome da cidade string cityName Identification [array] identificationTypeId array de identificadores do tipo de identificador int identificationTypeId identificationTypeName array de nomes do tipo de identificador string identificationTypeName identificationData array de números de identificação string Owner ownerType tipo de proprietário (pessoa ou empresa) string Name nome do proprietário (pessoa ou empresa) string countryId identificador do país int countryId countryName nome do país string countryName documentId identificador do documento de identificação principal int documentId documentName nome do documento de identificação principal string documentName documentNumber número do documento de identificação principal string Main vehicle document [array] countryId identificador do país int countryId countryName nome do país string countryName documentId identificador do tipo de documento int documentId documentName nome do tipo de documento string documentName docCategoryId identificador da categoria do documento int docCategoryId docCategoryName nome da categoria do documento string docCategoryName documentNumber número do documento string docIssuerId identificador do órgão emissor do documento int docIssuerId docIssuerName nome do órgão emissor do documento string docIssuerName provinceIssuerId identificador do estado do órgão emissor do documento int provinceId provinceIssuerName nome do estado do órgão emissor do documento string ProvinceName issueDate data de emissão do documento string expirationDate data de vencimento do documento string firstIssueDate data da primeira emissão do documento string docPicture foto do documento base64 complement dados adicionais do documento objeto Vehicle color colorId identificador da cor int colorId colorName nome da cor string colorName Vehicle Type vehicleTypeId identificador do tipo de veículo int vehicleTypeId vehicleTypeName nome do tipo de veículo string vehicleTypeName Vehicle Manufacturer vehicleManufacturerId identificador da empresa fabricante int companyId vehicleManufacturerName nome da empresa fabricante string companyName Vehicle Model vehicleModelId identificador do modelo int vehicleModelId vehicleModelName nome do modelo string vehicleModelName Fuel fuelId identificador do combustível int fuelId fuelName nome do combustível string fuelName Traction tractionTypeId identificador do tipo de tração int tractionTypeId tractionTypeName nome do tipo de tração string tractionTypeName tractionCompositionId identificador da composição de tração int tractionCompositonId tractionCompositionName nome da composição de tração string tractionCompositionName Transportation Type TransportationTypeId identificador do modal int transportationTypeId TransportationTypeName nome do modal string transportationTypeName Trailler/bodywork Type bodyworkTypeId identificador do tipo de carroceria int bodyworktypeId bodyworkTypeName nome do tipo de carroceria string bodyworkTypeName Capacity [array] transportationCapacity capacidade de volume (carga) int measuringUnitId identificador da unidade de medida int measuringUnitId measuringUnitName nome da unidade de medida string measuringUnitName Accessory Type [array] accessoryTypeId array de identificadores de tipos de acessórios int accessorytypeId accessorytypeName array de nomes de tipos de acessórios string accessorytypeName Device type [array] deviceTypeId array de identificadores de tipos de dispositivos int deviceTypeId devicetypeName array de tipos de dispositivos string deviceTypeName deviceModelId array de identificadores de modelos de dispositivos int deviceModelId deviceModelName array de nomes de modelos de dispositivos string deviceModelName deviceSerialNumber array de números de série de dispositivos string deviceCompanyId array de identificadores de empresas de rastreamento int companyId deviceCompanyName array de nomes de empresas de rastreamento string companyName dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "640f73ed2fd6c99175bae738", "entityType": "vehicle", "revision": 2, "dataIdentifierSetup": [ "identification.identificationTypeId", "identification.identificationTypeName", "identification.identificationData" ], "jsonSchema": { "title": "", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "accessoryType", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/dataId", "type": "integer" }, "data": { "title": "The composition of the document object.", "$id": "#/properties/data", "type": "object", "properties": { "name": { "$id": "#/properties/data/properties/name", "type": "string" }, "manufacturingYear": { "$id": "#/properties/data/properties/manufacturingYear", "type": "string", "minLength": 10, "maxLength": 10 }, "modelYear": { "$id": "#/properties/data/properties/modelYear", "type": "string", "minLength": 10, "maxLength": 10 }, "countryId": { "$id": "#/properties/data/properties/countryId", "type": "integer" }, "countryName": { "$id": "#/properties/data/properties/countryName", "type": "string" }, "provinceId": { "$id": "#/properties/data/properties/provinceId", "type": "integer" }, "provinceName": { "$id": "#/properties/data/properties/provinceName", "type": "string" }, "cityId": { "$id": "#/properties/data/properties/cityId", "type": "integer" }, "cityName": { "$id": "#/properties/data/properties/cityName", "type": "string" }, "identification": { "$id": "#/properties/data/properties/identification", "type": "object", "properties": { "identificationTypeId": { "$id": "#/properties/data/properties/identification/properties/identificationTypeId", "type": "integer" }, "identificationTypeName": { "$id": "#/properties/data/properties/identification/properties/identificationTypeName", "type": "string" }, "identificationData": { "$id": "#/properties/data/properties/identification/properties/identificationData", "type": "string" } } }, "owner": { "$id": "#/properties/data/properties/owner", "type": "object", "properties": { "ownerType": { "$id": "#/properties/data/properties/owner/properties/ownerType", "type": "string" }, "name": { "$id": "#/properties/data/properties/owner/properties/name", "type": "string" }, "countryId": { "$id": "#/properties/data/properties/owner/properties/countryId", "type": "integer" }, "countryName": { "$id": "#/properties/data/properties/owner/properties/countryName", "type": "string" }, "documentId": { "$id": "#/properties/data/properties/owner/properties/documentId", "type": "integer" }, "documentName": { "$id": "#/properties/data/properties/owner/properties/documentName", "type": "string" }, "documentData": { "$id": "#/properties/data/properties/owner/properties/documentData", "type": "string" } } }, "document": { "$id": "#/properties/data/properties/document", "type": "array", "items": { "type": "object", "properties": { "countryId": { "$id": "#/properties/data/properties/document/properties/countryId", "type": "integer" }, "countryName": { "$id": "#/properties/data/properties/document/properties/countryName", "type": "string" }, "documentId": { "$id": "#/properties/data/properties/document/properties/documentId", "type": "integer" }, "documentName": { "$id": "#/properties/data/properties/document/properties/documentName", "type": "string" }, "documentData": { "$id": "#/properties/data/properties/document/properties/documentData", "type": "string" }, "docCategoryId": { "$id": "#/properties/data/properties/document/properties/docCategoryId", "type": "integer" }, "docCategoryName": { "$id": "#/properties/data/properties/document/properties/docCategoryName", "type": "string" }, "docIssuerId": { "$id": "#/properties/data/properties/document/properties/docIssuerId", "type": "integer" }, "docIssuerName": { "$id": "#/properties/data/properties/document/properties/docIssuerName", "type": "string" }, "provinceIssuerId": { "$id": "#/properties/data/properties/document/properties/provinceIssuerId", "type": "integer" }, "provinceIssuerName": { "$id": "#/properties/data/properties/document/properties/provinceIssuerName", "type": "string" }, "issueDate": { "$id": "#/properties/data/properties/document/properties/issueDate", "type": "string", "minLength": 10, "maxLength": 10 }, "expirationDate": { "$id": "#/properties/data/properties/document/properties/expirationDate", "type": "string", "minLength": 10, "maxLength": 10 }, "firstIssueDate": { "$id": "#/properties/data/properties/document/properties/firstIssueDate", "type": "string", "minLength": 10, "maxLength": 10 }, "docPicture": { "$id": "#/properties/data/properties/document/properties/docPicture", "type": "string" }, "complement": { "$id": "#/properties/data/properties/document/properties/complement", "type": "string" } } } }, "color": { "$id": "#/properties/data/properties/color", "type": "object", "properties": { "colorId": { "$id": "#/properties/data/properties/color/properties/colorId", "type": "integer" }, "colorName": { "$id": "#/properties/data/properties/color/properties/colorName", "type": "string" } } }, "type": { "$id": "#/properties/data/properties/type", "type": "object", "properties": { "vehicleTypeId": { "$id": "#/properties/data/properties/type/properties/vehicleTypeId", "type": "integer" }, "vehicleTypeName": { "$id": "#/properties/data/properties/type/properties/vehicleTypeName", "type": "string" } } }, "manufacturer": { "$id": "#/properties/data/properties/manufacturer", "type": "object", "properties": { "vehicleManufacturerId": { "$id": "#/properties/data/properties/manufacturer/properties/vehicleManufacturerId", "type": "integer" }, "vehicleManufacturerName": { "$id": "#/properties/data/properties/manufacturer/properties/vehicleManufacturerName", "type": "string" } } }, "model": { "$id": "#/properties/data/properties/model", "type": "object", "properties": { "vehicleModelId": { "$id": "#/properties/data/properties/model/properties/vehicleModelId", "type": "string" }, "vehicleModelName": { "$id": "#/properties/data/properties/model/properties/vehicleModelName", "type": "string" } } }, "fuel": { "$id": "#/properties/data/properties/fuel", "type": "object", "properties": { "fuelId": { "$id": "#/properties/data/properties/fuel/properties/fuelId", "type": "string" }, "fuelName": { "$id": "#/properties/data/properties/fuel/properties/fuelName", "type": "string" } } }, "traction": { "$id": "#/properties/data/properties/traction", "type": "object", "properties": { "tractionTypeId": { "$id": "#/properties/data/properties/traction/properties/tractionTypeId", "type": "string" }, "tractionTypeName": { "$id": "#/properties/data/properties/traction/properties/tractionTypeName", "type": "string" }, "tractionCompositionId": { "$id": "#/properties/data/properties/traction/properties/tractionCompositionId", "type": "string" }, "tractionCompositionName": { "$id": "#/properties/data/properties/traction/properties/tractionCompositionName", "type": "string" } } }, "transportation": { "$id": "#/properties/data/properties/transportation", "type": "object", "properties": { "transportationTypeId": { "$id": "#/properties/data/properties/transportation/properties/transportationTypeId", "type": "string" }, "transportationTypeName": { "$id": "#/properties/data/properties/transportation/properties/transportationTypeName", "type": "string" } } }, "bodywork": { "$id": "#/properties/data/properties/bodywork", "type": "object", "properties": { "bodyworkTypeId": { "$id": "#/properties/data/properties/bodywork/properties/bodyworkTypeId", "type": "string" }, "bodyworkTypeName": { "$id": "#/properties/data/properties/bodywork/properties/bodyworkTypeName", "type": "string" } } }, "capacity": { "$id": "#/properties/data/properties/capacity", "type": "array", "items": { "type": "object", "properties": { "transportationCapacity": { "$id": "#/properties/data/properties/capacity/properties/transportationCapacity", "type": "integer" }, "measuringUnitId": { "$id": "#/properties/data/properties/capacity/properties/measuringUnitId", "type": "string" }, "measuringUnitName": { "$id": "#/properties/data/properties/capacity/properties/measuringUnitName", "type": "string" } } } }, "accessoryType": { "$id": "#/properties/data/properties/accessoryType", "type": "array", "items": { "type": "object", "properties": { "accessoryTypeId": { "$id": "#/properties/data/properties/accessoryType/properties/accessoryTypeId", "type": "string" }, "accessoryTypeName": { "$id": "#/properties/data/properties/accessoryType/properties/accessoryTypeName", "type": "string" } } } }, "deviceType": { "$id": "#/properties/data/properties/deviceType", "type": "array", "items": { "type": "object", "properties": { "deviceTypeId": { "$id": "#/properties/data/properties/deviceType/properties/deviceTypeId", "type": "string" }, "deviceTypeName": { "$id": "#/properties/data/properties/deviceType/properties/deviceTypeName", "type": "string" }, "deviceModelId": { "$id": "#/properties/data/properties/deviceType/properties/deviceModelId", "type": "string" }, "deviceModelName": { "$id": "#/properties/data/properties/deviceType/properties/deviceModelName", "type": "string" }, "deviceSerialNumber": { "$id": "#/properties/data/properties/deviceType/properties/deviceSerialNumber", "type": "string" }, "deviceCompanyId": { "$id": "#/properties/data/properties/deviceType/properties/deviceCompanyId", "type": "string" }, "deviceCompanyName": { "$id": "#/properties/data/properties/deviceType/properties/deviceCompanyName", "type": "string" } } } } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "accessoryType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "queryTemplates": [ { "queryByDataIdentifier": { "query": "{ \"dataIdentifier\": { \"identification\": { \"identificationTypeId\": paramTypeId, \"identificationTypeName\": paramTypeName, \"identificationData\": paramData }}}", "description": "Get Person by dataIdentifier", "options": "{\"sort\": {\"data.name\": 1}}", "parametersRules": [ { "paramTypeId": { "type": "integer", "description": "Country Id", "minValue": 0 }, "paramTypeName": { "type": "integer", "description": "Document Id", "minValue": 0 }, "paramData": { "type": "string", "description": "Document Number", "minValue": 0 } } ] } }, { "queryByDataId": { "query": "{ \"dataId\": paramDataId }", "description": "Get Person by dataId", "options": "{\"limit\": 1}", "parametersRules": [ { "paramDataId": { "type": "integer", "description": "DataId", "minValue": 0 } } ] } }, { "queryByObjectId": { "query": "{ \"_id\": paramObjectId }", "description": "Get Person by ObjectId", "parametersRules": [ { "paramObjectId": { "type": "string", "description": "ObjectId as string" } } ] } } ], "effectiveDate": "2023-03-13T19:05:17.885Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) usando "queryTemplate (identificationType)"
Produção https://platform.nstech.com.br/api/mdm/entities/vehicle/queryByTemplate/queryByDataIdentifier?paramCountryId=76¶mVehiclePlate=AAW2695Homologação https://dev.nstech.com.br/platform/api/mdm-stg/entities/vehicle/queryByTemplate/queryByDataIdentifier?paramCountryId=76¶mVehiclePlate=AAW2695- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "6553e4769a7d1155bc400d0e", "status": true, "deleted": false, "updatedAt": "2023-11-14T21:19:50.108Z", "userCreator": "mdm-surrogate", "createdAt": "2023-11-14T21:19:50.108Z", "effectiveDate": "2023-11-14T21:19:50.108Z", "entityType": "vehicle", "revision": 4, "data": { "manufacturingYear": "2001", "modelYear": "2001", "countryId": 76, "countryName": "Brasil", "identificationDocument": { "countryId": 76, "countryName": "Brasil", "vehiclePlate": "AAW2695" }, "owner": { "ownerType": "L", "name": "ALL AMERICA LATINA LOGISTICA INTERMODAL LTDA", "countryId": 76, "countryName": "Brasil", "documentId": 20, "documentName": "Cadastro nacional de pessoas jurídicas", "documentData": "03172874000114" }, "color": { "colorId": 15, "colorName": "Vermelho" }, "type": { "vehicleTypeId": 4, "vehicleTypeName": "Carreta" }, "model": {}, "fuel": {}, "bodywork": {}, "deviceType": [{}], "dataIdentifier": { "identificationDocument": { "vehiclePlate": "AAW2695", "countryId": 76 } } } } ], "page": 1, "limit": 100 }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) usando “data id”
Produção Homologação -
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
Produção Homologação -
Exemplo de retorno
Insira nos campos param1 e param2 as informações relativas as CountryId e VehiclePlate, respectivamente.