Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Deck of Cards
startHiddenfalse
id0
effectTypefade
loopCardstrue
Card
labelSolcitação de Serviço
Deck of Cards
startHiddenfalse
id0
effectTypefade
loopCardstrue
Card
id0
labelInclusão de Solicitação de Serviço

Método: /mntsrws/api/v1/request

Tipo: POST

Inclui uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

  • Incluir uma Solicitação de Serviço;
  • Preencher os todos os campos obrigatórios para gerar uma Solicitação de Serviço: 

Body

Campos que compõe a requisição de inclusão da S.S..

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
locationLogic-Define se é para bem ou localizaçãoCondicionalTQB_TIPOSS
originString20Origem de RegistroSimTQB_ORIGEM
equipmentString16Código do Bem/LocalizaçãoSimTQB_CODBEM
descriptionString999Descrição da SolicitaçãoSimTQB_DESCSS
costCenterString20Código do Centro de Custo da S.S.NãoTQB_CCUSTO
counterNumeric09Primeiro Contador do EquipamentoCondicionalTQB_POSCON
secondCounterNumeric09Segundo Contador do EquipamentoCondicionalTQB_POSCO2
telephoneExtensionString10RamalCondicionalTQB_RAMAL
serviceTypeString06Código do Serviço da S.S.NãoTQB_CDSERV
priorityString01PrioridadeNãoTQB_PRIORI

Exemplo de uma requisição básica:

Bloco de código
languagejs
themeEclipse
titleRaw
{
	"equipment":"001",
	"dateTime":"20220419 13:00",
	"description":"Não esta refrigerando",
	"serviceType": "000001",
	"telephoneExtension": "569"
	"counter":2300,
	"secondCounter":550,
	"location":true
}
Nota
titleAtenção
  • O campo dateTime deverá conter um espaço entre a data e hora("dateTime":"20220430 11:00").
  • Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, caso a S.S. for inclusa para uma Localização, será necessário adicionar "location":true no body.
Card
id1
labelDistribuição de Solicitação de Serviço

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Distribui uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

  • Incluir uma S.S.;
  • Preencher os campos obrigatórios para distribuir a S.S.;
  • No value deverá ser informado o número da Solicitação de serviço: /mntsrws/api/v1/request/000298/distribute, que no caso do exemplo foi utilizado como 000298.

Body

Lista dos campos disponíveis no método de inclusão de O.S.:

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
executorString25Define se é para bem ou localizaçãoCondicionalTQB_CDEXEC
serviceTypeString20Origem de RegistroSimTQB_CDSERV


Exemplo de distribuição de uma S.S.:

Bloco de código
languagejs
themeEclipse
titleRaw
{   
    "executor":"000000",
    "serviceType":"000001"
}
Card
id1
labelInclusão de O.S. a partir de uma Solicitação de Serviço

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Inclui uma O.S. a partir de uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

  • Incluir uma O.S. para a Solicitação de Serviço já existente;
  • Preencher os campos obrigatórios para gerar a O.S.;
  • No value deverá ser informado o número da Solicitação de serviço: /mntsrws/api/v1/request/000298/order, que no caso do exemplo foi utilizado como 000298.

Body

Lista dos campos disponíveis no método de inclusão de O.S.:

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
locationLogic-Define se é para bem ou localizaçãoCondicionalTJ_TIPOOS
originString20Origem de RegistroSimTQB_ORIGEM
equipmentString16Código do Bem/LocalizaçãoSimTJ_CODBEM
costCenterString20Código do Centro de Custo da O.S.SimTJ_CCUSTO
startDateString08(data) + 05(hora)Data e Hora da abertura da O.S.( 20220419 13:00 )SimTJ_DTORIGI / TJ_HOMPINI / TJ_HORACO1 / TJ_HORACO2
service  String20Código do serviço da O.S.SimTJ_SERVICO
situationNumeric09Situação da O.S. ( P = Pendente / L = Liberada )SimTJ_SITUACA
counterNumeric09Primeiro Contador do EquipamentoCondicionalTJ_POSCON
secondCounterNumeric09Segundo Contador do EquipamentoCondicionalTJ_POSCO2
workCenterNumeric09Código do Centro de TrabalhoNãoTJ_CENTRAB
sequenceString10Sequência da ManutençãoNãoTJ_SEQRELA
downTimeString06Data e Hora de Para inicio do bem da O.S.( 20220430 11:00 )NãoTJ_DTPRINI / TJ_HOPRINI
inputs array999Array de Insumos previstos da O.S.Não-

Inputs

Lista dos campos que estão disponíveis para serem utilizados dentro do inputs:

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
operationString01C = Inclusão do InsumoSim-
taskString06Código da TarefaSimTL_TAREFA
typeString01Tipo de InsumoSimTL_TIPOREG
codeString30Código do InsumoSimTL_CODIGO
unityString02Unidade do InsumoSimTL_UNIDADE
amountNumeric09Quantidade do InsumoSimTL_QUANTID
isDoneLogic-Define se é Insumo previsto ou realizadoSim-
dateString08(data) + 05(hora)Data e Hora inicio previsto para o insumoSimTL_DTINICI / TL_HOINICI
destinyString01Destino do insumoCondicionalTL_DESTINO
resourceAmountNumeric03Quantidade do recursoCondicionalTL_QUANREC
warehouseString06AlmoxarifadoCondicionalTL_LOCAL
noteString             10Observações (MEMO)Condicional          TL_OBSERVA

