Definição do Serviço

Nome: WSGetXML

Objetivo: Requisitar ao TOTVS Automação Fiscal o retorno do XML de determinado registro ou lote de registros.

Descrição: O serviço permite que uma aplicação requisite ao TAF que retorne um ou mais dados dentro de uma estrutura XML, a mesma que foi (ou que será) enviada ao Governo. Caso o evento ainda não tenha sido transmitido ao Governo, será retornado o XML gerado pelo próprio TAF. Caso o evento já tenha sido transmitido e autorizado pelo Governo, será retornado o XML final (inclusive com a assinatura do TSS).

Métodos: GET

Configurações do Serviço

A  Configuração do serviço REST está documentada  no link Configuração REST SERVER - Protheus.

[HTTPURI]
URL=/rest
PrepareIn=99,01
Instances=1,1 

[HTTPURI]
URL=/rest
PrepareIn=T1,D MG 01
Instances=1,1 

[HTTPURI]
URL=/rest
PrepareIn=All
Instances=1,1 

Definição dos métodos

GET

Descrição do Método: O método GET retorna o XML que o TAF enviou, ou enviará, ao Governo para determinado registro. Caso o evento ainda não tenha sido transmitido ao Governo, será retornado o XML gerado pelo próprio TAF. Caso o evento já tenha sido transmitido e autorizado pelo Governo, será retornado o XML final (inclusive com a assinatura do TSS).

A Consulta pode combinar parâmetros utilizando a sintaxe “Query String” conforme exemplo abaixo:

http://172.16.31.214:8085/rest/wstafst2?ticketCode=F95975312365478978936365524145236352&RegistryKey=KEYQWE7878RE4854545454998598571&startRecNo=0

• ticketCode – Código do TAFTICKET, Obrigatório caso registryKey não seja informado.
• registryKey – Código do TAFKEY, Obrigatório caso ticketCode não seja informado.
• startRecNo - Numero do RecNo Inicial a ser considerado na consulta. 
  Observação : O Tamanho máximo do Response é 850 kB, quando a mensagem chega neste valor é realizado um retorno contendo os registros que já foram incrementados na resposta. O Controle dos itens restantes é feito através do lastRecNo que informa o RecNo do ultimo registro que fez parte da mensagem anterior (respeitando a chave),  caso o mesmo seja diferente de maxRecNo é por que existem itens a serem retornados, caso o contrario a consulta está completa.

Estrutura da Resposta do método GET (Response):

{
  "type": "status",
  "code": "4",
  "items": [
    {
      "registryKey": "KEY000001S-220020170101",
      "registryType": "S-2200",
      "registryTypeDescription": "Admissão do Funcionário",
      "registryProtocol": "20170520081000S2200"
    },
    {
      "registryKey": "KEY000001S-210020170101",
      "registryType": "S-2100",
      "registryTypeDescription": "Cadastro Inicial do Funcionário",
      "registryProtocol": "20170521151402S2100"
    }
 ],
  "lastRecNo": 2,
  "maxRecNo": 2
}

{
  "type": "registryType",
  "code": "S-2200",
  "items": [
    {
      "registryKey": "KEY000001S-220020170101",
      "statusCode": "4",
      "statusDescription": "Registro Transmitido com sucesso",
      "registryProtocol": "20170520081000S2200"
    },
    {
      "registryKey": "KEY004301S-220020170823",
      "statusCode": "1",
      "statusDescription": "Registro não Transmitido - Inválido",
      "validateErros": [
			{ 
		  	 "validateErrorCode": "000267",
		  	 "validateErrorDetail": "A data de admissão do trabalhador João da Silva, para a categoria [103] (aprendiz), deve ser maior ou igual a [20/12/2000]"
			}
			{ 
			   "validateErrorCode": "000335",
			   "validateErrorDetail": "A data de admissão deve ser anterior a data de início do e-Social."
			}
		]
    } 
 ],
  "lastRecNo": 232,
  "maxRecNo": 232
}

{
  "type": "status",
  "code": "4",
  "items": [
    {
      "registryKey": "KEY000001S-220020170101",
      "registryType": "S-2200",
      "registryTypeDescription": "Admissão do Funcionário",
      "registryProtocol": "20170520081000S2200"
    }
 ],
  "lastRecNo": 2,
  "maxRecNo": 2
}

{
  "type": "status",
  "code": "4",
  "items": [
    {
      "registryKey": "KEY000001S-220020170101",
      "registryType": "S-2200",
      "registryTypeDescription": "Admissão do Funcionário",
      "registryProtocol": "20170520081000S2200"
    },
*
*
*
{several items}
*
*
*
    {
      "registryKey": "KEY000001S-210020170101",
      "registryType": "S-2100",
      "registryTypeDescription": "Cadastro Inicial do Funcionário",
      "registryProtocol": "20170521151402S2100"
    }
  ],
  "lastRecNo": 150,
  "maxRecNo": 322
}

{
  "type": "status",
  "code": "4",
  "items": [
    {
      "registryKey": "KEY895424S-220020170723",
      "registryType": "S-2200",
      "registryTypeDescription": "Admissão do Funcionário",
      "registryProtocol": "20170723081032S2200"
    },
*
*
*
{several items}
*
*
*
    {
      "registryKey": "KEY072355S-210020170312",
      "registryType": "S-2100",
      "registryTypeDescription": "Cadastro Inicial do Funcionário",
      "registryProtocol": "20170312151402S2100"
    }
  ],
  "lastRecNo": 322,
  "maxRecNo": 322
}

Exemplo de Consumo do Serviço

#Include 'Protheus.ch'
Function WSCTAFST2(cMetodo)
	Local oRestClient := FWRest():New("http://172.16.31.214:8085")
	Local oObj   	:= Nil
	Local lContinue := .T.
	Local nPag		:= 0
	Local nRec		:= 0
	
	If cMetodo == "GET"
	
		While lContinue
			nPag++
			oRestClient:setPath("/rest/wsqueryelements?status=4&startRecNo=" + AllTrim(Str(nRec)))
			If oRestClient:Get(aHeader)
				ConOut("Pag: " + AllTrim(Str(nPag)))
			   	ConOut("GET", oRestClient:GetResult())
			  	
				If FWJsonDeserialize(oRestClient:GetResult(),@oObj)
			   		If oObj:lastRecNo == oObj:maxRecNo
			   			lContinue := .F.
			   		Else
			   			nRec := oObj:lastRecNo+1
			   		EndIf
			   	EndIf
			   	oObj := Nil
			Else
			   ConOut("GET", oRestClient:GetLastError())
			   lContinue := .F.
			EndIf
		End
		ConOut("------FIM------")
	EndIf
	
	FreeObj(oRestClient)
Return 

  "errorCode": 101,
  "errorMessage": "obrigatorio o envio do parametro status ou registryType"
}

Códigos De Erros De Validação:

• 800 – Status (status) solicitado no request é inválido.
• 801 – Tipo de registro (registryType) solicitado no request é inválido.