Ao navegar neste site está a dar o seu acordo às Condições Gerais de Utilização

Plataforma de integração B2B

Brokers Integration

searchBatches

Este método permite aos parceiros de negócio pesquisar lotes com informação acerca de vários objetos de negócio (entidades, recibo, apólice, etc.)

searchBatches

Resumo

Nesta página poderá encontrar:

Descrição

Este método permite aos parceiros de negócio pesquisar lotes com informação acerca de vários objetos de negócio (entidades, recibo, apólice, etc.)

Esta operação suporta diversos critérios de pesquisa, como por exemplo: tipo de lote (entidades, carteira), intervalo temporal no qual o lote foi gerado pelos processos de data warehousing e indicação sobre se o lote já foi previamente enviado.

Esta operação retorna a lista de lotes com os respetivos identificadores, data de criação e o número total de objetos de negócio (linhas) que o lote contém, sendo que os dados efetivos dos ficheiros não são transmitidos por esta operação.

Elementos Cabeçalho (SOAP Header)

O seguinte elemento deve constar obrigatoriamente no cabeçalho da mensagem SOAP enviada pela solução do parceiro.

AxisValues

Data attributes or Name of Array	Mandatory/Optional	Field Type	Array Type	Notes/Service Specific Business Rules
Proxy	M	Int	No	‘0’ - Constante
User	M	String	No	Utilizador do serviço*
Solution	M	String	No	Identificação da solução consumidora do serviço*

* Estes elementos são convencionados no momento do acordo de serviço entre o parceiro e a Fidelidade.

Exemplo

<soap:Header>

<Solution xmlns="">solution</Solution>

</AxisValues>

</soap:Header>

Input Data

searchBatches

Data attributes or Name of Array	Mandatory/Optional	Field Type	Array Type	Notes/Service Specific Business Rules
fromDate	M	date	No	Dia inicial do período de pesquisa. Por questões de limitação da informação a retornar o período temporal de pesquisa não deve ser superior a 30 dias. fromDate deve corresponder a um momento anterior a toDate.
toDate	M	date	No	Dia final do período de pesquisa. Por questões de limitação da informação a retornar o período temporal de pesquisa não deve ser superior a 30 dias. toDate deve corresponder a um momento posterior a fromDate.
type	O	string	No	Tipo de objeto de negócio a que corresponde o lote a informação nele contido. Os valores possíveis são: · RECIBO · ENTIDADE · APOLICE_GERAL · APOLICE_VEICULO · PESSOA_SEGURA
delivered	O	string	No	Flag que indica se a pesquisa deve filtrar lotes previamente enviados ou não. Os valores possíveis são: · YES · NO

Output Data

searchBatchesResponse

Data attributes or Name of Array	Field Type	Array Type	Notes/Service Specific Business Rules
operationResult	Complex OperationResultType	No	Elemento que indica o sucesso da operação e os detalhes dos erros ocorridos em caso de falha. Verificar a estrutura deste elemento aqui.
batchList	Complex BatchListType	No	Em caso de retorno com sucesso (indicado no elemento operationResult), este elemento representa a lista de lotes encontrados no sistema para os critérios de pesquisa enviados. Verificar a estrutura deste elemento aqui.

BatchListType

Data attributes or Name of Array	Mandatory/Optional	Field Type	Array Type	Notes/Service Specific Business Rules
batch	M	Complex BatchType	0..*	Este elemento representa um lote encontrado face aos critérios de pesquisa indicados previamente. Esta estrutura apenas caracteriza o lote com os seus atributos sem incluir os dados efetivos do ficheiro. Verificar a estrutura deste elemento aqui.

BatchType

Data attributes or Name of Array	Mandatory/Optional	Field Type	Array Type	Notes/Service Specific Business Rules
batchId	M	long		Identificador do lote.
date	M	date		Data do lote.
type	M	string		Tipo de objeto de negócio a que corresponde o lote a informação nele contido. Os valores possíveis são: · RECIBO · ENTIDADE · APOLICE_GERAL · APOLICE_VEICULO · PESSOA_SEGURA
batchDataFormat	M	string		Indica o formato para o ficheiro de informação do lote. Os valores possíveis são CSV e XML. Porém neste momento apenas é suportado o formato CSV.
batchDataFormatVersion	M	string		Versão para as estruturas de informação contidas em cada ficheiro do lote. Facilita a evolução caso o formato de informação transmitido para os parceiros de negócio seja alterado.
totalRecords	M	int		Número total de objetos de negócio (entidades, recibos, apólices) que corresponde ao número de linhas que o lote contém.

SOAP Fault

Sempre que ocorrer uma falha inesperada no processamento do pedido (o sistema não conseguir tratar a falta e traduzi-la para a estrutura OperationResult), uma falha de autenticação/autorização ou uma falha de validação sintática será enviado ao cliente o detalhe do erro encapsulado numa SOAP Fault.

Fault

Data attributes or Name of Array	Mandatory/Optional	Field Type	Array Type	Notes/Service Specific Business Rules
faultcode	M	string		Código do erro que permite identificar a sua origem.
faultstring	M	string		Descrição curta do erro ocorrido
detail	O	Any Type		Detalhe do erro ocorrido.

Exemplo - Sucesso

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mul="urn:/microsoft/multichannelframework/" xmlns:v1="urn:fidelidade.com/ws/B2B/Integration/BrokerIntegration/V1">

