Árvore de páginas

Versões comparadas

Chave

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

...

Password <password>

Header

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.:

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

Deck of Cards
id1
Card
id2
labelSolicitação de Serviço

Campos que deverão ser adicionados no Header para possibilitar a inclusão de uma S.S..

VariávelDescriçãoObrigatórioExemplo
tenantIdCódigo da empresa + Código da FilialSimT3,M RJ 01
x-erp-moduleRepresenta o módulo do ProtheusSim (A partir da lib 20211116)MNT
Nota
titleImportante
  • O valor inserido na variável tenantId não deverá possuir espaço entre a
virgulaSolcitação de Serviço
Card
label
  • vírgula;
  • No exemplo apresentado na tabela acima, T3 corresponde a uma empresa e M RJ 01 a uma filial.
Deck of Cards
startHiddenfalse
id0
effectTypefade
loopCardstrue

Exemplo de uma requisição básica:

  • Na variável x-erp-module deve ser utilizado apenas a abreviação do módulo, conforme o exemplo, sem o prefixo "SIGA".

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á:Tamanho
Deck of Cards
startHiddenfalse
id0
effectTypefade
loopCardstrue
Card
id0
labelInclusão de Solicitação de Serviço

Campos que deverão ser adicionados no Header para possibilitar a inclusão de um Abastecimento.

Variável
  • 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..

CampoTipo
DescriçãoObrigatório
Campo 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
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
CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
executorString25Define se é para bem ou localizaçãoCondicionalTQB_CDEXEC
serviceTypeString20Origem de RegistroSimTQB_CDSERV
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êncialocationLogic-Define se é para bem ou localizaçãoCondicionalTJ_TIPOOSoriginString20Origem de RegistroSimTQB_ORIGEMequipmentString16Código do Bem/LocalizaçãoSimTJ_CODBEMcostCenterString20Código do Centro de Custo da O.S.SimTJ_CCUSTOstartDateString08(data) + 05(hora)Data e Hora da abertura da O.S.( 20220419 13:00 )SimTJ_DTORIGI / TJ_HOMPINI / TJ_HORACO1 / TJ_HORACO2service  String20Código do serviço da O.S.SimTJ_SERVICOsituationNumeric09Situação da O.S. ( P = Pendente / L = Liberada )SimTJ_SITUACAcounterNumeric09Primeiro Contador do EquipamentoCondicionalTJ_POSCONsecondCounterNumeric09Segundo Contador do EquipamentoCondicionalTJ_POSCO2workCenterNumeric09Código do Centro de TrabalhoNãoTJ_CENTRABsequenceString10Sequência da ManutençãoNãoTJ_SEQRELAdownTimeString06Data e Hora de Para inicio do bem da O.S.( 20220430 11:00 )NãoTJ_DTPRINI / TJ_HOPRINIinputs 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ênciaoperationString01C = Inclusão do InsumoSim-taskString06Código da TarefaSimTL_TAREFAtypeString01Tipo de InsumoSimTL_TIPOREGcodeString30Código do InsumoSimTL_CODIGOunityString02Unidade do InsumoSimTL_UNIDADEamountNumeric09Quantidade do InsumoSimTL_QUANTIDisDoneLogic-Define se é Insumo previsto ou realizadoSim-dateString08(data) + 05(hora)Data e Hora inicio previsto para o insumoSimTL_DTINICI / TL_HOINICIdestinyString01Destino do insumoCondicionalTL_DESTINOresourceAmountNumeric03Quantidade do recursoCondicionalTL_QUANRECwarehouseString06AlmoxarifadoCondicionalTL_LOCALnoteString             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órioTQN_PLACAString8Placa do VeículoSimTQN_FROTAString16Código do VeículoSimTQN_CODCOMString03Código do CombustívelSimTQN_POSTOString14Código do postoSimTQN_LOJAString14Código do lojaSimTQN_CNPJString14CNPJ do postoNãoTQN_DTABASDate08Data do abastecimentoSimTQN_HRABASString05Hora da abastecimentoSimTQN_TANQUEString02tanque do postoSimTQN_BOMBAString03bomba do postoSimTQN_QUANTNumeric09quantidade abastecidaSimTQN_VALUNINumeric09valor unitário do combustívelSimTQN_VALTOTNumeric15valor total do combustívelSimTQN_HODOMNumeric09Contador do equipamentoCondicionalTQN_POSCO2Numeric09Segundo Contador do equipamentoCondicionalTQN_CODMOTString06Código do motoristaCondicionalTQN_NOTFISString09Código da nota fiscalCondicionalTQN_CODVIAString06Código da viagemCondicionalTQN_ESCALAString08Código da escalaCondicional

Exemplo de um abastecimento padrão:

Bloco de código
languagejs
themeEclipse
titleRaw
{
   "TQN_PLACA":"MNT-1234",
   "TQN_FROTA":"VEI-S10",
   "TQN_CODCOM":"MNT",
   "TQN_POSTO":"MNTPOS",
   "TQN_LOJA":"01",
   "TQN_CNPJ":"34236121000159",
   "TQN_DTABAS":"20230220",
   "TQN_HRABAS":"12:10",
   "TQN_TANQUE":"01",
   "TQN_BOMBA":"01",
   "TQN_QUANT":5,
   "TQN_VALUNI":4,
   "TQN_VALTOT":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 "TQN_HODOM" preenchido, Exemplo: "TQN_HODOM": 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órioTQN_FROTAString16Código do VeículoSimTQN_DTABASString08Data do abastecimentoSimTQN_HRABASString05Hora da abastecimentoSim
Bloco de código
languagejs
themeEclipse
titleRaw
{
   "TQN_FROTA":"VEI-S10",
   "TQN_DTABAS":"20230320",
   "TQN_HRABAS":"12:10",
}
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órioTQN_FROTAString16Código do VeículoSimTQN_DTABASString08Data do abastecimentoSimTQN_HRABASString05Hora da abastecimentoSim Bloco de código
languagejs
themeEclipse
titleRaw
{ "TQN_FROTA":"VEI-S10",  "TQN_DTABAS":"20230320", "TQN_HRABAS":"12:10" }
Exemplo
tenantIdCódigo da empresa + Código da FilialSimT3,M RJ 01
x-erp-moduleRepresenta o módulo do ProtheusSim (A partir da lib 20211116)GFR
Nota
titleImportante
  • O valor inserido na variável tenantId não deverá possuir espaço entre a vírgula;
  • No exemplo apresentado na tabela acima, T3 corresponde a uma empresa e M RJ 01 a uma filial.
  • Na variável x-erp-module deve ser utilizado apenas a abreviação do módulo, conforme o exemplo, sem o prefixo "SIGA".


Campos que deverão ser adicionados no Header para possibilitar a inclusão de uma S.S..

VariávelDescriçãoObrigatórioExemplo
tenantIdCódigo da empresa + Código da FilialSimT3,M RJ 01
x-erp-moduleRepresenta o módulo do ProtheusSim (A partir da lib 20211116)MNT
Nota
titleImportante
  • O valor inserido na variável tenantId não deverá possuir espaço entre a vírgula;
  • No exemplo apresentado na tabela acima, T3 corresponde a uma empresa e M RJ 01 a uma filial.
  • Na variável x-erp-module deve ser utilizado apenas a abreviação do módulo, conforme o exemplo, sem o prefixo "SIGA".
Deck of Cards
startHiddenfalse
id0
effectTypefade
loopCardstrue

Informações adicionais: