API JurRestFUN - Funções do SIGAPFS

CONTEÚDO

Visão Geral
Definições de Serviços
1. POST - JurRESTFun/wo-ts
2. POST - JurRESTFun/wo-can
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.

Request Header Json

LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/xml

Request Body xml

<PARAMETROS>
    <aCodTs>
         <cCodTs>000000000166</cCodTs>
         <cCodTs>000000000027</cCodTs>
         <cCodTs>000000000569</cCodTs>
    </aCodTs>
    <cCodMotv>001</cCodMotv>
    <cCodPart>002215</cCodPart>
    <cMsgWo>teste 123</cMsgWo>
</PARAMETROS>

Response XML

<?xml version='1.0' encoding='UTF-8'?>
<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>

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

Request Header Json

LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/Json

Request Body Json

{
  "aCodTs": ["000000000166", "000000000167", "000000000168"],
  "cCodMotv": "001",
  "cCodPart": "002215",
  "cMsgWo": "Simulacao de Mensagem do WO"
}

Response Json

{
  "wo-ts": [
    {
      "timeSheets": [
        {
          "message": "",
          "codTs": "000000000027"
        },
        {
          "message": "",
          "codTs": "000000000166"
        }
      ],
      "codWo": "00000102"
    },
    {
      "timeSheets": [
        {
          "message": "",
          "codTs": "000000000569"
        }
      ],
      "codWo": "00000103"
    }
  ]
}

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

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

Request Header XML

LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/XML

Request Body XML

<?xml version='1.0'?> 
<parametros>
    <acodigoWO>
        <ccodigoWO>00000104</ccodigoWO>
        <ccodigoWO>00000105</ccodigoWO>
    </acodigoWO>
    <cCodMotv>002</cCodMotv>
    <cCodPart>002986</cCodPart>
    <cMsgWo>WO Cancelado via automacao com XML</cMsgWo>
</parametros>

Response XML

<?xml version='1.0' encoding='UTF-8'?>
<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>

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

Request Header Json

LEGALDESK: TRUE
TENANTID: T1,M SP 01
Content-Type: application/Json

Request Body Json

{
  "acodigoWO": ["00000102", "00000103"],
  "cCodMotv": "002",
  "cCodPart": "002215",
  "cMsgWo": "Cancelamento WO via automação com JSON"
}

Response Json

{
  "wo-can": [
    {
      "codErr": "",
      "situac": "2",
      "Obs": "",
      "codWo": "00000102"
    },
    {
      "codErr": "",
      "situac": "2",
      "Obs": "",
      "codWo": "00000103"
    }
  ]
}

03. ASSUNTOS RELACIONADOS

Árvore de páginas

API JurRestFUN - Funções do SIGAPFS

CONTEÚDO

01. VISÃO GERAL

02. DEFINIÇÕES DE SERVIÇOS

a. POST - JurRESTFun/wo-ts

b. POST - JurRESTFun/wo-can

03. ASSUNTOS RELACIONADOS