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

...

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


Json
Deck of Cards
idXML
XMLjava XMLjava
Card
idxml
labelXML
Bloco de código
languagejava
themeMidnight
titleRequest Header
Json
collapsetrue
LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/
XML
xml
Bloco de código
language
xml
themeMidnight
titleRequest Body
xml
collapsetrue
<?xml version='1.0'?>
<PARAMETROS>
    
<aCodTs>
         
<cCodTs>000000000082<
<cCodTs>000000000166</cCodTs>
         
<cCodTs>000000000083<
<cCodTs>000000000027</cCodTs>
         
<cCodTs>000000000084<
<cCodTs>000000000569</cCodTs>
    
</aCodTs>
    
<cCodMotv>001</cCodMotv>
    
<cCodPart>000010<
<cCodPart>002215</cCodPart>
    
<cMsgWo>Teste Mensagem de WO</cMsgWo>
<cMsgWo>teste 123</cMsgWo>
</PARAMETROS>
Bloco de código
language
xml
themeMidnight
titleResponse XML
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
   <totvs_total>3</totvs_total>    <hasNext>true</hasNext>    <result>       <return>       <codigoTS>000000000082</codigoTS>       <codigoWO></codigoWO>       <obs>Time Sheet já Concluído.</obs>     </return>     <return>       <codigoTS>000000000083</codigoTS>       <codigoWO>00000130</codigoWO>       <obs></obs>     </return>     <return>       <codigoTS>000000000084</codigoTS>       <codigoWO>00000130</codigoWO>       <obs></obs>     </return> </result>
Deck of Cards

<wo-ts>
	<wo>
		<codigoWO>00000100</codigoWO>
		<timeSheet>
			<codigoTS>000000000027</codigoTS>
			<message>
			</message>
		</timeSheet>
		<timeSheet>
			<codigoTS>000000000166</codigoTS>
			<message>
			</message>
		</timeSheet>
	</wo>
	<wo>
		<codigoWO>00000101</codigoWO>
		<timeSheet>
			<codigoTS>000000000569</codigoTS>
			<message>
			</message>
		</timeSheet>
	</wo>
</wo-ts> 
Card
idjson
labelJSON
Aviso

Para correto funcionamento do serviço rest, é necessário que as informações estejam no encoding UTF-8

id

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
000000000166", "
000000000083
000000000167", "
000000000084
000000000168"],
  "cCodMotv": "001",
  "cCodPart": "
000010
002215",
  "cMsgWo": "
Teste
Simulacao de Mensagem 
de
do WO"
}

Bloco de código
languagejava
themeMidnight
titleResponse Json
collapsetrue
{
"totvs_total
  "wo-ts": 
3, "hasNext": true, "return
[
    {
      "timeSheets": [
        {
"codigoTS
          "message": "
000000000082
",
"codigoWO
          "codTs": "000000000027"
, "obs": "Time Sheet já Concluído." }, { "codigoTS

        },
        {
          "message": "
000000000083
",
"codigoWO
          "codTs": "
00000130", "obs
000000000166"
        }
      ],
      "codWo": "00000102"
    },
    {
"codigoTS
      "timeSheets": [
        {
          "message": "
000000000084
",
"codigoWO
          "codTs": "
00000130", "obs
000000000569"
        }
      ],
      "codWo": "00000103"
    }
  ]
}



b. POST - JurRESTFun/wo-can

...

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

...

  • 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'!


Na tag codErr  quando a requisição retornar código http 201 (Created)

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


Json
Deck of Cards
idXML
javajava
Card
idxml
labelXML
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
language
xml
themeMidnight
titleRequest Body XML
collapsetrue
<?xml version='1.0'?>
<PARAMETROS>
 
<parametros>
    <acodigoWO>
        
<codigoWO>00000129</codigoWO>
<ccodigoWO>00000104</ccodigoWO>
        
<codigoWO>00000130</codigoWO> <codigoWO>00000131</codigoWO>
<ccodigoWO>00000105</ccodigoWO>
    
</acodigoWO>
    
<cCodMotv>002</cCodMotv>
    
<cCodPart>000010<
<cCodPart>002986</cCodPart>
    <cMsgWo>WO Cancelado via automacao 
<cMsgWo>Teste Mensagem de cancelamento de WO</cMsgWo> </PARAMETROS>
com XML</cMsgWo>
</parametros>
Bloco de código
language
xml
themeMidnight
titleResponse XML
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
   <totvs_total>3</totvs_total>    <hasNext>true</hasNext>    <result>     <return>       <codigoWO>00000129</codigoWO>       <situac></situac>       <obs>WO já cancelado.</obs>     </return>     <return>       <codigoWO>00000130</codigoWO>       <situac>2</situac>       <obs></obs>   </return> <return>       <codigoWO>00000131</codigoWO>       <situac></situac>       <obs>WO nao localizado.</obs> </return> </result>
Deck of Cards

<wo-can>
	<wo>
		<codigoWO>00000104</codigoWO>
		<situac>2</situac>
		<Obs>
		</Obs>
		<codErr>
		</codErr>
	</wo>
	<wo>
		<codigoWO>00000105</codigoWO>
		<situac>2</situac>
		<Obs>
		</Obs>
		<codErr>
		</codErr>
	</wo>
</wo-can> 
Card
idjson
labelJSON
Aviso

Para correto funcionamento do serviço rest, é necessário que as informações estejam no encoding UTF-8

id

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
00000102", "
00000130","00000131
00000103"],
  
"cCodMotv": "002",
  "cCodPart": "
000010
002215",
  
"cMsgWo": "
Teste
Cancelamento 
Mensagem
WO 
de
via 
cancelamento
automação 
de
com 
WO
JSON"
}
Bloco de código
languagejava
themeMidnight
titleResponse Json
collapsetrue
{
"totvs_total":
 
3, "hasNext":
 
true, "return
"wo-can": [
    {
"codigoWO
      "codErr": "
00000129
",
      "situac": "2",
"obs
      "Obs": "
WO já cancelado." }, { "codigoWO
",
      "codWo": "00000102"
    },
    {
      "codErr": "
00000130
",
      "situac": "2",
"obs
      "Obs": ""
}
,
{ "codigoWO
      "codWo": "
00000131
00000103"
, "situac":"", "obs": "WO nao localizado." }

    }
  ]
}


03.

...

ASSUNTOS RELACIONADOS

...