Exemplo de inclusão de uma O.S. sem informar insumo:

Bloco de código
languagejs
themeEclipse
titleRaw
{   
    "equipment":"CLIO",
    "service":"CORGEN",
    "situation": "L",
    "costCenter": "099",
    "startDate":"20200101 14:00"
}

Exemplo de inclusão de uma O.S. informando um insumo do tipo produto:

Bloco de código
languagejs
themeEclipse
titleRaw
{  
    "equipment":"CLIO",
    "service":"CORGEN",
    "situation": "L",
    "costCenter": "099",
    "startDate":"20200101 14:00",
    "inputs":[  
      {  
         "operation":"C",
         "task":"0",
         "destiny":"A",
         "code":"PRODGEN",
         "type":"P",
         "warehouse":"01",
         "date":"20180701 09:00",
         "amount":3,
         "isDone":false,
         "unity":"UN"
      }
    ]
}
Nota
titleAtenção
  • O campo date deverá conter um espaço entre a data e hora("date":"20220430 11:00");
  • Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, caso o insumo da O.S. a ser incluída for do tipo Produto, será necessário adicionar destiny ao body.
Card
labelAbastecimento
Deck of Cards
id0
effectTypefade
loopCardstrue
Card
id0
labelInclusão de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: POST

Inclui um Abastecimento.

Ao executar a chamada do webservice o método irá:

  • Incluir um abastecimento;
  • Preencher os todos os campos obrigatórios para gerar um abastecimento: 

Body

Campos que compõe a requisição de um abastecimento.

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
plateString8Placa do VeículoSimTQN_PLACA
equipmentString16Código do VeículoSimTQN_FROTA
fuelString03Código do CombustívelSimTQN_CODCOM
gasStationString14Código do postoSimTQN_POSTO
storeString14Código do lojaSimTQN_LOJA
cnpjString14CNPJ do postoNãoTQN_CNPJ
dateDate08Data do abastecimentoSimTQN_DTABAS
hourString05Hora da abastecimentoSimTQN_HRABAS
tankString02tanque do postoSimTQN_TANQUE
bombString03bomba do postoSimTQN_BOMBA
quantNumeric09quantidade abastecidaSimTQN_QUANT
unitaryValueNumeric09valor unitário do combustívelSimTQN_VALUNI
amountNumeric15valor total do combustívelSimTQN_VALTOT
counterNumeric09Contador do equipamentoCondicionalTQN_HODOM
secondCounterNumeric09Segundo Contador do equipamentoCondicionalTQN_POSCO2
driverString06Código do motoristaCondicionalTQN_CODMOT
invoiceString09Código da nota fiscalCondicionalTQN_NOTFIS
tripString06Código da viagemCondicionalTQN_CODVIA
scaleString08Código da escalaCondicionalTQN_ESCALA


Exemplo de um abastecimento padrão:

Bloco de código
languagejs
themeEclipse
titleRaw
{
   "plate":"MNT-1234",
   "equipment":"VEI-S10",
   "fuel":"MNT",
   "gasStation":"MNTPOS",
   "store":"01",
   "cnpj":"34236121000159",
   "date":"20230220",
   "hour":"12:10",
   "tank":"01",
   "bomb":"01",
   "quant":5,
   "unitaryValue":4,
   "amount":20
   
}
Nota
titleAtenção
  • Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, um bem com contador, necessariamente precisa do campo "counter" preenchido, Exemplo: "counter": 50.
Card
labelAlteração de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: PUT

Altera um Abastecimento.

Ao executar a chamada do webservice o método irá:

  • Alterar um abastecimento já existente;
  • Preencher os todos os campos obrigatórios para gerar um abastecimento: 

Body

Campos que compõe a alteração de um abastecimento.

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
equipmentString16Código do VeículoSimTQN_CODBEM
dateString08Data do abastecimentoSimTQN_DTABAS
hourString05Hora da abastecimentoSimTQN_HRABAS
quantNumeric09quantidade abastecidaSimTQN_QUANT
unitaryValueNumeric09valor unitário do combustivelSimTQN_VALUNI
amountNumeric15valor total do combustívelSimTQN_VALTOT
Bloco de código
languagejs
themeEclipse
titleRaw
{
   "equipment":"VEI-S10",
   "date":"20230320",
   "hour":"12:10",
   "quant":6,
   "unitaryValue":4,
   "amount":24
   
}
Card
labelDeleção de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: DELETE

Excluí um Abastecimento.

Ao executar a chamada do webservice o método irá:

  • Excluir um abastecimento já existente;
  • Preencher os todos os campos obrigatórios para gerar um abastecimento: 

Body

Campos que compõe a alteração de um abastecimento.

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
equipmentString16Código do VeículoSimTQN_CODBEM
dateTimeString08Data do abastecimentoSimTQN_DTABAS
timeString05Hora da abastecimentoSimTQN_HRABAS
Bloco de código
languagejs
themeEclipse
titleRaw
{
   "equipamentequipment":"VEI-S10",
   "date":"20230320",
   "hour":"12:10"
 }



...