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

Brokers Integration

getBatches

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

getBatches

Resumo

 
Descrição​
Este método permite aos parceiros de negócio obter os dados dos lotes com informação acerca de vários objetos de negócio (entidades, recibo, apólice, etc.).
 
Esta operação recebe uma lista de ID de lotes e retorna os dados efetivos dos respetivos ficheiros. Depois do download de cada lote pelos parceiros de negócio o sistema mantém um registo acerca de quais os lotes já transmitidos.
 
Neste momento o ficheiro de cada lote tem o formato de um CSV, com o caracter ‘;’ como separador dos vários campos de informaçã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>
   <AxisValues xmlns="urn:/microsoft/multichannelframework/">
      <Proxy xmlns="">0</Proxy>
      <User xmlns="">user</User>
      <Solution xmlns="">solution</Solution> 
    </AxisValues>
</soap:Header>
 
 
 
Input Data
 
  • getBatches
Data attributes or Name of Array
Mandatory/Optional
Field Type
Array Type
Notes/Service Specific Business Rules
batchIdList
M
Complex
 
BatchIdListType
No
Elemento com a lista dos identificadores de lotes a retornar.
 
Verificar a estrutura deste elemento aqui. 
 
  • BatchIdListType
Data attributes or Name of Array
Mandatory/Optional
Field Type
Array Type
Notes/Service Specific Business Rules
batchId
M
long
Yes
 
1..*
Identificador de um lote cuja informação deve ser enviada na resposta.
 
Por uma questão de dimensionamento da informação agregada e enviada em cada pedido o sistema limita o número de lotes a no máximo 20 de cada vez.
 
 
 
Output Data
 
  • getBatchesResponse
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.
batchDataList
Complex
 
BatchDataListType
No
Em caso de retorno com sucesso (indicado no elemento operationResult), este elemento agrega a lista de lotes enviados.
 
Verificar a estrutura deste elemento aqui.
 
  • BatchDataListType
Data attributes or Name of Array
Mandatory/Optional
Field Type
Array Type
Notes/Service Specific Business Rules
batchData
O
Complex
 
BatchDataType
Yes
 
0..*
Elemento que representa o lote solicitado no pedido com os dados referentes ao ficheiro de informação.
 
Verificar a estrutura deste elemento aqui.
 
  • BatchDataType
Data attributes or Name of Array
Mandatory/Optional
Field Type
Array Type
Notes/Service Specific Business Rules
batchId
M
long
No
Identificador do lote.
 
batchData
M
Base64Binary
No
Dados do lote.
 
Nota: Este elemento é transformado por MTOM/XOP, pelo que o seu conteúdo deve ser obtido no attachment identificado pelo ‘href’ do elemento ‘xop:Include’
 
 
 
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>
      <AxisValues xmlns="urn:/microsoft/multichannelframework/">
         <User xmlns="">User</User>
         <Solution xmlns="">Solution</Solution>
         <Proxy xmlns="">0</Proxy>
      </AxisValues>
   </soapenv:Header>
   <soapenv:Body>
      <v1:getBatches>
         <v1:batchIdList>
            <v1:batchId>17727028</v1:batchId>
         </v1:batchIdList>
      </v1:getBatches>
   </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>
   <soap-env:Body xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
      <tns:getBatchesResponse xmlns:tns="urn:fidelidade.com/ws/B2B/Integration/BrokerIntegration/V1" xmlns:bind="urn:fidelidade.com/ws/B2B/Integration/BrokerIntegration/V1">
         <v1:operationResult xmlns:v1="urn:fidelidade.com/schema/SharedResources/OperationResult/V1">
            <v1:succeeded>true</v1:succeeded>
         </v1:operationResult>
         <bind:batchDataList>
            <bind:batchData>
               <bind:batchId>17727028</bind:batchId>
               <bind:batchData>
                  <xop:Include href="cid:9ac7e036-9d17-4abc-adbd-0acb9147b527" xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
               </bind:batchData>
            </bind:batchData>
         </bind:batchDataList>
      </tns:getBatchesResponse>
   </soap-env:Body>
</soapenv:Envelope>
 
Nota: O elemento ‘batchData’ é transformado por MTOM/XOP, pelo que o seu conteúdo deve ser obtido no attachment identificado pelo ‘href’ do elemento ‘xop:Include’
 
 
 
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:getBatches>
         <v1:batchIdList>
            <v1:batchId>0000001</v1:batchId>
            <v1:batchId>0000002</v1:batchId>
            <v1:batchId>0000003</v1:batchId>
            <v1:batchId>0000004</v1:batchId>
            <v1:batchId>0000005</v1:batchId>
            <v1:batchId>0000006</v1:batchId>
            <v1:batchId>0000007</v1:batchId>
            <v1:batchId>0000008</v1:batchId>
            <v1:batchId>0000009</v1:batchId>
            <v1:batchId>0000010</v1:batchId>
            <v1:batchId>0000011</v1:batchId>
            <v1:batchId>0000012</v1:batchId>
            <v1:batchId>0000013</v1:batchId>
            <v1:batchId>0000014</v1:batchId>
            <v1:batchId>0000015</v1:batchId>
            <v1:batchId>0000016</v1:batchId>
            <v1:batchId>0000017</v1:batchId>
            <v1:batchId>0000018</v1:batchId>
            <v1:batchId>0000019</v1:batchId>
            <v1:batchId>0000020</v1:batchId>
            <v1:batchId>0000021</v1:batchId>
         </v1:batchIdList>
      </v1:getBatches>
   </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:getBatchesResponse>
         <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>Each request must not specify mor than 20 batches</v2:detail>
            </v2:error>
         </v2:operationResult>
      </v1:getBatchesResponse>
   </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>