Árvore de páginas

Versões comparadas

Chave

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

CONTEÚDO

  1. Visão Geral
  2. Definições de Serviços
    1. POST - JurRESTFun/wo-ts
    2. POST - JurRESTFun/wo-can
  3. Assuntos Relacionados

01. VISÃO GERAL

Os serviços especificados neste documento tem por objetivo:

  • wo-ts  - Permitir ao usuário realizar o WO dos Time Sheets em lote.
  • wo-can - Permitir ao usuário realizar o cancelamento do WO em lote.

02. DEFINIÇÕES DE SERVIÇOS

 a. POST - JurRESTFun/wo-ts

Permitir ao usuário realizar o WO dos Time Sheets em lote.

Para enviar os Time Sheets para o WO, envie um arquivo em JSON ou XML com os dados abaixo (todos os campos são obrigatórios):

  • PARAMETROS - Agrupador do XML (Utilizado apenas em arquivos em XML).
  • aCodTs            - Agrupador dos Códigos de Time Sheet.
  • cCodTs            - Código do Time Sheet (Utilizado apenas em arquivos em XML).
  • cCodMotv       - Código de Motivo de WO.
  • cCodPart         - Código do Participante que efetuou o WO.
  • cMsgWo          - Observação do WO.

...

idXML
Bloco de código
languagejava
themeMidnight
titleRequest Header XML
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/XML
Bloco de código
languagejava
themeMidnight
titleRequest Body XML
collapsetrue
<?xml version='1.0'?>
          <PARAMETROS>
                   <aCodTs>
                           <cCodTs>000000000082</cCodTs>
                           <cCodTs>000000000083</cCodTs>
                           <cCodTs>000000000084</cCodTs>
                   </aCodTs>
                   <cCodMotv>001</cCodMotv>
                   <cCodPart>000010</cCodPart>
                   <cMsgWo>Teste Mensagem de WO</cMsgWo>
          </PARAMETROS>

...

languagejava
themeMidnight
titleResponse XML
collapsetrue

...

<?xml version='1.0' encoding='UTF-8'?>

...

Deck of Cards
idJson
Bloco de código
languagejava
themeMidnight
titleRequest Header Json
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/Json
Bloco de código
languagejava
themeMidnight
titleRequest Body Json
collapsetrue
{
      "aCodTs": ["000000000082","000000000083","000000000084"],
      "cCodMotv":"001",
      "cCodPart":"000010",
      "cMsgWo":"Teste Mensagem de WO"
}
Bloco de código
languagejava
themeMidnight
titleResponse Json
collapsetrue
{
"totvs_total": 3,
"hasNext": false,
"return": [
{
"codigoTS": "000000000082",
"codigoWO": "",
"obs": "Time Sheet já Concluído."
},
{
"codigoTS": "000000000083",
"codigoWO": "00000130",
"obs": ""
},
{
"codigoTS": "000000000084",
"codigoWO": "00000130",
"obs": ""
}
]
}

b. POST - JurRESTFun/wo-can

Permitir ao usuário realizar o cancelamento do WO em lote.

Para enviar os WOs para cancelamento, envie um arquivo em JSON ou XML com os dados abaixo (todos os campos são obrigatórios):

  • PARAMETROS - Agrupador do XML (Utilizado apenas em arquivos em XML).
  • acodigoWO    - Agrupador de Códigos do WO.
  • ccodigoWO    - Código do WO (Utilizado apenas em arquivos em XML).
  • cCodMotv      - Código de Motivo de cancelamento WO.
  • cCodPart        - Código do Participante que efetuou o cancelamento de WO.
  • cMsgWo         - Observação do cancelamento de WO.

Caso ocorram problemas com os dados enviados, serão retornadas as seguintes mensagens com o códigos de erros:

No campo "errorMessage" no código de resposta http 400

01 - A observação do WO 'cMsgWo' é um campo obrigatório!
02 - O código de participante 'cCodPart' está inválido!
03 - O código do motivo de WO 'cCodMotv' está inválido!
04 - É obrigatório informar ao menos um WO! 'acodigoWO'/'ccodigoWO'!

...


<totvs_total>2</totvs_total>
<hasNext>false</hasNext>
<result>
    <return>
        <codigoTS>000000000776</codigoTS>
        <codigoWO></codigoWO>
        <Obs>Time Sheet já Concluído.</Obs>
    </return>
    <codigoTS>000000000777</codigoTS>
    <codigoWO></codigoWO>
    <Obs>Time Sheet já Concluído.</Obs>
</return>
</result>

...

05 - WO não localizado
06 - WO já cancelado
07 - Problema para cancelar WO

Deck of Cards
idXML
Bloco de código
languagejava
themeMidnight
titleRequest Header XML
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/XML
Bloco de código
languagejava
themeMidnight
titleRequest Body XML
collapsetrue
<?xml version='1.0'?>
          <PARAMETROS>
                   <aCodigoWO>
                           <ccodigoWO>00000129</ccodigoWO>
                           <ccodigoWO>00000130</ccodigoWO>
                           <ccodigoWO>00000131</ccodigoWO>
                   </aCodigoWO>
                   <cCodMotv>002</cCodMotv>
                   <cCodPart>000010</cCodPart>
                   <cMsgWo>Teste Mensagem de cancelamento de WO</cMsgWo>
          </PARAMETROS>
Bloco de código
languagejava
themeMidnight
titleResponse XML
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
   <totvs_total>3</totvs_total>
   <hasNext>false</hasNext>
   <result>
      <return>
         <codigoWO>00000129</codigoWO>
         <situac></situac>
         <obs>WO já cancelado.</obs>
		 <codErr>06</codErr>
      </return>
      <return>
         <codigoWO>00000130</codigoWO>
         <situac>2</situac>
         <obs></obs>
		  <codErr></codErr>	
      </return>
      <return>
         <codigoWO>00000131</codigoWO>
         <situac></situac>
         <obs>WO nao localizado.</obs>
         <codErr>05</codErr>
      </return>
   </result>
Deck of Cards
idJson
Bloco de código
languagejava
themeMidnight
titleRequest Header Json
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/Json
Bloco de código
languagejava
themeMidnight
titleRequest Body Json
collapsetrue
{
      "acodigoWO": ["00000129","00000130","00000131"],
      "cCodMotv":"002",
      "cCodPart":"000010",
      "cMsgWo":"Teste Mensagem de cancelamento de WO"
}
Bloco de código
languagejava
themeMidnight
titleResponse Json
collapsetrue
{
"totvs_total": 3,
"hasNext": false,
"return": [
{
"codigoWO": "00000129",
"situac":"",
"obs": "WO já cancelado.",
 "codErr":"06"
},
{
"codigoWO": "00000130",
"situac":"2",
"obs": "",
"codErr":""
},
{
"codigoWO": "00000131",
"situac":"",
"obs": "WO nao localizado.",
"codErr":"05"
}
]
}

03. ASSUNTOS RELACIONADOS

...