• type – Determina o agrupamento do retorno que pode ser por status (Status do registro no TAF) ou registryType (TAFTPREG), o agrupamento depende dos parâmetros enviados no request, quando o status é informado e o registryType omitido, o retorno será por status, caso contrário por registryType.
• code – Código do registro indicado no atributo type.
• items – Itens do response.
• registryKey – código do TAFKEY. Essa informação sempre será retornada, para que a aplicação de origem consiga identificar o registro em sua própria base de dados
• type – Determina o agrupamento do retorno que pode ser por status (Status do registro no TAF) ou registryType (TAFTPREG), o agrupamento depende dos parâmetros enviados no request, quando o status é informado e o registryType omitido, o retorno será por status, caso contrário por registryType.
• code – Código do registro indicado no atributo type.
• items – Itens do response.
• registryKey – código do TAFKEY. Essa informação sempre será retornada, para que a aplicação de origem consiga identificar o registro em sua própria base de dados.
• statusCode – Status do registro no TAF, atributo exibido somente quando o agrupamento do request for por registryType.
• statusDescription – Descrição do status no TAF, atributo exibido somente quando o agrupamento do request for por registryType.
• registryType – Tipo do registro (conforme campo TAFTPREG), atributo exibido somente quando o agrupamento do request for por status.
• registryTypeDescription – Descrição do tipo do registro (conforme campo TAFTPREG), atributo exibido somente quando o agrupamento do request for por status.
• validateErrors – Agrupa todos os erros de layout identificado pelo processo de validação do TAF. Os erros são listados por validateErrorCode e validateErrorDetail.
• validateErrorCode – Código do erro identificado pelo processo de validação do TAF.
• validateErrorDetail – Descrição do erro identificado pelo processo de validação do TAF.
• streamingErrors – Agrupa todos os erros de transmissão retornados do Governo para o TAF. Os erros são listados por streamingErrorCode e streamingErrorDetail.
• streamingErrorCode – Código do erro retornado pelo Governo para o TAF, após transmissão do registro.
• streamingErrorDetail – Descrição do erro retornado pelo Governo para o TAF, após transmissão do registro.
• registryProtocol – Recibo retornado do Governo para o TAF após a transmissão do registro ter sido realizada com sucesso.
• lastRecNo - Numero do RecNo do ultimo registro retornado na requisição.
• maxRecNo - Informa o numero do RecNo do ultimo registro relacionado a consulta, deve ser utilizado juntamente com o lastRecNo para controlar a paginação e garantir o retorno de todos os registros.
  
  

Exemplos de requisição utilizando o método GET:

• Consulta por status:

Request:

http://172.16.31.214:8085/rest/wsqueryelements2?status=4&startRecNo=0

{
  "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
}

• Consulta pelo status + registryType:

Request:

http://172.16.31.214:8085/rest/wsqueryelements2?status=4&registryType=S-2200&startRecNo=0

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

Controle de Paginação:

Quando o retorno de uma requisição ultrapassa o valor de 850 Kb a mensagem de resposta é "quebrada" e retornada com o conteúdo até então incrementado, exemplo:

{
  "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
}

No exemplo acima a consulta retornou até o registro 150, sendo que o registro com maior RecNo pertencente a consulta é o 322, isso não quer dizer que foram retornados 150 registros e que faltam 172, o RecNo apenas informa a sequencia do registro no response porém o lastRecNo menor que o maxRecNo indica que ainda existem registro a serem retornados para a chave requisitada. Para o retorno dos demais registros deve-se realizar uma nova requisição com o startRecNo igual a lastRecNo + 1, este procedimento deve ser adotado  até que o lastRecNo seja igual ao maxRecNo conforme exemplo abaixo:

Request:

http://172.16.31.214:8085/rest/wsqueryelements2?status=4&registryType=S-2200&startRecNo=151

{
  "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
}