<soapenv:Header>

<Solution xmlns="">Solution</Solution>

</AxisValues>

</soapenv:Header>

<soapenv:Body>

<v1:searchBatches>

<v1:fromDate>2016-03-24</v1:fromDate>

<v1:toDate>2016-03-25</v1:toDate>

<v1:type>RECIBO</v1:type>

<v1:delivered>YES</v1:delivered>

</v1:searchBatches>

</soapenv:Body>

</soapenv:Envelope>

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

   <soapenv:Header>

      <AxisValues xmlns="urn:/microsoft/multichannelframework/" xmlns:mul="urn:/microsoft/multichannelframework/" xmlns:v1="urn:fidelidade.com/ws/B2B/Integration/BrokerIntegration/V1">

         <User xmlns="">User</User>

         <Solution xmlns="">Solution</Solution>

         <Proxy xmlns="">0</Proxy>

      </AxisValues>

   </soapenv:Header>

   <Body xmlns="http://schemas.xmlsoap.org/soap/envelope/">

      <ns2:searchBatchesResponse xmlns:ns2="urn:fidelidade.com/ws/B2B/Integration/BrokerIntegration/V1">

         <ns3:operationResult xmlns:ns3="urn:fidelidade.com/schema/SharedResources/OperationResult/V1">

            <ns3:succeeded>true</ns3:succeeded>

         </ns3:operationResult>

         <ns2:batchList>

            <ns2:batch>

               <ns2:batchId>17730227</ns2:batchId>

               <ns2:date>2016-03-24</ns2:date>

               <ns2:type>RECIBO</ns2:type>

               <ns2:delivered>YES</ns2:delivered>

               <ns2:batchDataFormat>CSV</ns2:batchDataFormat>

               <ns2:batchDataFormatVersion>V0001</ns2:batchDataFormatVersion>

               <ns2:totalRecords>757</ns2:totalRecords>

            </ns2:batch>

            <ns2:batch>

               <ns2:batchId>17727030</ns2:batchId>

               <ns2:date>2016-03-24</ns2:date>

               <ns2:type>RECIBO</ns2:type>

               <ns2:delivered>YES</ns2:delivered>

               <ns2:batchDataFormat>CSV</ns2:batchDataFormat>

               <ns2:batchDataFormatVersion>V0001</ns2:batchDataFormatVersion>

               <ns2:totalRecords>106660</ns2:totalRecords>

         </ns2:batchList>

      </ns2:searchBatchesResponse>

   </Body>

</soapenv:Envelope>

Exemplo - Insucesso

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mul="urn:/microsoft/multichannelframework/" xmlns:v1="urn:fidelidade.com/ws/B2B/Integration/BrokerIntegration/V1">

   <soapenv:Header>

      <AxisValues xmlns="urn:/microsoft/multichannelframework/">

         <User xmlns="">User</User>

         <Solution xmlns="">Solution</Solution>

         <Proxy xmlns="">0</Proxy>

      </AxisValues>

   </soapenv:Header>

   <soapenv:Body>

      <v1:searchBatches>

         <v1:fromDate>2016-02-16</v1:fromDate>

         <v1:toDate>2016-04-05</v1:toDate>

         <v1:delivered>NO</v1:delivered>

      </v1:searchBatches>

   </soapenv:Body>

</soapenv:Envelope>

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

   <soapenv:Header xmlns:v1="urn:fidelidade.com/ws/B2B/Integration/BrokerIntegration/V1" xmlns:mul="urn:/microsoft/multichannelframework/">

      <AxisValues xmlns="urn:/microsoft/multichannelframework/">

         <User xmlns="">User</User>

         <Solution xmlns="">Solution</Solution>

         <Proxy xmlns="">0</Proxy>

      </AxisValues>

   </soapenv:Header>

   <soapenv:Body xmlns:v1="urn:fidelidade.com/ws/B2B/Integration/BrokerIntegration/V1" xmlns:mul="urn:/microsoft/multichannelframework/">

      <v1:searchBatchesResponse>

         <v2:operationResult xmlns:v2="urn:fidelidade.com/schema/SharedResources/OperationResult/V1">

            <v2:succeeded>false</v2:succeeded>

            <v2:error>

               <v2:code>LSF#002</v2:code>

               <v2:message>Invalid Input Data</v2:message>

               <v2:detail>Time frame between 'fromDate' and 'toDate' cannot be greater than 31 days.</v2:detail>

            </v2:error>

         </v2:operationResult>

      </v1:searchBatchesResponse>

   </soapenv:Body>

</soapenv:Envelope>

Exemplo - SOAP Fault Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<soapenv:Fault>

<faultcode>soapenv:Client</faultcode>

<faultstring>Not Authorized</faultstring>

<detail>Could Not Authenticate User Based On WSS Header</detail>

</soapenv:Fault>

</soapenv:Body>

</soapenv:Envelope>

217 948 800 Dias úteis das 9h00 as 20h

Brokers Integration

Este método permite aos parceiros de negócio pesquisar lotes com informação acerca de vários objetos de negócio (entidades, recibo, apólice, etc.) ​

searchBatches

Este método permite aos parceiros de negócio pesquisar lotes com informação acerca de vários objetos de negócio (entidades, recibo, apólice, etc.)