Manual de Webservices - Livro de Reclamações

Índice
Versões.................................................................................................................................................... 4
1 Introdução....................................................................................................................................... 5
2 Autenticação ................................................................................................................................... 5
3 Ambientes ....................................................................................................................................... 5
4 Instruções para novas integrações em ambiente de testes ........................................................... 7
5 Webservices .................................................................................................................................... 8
5.1 Reclamações ........................................................................................................................... 8
5.2 Setores de Atividade ............................................................................................................. 68
5.3 Operadores Económicos e Lojas ........................................................................................... 73
04/05/2023 1
5.4 Motivos ................................................................................................................................. 91
5.5 Valores de Motivo ................................................................................................................. 96
5.6 Utilizadores ......................................................................................................................... 101
5.7 Entidades Reguladoras........................................................................................................ 110
5.8 Estados de Reclamação ....................................................................................................... 112
5.9 Pedido de Informação ......................................................................................................... 115
5.10 Elogio e Sugestão ................................................................................................................ 130
6 Diagrama de invocação de serviços ............................................................................................ 138

6.1 Reclamações ....................................................................................................................... 138
6.2 Setores de Atividade ........................................................................................................... 139
6.3 Operadores Económicos e Lojas ......................................................................................... 139
6.4 Motivos ............................................................................................................................... 139
6.5 Valores de Motivo ............................................................................................................... 139
04/05/2023 2
6.6 Utilizadores ......................................................................................................................... 139
6.7 Entidades Reguladoras........................................................................................................ 139
6.8 Estados de Reclamação ....................................................................................................... 139
6.9 Pedidos de Informação ....................................................................................................... 139
6.10 Elogios e Sugestões ............................................................................................................. 140
7 Mensagens .................................................................................................................................. 141
04/05/2023 3
Versões
Número Data de Alteração
alteração
1 21/02/2022 Primeira versão de documento
2 24/02/2022 Alteração de serviços REST listados:
• Complaint/findByIdentificationNumbers
o Lista de texto alterada para lista de estrutura de
números de identificação de reclamações;
• Complaint/findByIdentificationNumbers
• Complaint/findComplaintsBetweenDates
• Complaint/findFullDataByIdentificationNumbers
• Complaint/findIdentificationNumbersByDate
• ComplimentSuggestion/findComplimentsBetweenDates
números de identificação de elogios/sugestões;
o Alterado nome para
FindComplimentsSuggestionsBetweenDates;
• ComplimentSuggestion/GetFullDataFromRequesrNrs
números de identificação de elogios/sugestões;
o Alterado nome para
GetFullDataFromRequestNumbers;
• InformationRequest/findByIdentificationNumbers
números de identificação de pedidos de
informação;
• InformationRequest/findFullDataByIdentificationNumbers
informação;
• InformationRequest/findIdentificationNumbersByDate
informação;
2.1 29/03/2022 Alteração de endereço de ambiente de testes (para SOAP)
3 11/04/2022 • Reorganização de secção de Ambientes para conter
informação mais atualizada de endpoints de serviços
• Adicionada secção de instruções para novas integrações
• Alteradas instruções de todos os serviços para conterem
referências de como obter campos de id
3.1 14/07/2022 Alterada secção de instruções para novas integrações
04/05/2023 4
3.2 18/07/2022 Correção de endpoint de Motivos (estava com ref. Errada) e
alteração de serviço REST ListActivitySectors (campo “nipc” passou
a ser passado em URL em vez de no corpo do pedido)
3.3 27/07/2022 Alteração de tamanho de campo “AssociatedRequestNumber” em
serviço findComplaintsByNumberV3
4 04/05/2023 • Alteração de método ListSupplier (REST): adicionado campo
de output “sourceSystemId” para facilitar procura de
operador/loja por parte do utilizador invocador
• Adicionado método ListSupplierV2 (SOAP) que é
semelhante ao ListSupplier com a alteração da estrutura de
saída, que incluí o campo “sourceSystemId”
• Alteração de método InsertUpdateStore (REST): adicionado
campo de input “sourcesystemid” para atribuir valor de
mapeamento à loja por parte do utilizador invocador
• Adicionado método InsertUpdateStoreV2 (SOAP) que é
semelhante ao InsertUpdateStore com a alteração da
estrutura de entrada, que incluí o campo “sourcesystemid”
1 Introdução
O presente documento descreve o conjunto de serviços acessíveis via web services que possibilita a
integração com o sistema LRE - Livro de Reclamação Eletrónico.
São disponibilizadas 2 formas de invocação de serviços:
• SOAP (Simple Object Access Protocol);

• REST (Representational State Transfer).
Assim sendo, é apresentado o exemplo de invocação para cada um em cada serviço disponibilizado.
2 Autenticação
A utilização dos WebServices requerem a pré autenticação do utilizador. As chamadas dos métodos
podem ser realizadas por utilizadores com perfis que permitam acesso aos serviços. Este acesso pode
ser dado através da Gestão de Utilizadores no Backoffice.
3 Ambientes
São disponibilizados 2 ambientes para acesso aos Webservices:
Produção v2.0 https://livroreclamacoes.pt/LRE_Operators_API/

(após 29 Outubro
2021)
Testes v2.0 (após https://incm-tst2.outsystemsenterprise.com/LRE_Operators_API/
29 Outubro 2021)
04/05/2023 5
Por motivos de histórico são também disponibilizados os endpoints antigos, mas para novas
integrações não poderão ser utilizados.
Produção v1.0 (pré https://livroreclamacoes.pt/puc-incm-app-portlet/api/axis

29 Outubro 2021) -
descontinuado
Testes v1.0 (pré 29 https://testes.lro.pt/puc-incm-app-portlet/api/axis/
Outubro 2021) –
descontinuado
04/05/2023 6
4 Instruções para novas integrações em ambiente de testes
Os pedidos de novas integrações deverão vir com a seguinte informação:
a) Email para integração – utilizado para invocar os webservices. Não tem de ser exclusivo para
esta função, podendo acumular com outro perfil.
b) Email para consumidor – que será utilizado para criar novos pedidos. É facultativo. A sua
existência depende dos cenários de teste que se pretenderem realizar.
c) Email para operador – que será utilizado como email de receção de
reclamações/elogios/sugestões/pedidos de informação (este último, apenas para entidades
reguladoras/fiscalizadoras). É facultativo. A sua existência depende dos cenários de teste que
se pretenderem realizar.
d) Email de encaminhamento – endereço para onde serão encaminhados quaisquer emails
gerados pelo LRE no ambiente de testes. Deverá ser indicado o modelo de encaminhamento
desejado, isto é, qual o email a ser utilizado para cada um dos indicados nos pontos b) e c)
anteriores. Tem de corresponder a um email existente e ao qual tenham acesso.
Após o fornecimento desta informação, os acessos serão configurados de acordo, sendo que a
entidade integradora receberá no(s) endereço(s) fornecido(s) (d) um email de autorização de
encaminhamento de emails que deverá autorizar. Caso não o faça, não receberá emails provenientes
da plataforma LRE em ambiente de testes.
Solicitamos que o(s) email(s) de encaminhamento seja(m) de domínio diferente de gmail, pois não
garantimos o correto funcionamento do(s) encaminhamento(s).
Para qualquer um dos tipos de email acima indicado, poderão ser criados vários para a mesma função.
Nota: esta operação não é necessária em produção.
Exemplo:
A entidade integradora pretende ter a seguinte configuração
• 2 consumidores
o 1 registado
o 1 não registado
• 1 utilizador com acesso BO – que será igual ao de serviços
Deverá fornecer os seguintes dados:
a) Email_operador_bo@email.pt
a. será utilizado para acesso aos serviços e BO;
b) Email_consumidor_registado@email.pt
a. deverá registar o consumidor na plataforma com este email;
c) Email_consumidor_naoregistado@email.pt
a. não deverá registar este email na plataforma e terá de utilizar este email em qualquer
reclamação, sugestão, elogio, pedido de informação criado;
d) Email do operador: Será o mesmo de a)
04/05/2023 7
a. neste cenário, mas pode ser diferente;
e) EmailReceçãoEmailsConsumidor@email.pt e EmailReceçãoEmailsOperador@email.pt
a. deverão existir e ser acessíveis pela entidade integradora de forma a que possa fazer
quaisquer testes necessários;
b. para simplificar poderá ser fornecido apenas 1 email para os encaminhamentos, no
entanto a entidade integradora terá de saber distinguir os vários assuntos.
5 Webservices
Os testes de integração com a plataforma do sistema Livro de Reclamações Eletrónico podem ser
realizados utilizando o URL indicado para cada serviço.
5.1 Reclamações
SOAP Produção 2.0 e [URLBase]/ComplaintServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/ Plugin_PUC_ComplaintService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/ComplaintServiceRestService/
Testes 2.0
AddUpdateComplaint
Serviço responsável por inserir reclamações físicas e editar quaisquer reclamações.
As Entidades Reguladoras podem inserir reclamações físicas e alterar os dados das reclamações.
Regras de inserção de reclamação física:
• Campos de preenchimento obrigatório:

o complaintId, complaintText, supplierName, complaintMotives, complaintReceptionDate,
complaintState, claimantIdentityCardType, complaintSender, claimantIdentityCardNumber,
claimantName, claimantFamilyName;
• Para inserir uma reclamação física, o campo complaintId deve ser preenchido com um número de
reclamação único que não exista registado;
• Os valores de motivos preenchidos no campo complaintMotives devem pertencer a Entidade
Reguladora que está a invocar o serviço;
• Se o campo claimantIdentityCardType for preenchido com o valor “UNKNOWN”, o campo
claimantIdentityCardNumber será ignorado;
Regras de edição de reclamação:
04/05/2023 8
• Para editar os dados de uma reclamação, o campo complaintId deve ser preenchido com o
número da reclamação que deseja alterar;
• Se a reclamação a ser editada for eletrónica (isto é, foi registada pelo consumidor através do
portal do Livro de Reclamações Eletrónico) a Entidade Reguladora poderá alterar apenas
valores dos campos: complaintMotives e complaintAssociated.
• Se a reclamação a editar for física, isto é, corresponder a uma reclamação em papel, todos
os campos são editáveis à exceção do número de identificação da reclamação (complaintId);
Ao inserir/editar uma reclamação física:
• O campo processNumber não é obrigatório e pode ser repetido;

• Se o operador/loja sobre o qual é feita a reclamação estiver registado na plataforma é
possível inserir o seu identificador (supplierId) e o seu nome (supplierName) permitindo que
todos os restantes campos referentes a este (supplierAddress, supplierEmail,
supplierLocation, supplierPostalCode, supplierTelephone, supplierWebsite) sejam
preenchidos de forma automática. Em alternativa, é possível preencher estes campos
manualmente;
• No caso do operador/loja não se encontrar registado na plataforma o campo supplierId deve
ser deixado por preencher, sendo obrigatório o preenchimento do campo supplierName. Os
restantes campos relacionados com o operador são de preenchimento opcional;
• Sempre que é preenchido o campo supplierId, é necessário garantir que este pertence à
entidade que invoca o serviço. O mesmo se aplica aos motivos da reclamação
(complaintMotives).
Campos de mensagem de envio:

Nome do Campo Tipo Tamanho Observações
Max. /
Formato
Fornecedor SupplierId Long 30 Nº identificador do
Integer operador económico
* Ver Campos com
instruções especiais
04/05/2023 9
SupplierEmail Text 100 Email do operador
económico
SupplierAddress Text 200 Endereço do operador
económico
SupplierLocation Text 75 Localidade do operador
económico
SupplierName Text 160 Nome do operador
económico
SupplierPostalCode Text 50 Código Postal do
operador económico
SupplierTelephone Text 10 Telefone do operador
económico
SupplierWebsite Text 200 Website do operador
económico
Reclamante ClaimantCountry Text 100 Código do país do
Reclamante
ClaimantDoor Text 10 Número da porta do
Reclamante
ClaimantEmail Text 100 Email do Reclamante
ClaimantName Text 75 Nome do Reclamante
ClaimantFamilyName Text 75 Apelido do Reclamante
ClaimantFloor Text 10 Andar do Endereço
ClaimantIdentityCardNumber Text 50 Nº do Documento do
Reclamante
ClaimantIdentityCardType Text 50 Tipo do Documento do
Reclamante
* Ver Campos com
ClaimantLocation Text 75 Localidade do
Reclamante
ClaimantPhone Text 10 Telefone do Reclamante
ClaimantPostalCode Text 10 Código Postal do
Reclamante
04/05/2023 10
ClaimantServiceAdress Text 30 Morada de
Fornecimento
ClaimantStreet Text 10 Rua do Reclamante
Reclamação ComplaintText Text 2000 Texto da Reclamação
ComplaintState Integer 1 Estado da Reclamação
* Ver Campos com
ComplaintSender Text 50 Indica se a reclamação
foi enviada à entidade
reguladora pelo
operador económico ou
pelo reclamante
* Ver secção Campos
com instruções especiais
ComplaintReceptionDate Text 20 Data/hora da receção da
reclamação na entidade
reguladora. Formato de
preenchimento: yyyy-
MM-dd HH:mm:ss
(2019-01-22 00:00:00).
É apenas preenchido
quando a reclamação é
física
ComplaintProcess Text 30 Identificador externo de
entidade reguladora.
física
ComplaintMotives Integer[] Valores de Motivo da
reclamação
* Ver Campos com
ComplaintComments Text 2000 Observações relativas à
reclamação adicionadas
04/05/2023 11
pela entidade que a
carrega
ComplaintFiles File[] 3x 2MB Ficheiros anexos à
reclamação
ComplaintId Text 75 Número de série
identificador da
reclamação
ComplaintDate Text 20 Data/hora da
reclamação, Formato de
MM-dd HH:mm:ss
(2019-01-22 00:00:00)
ComplaintAssociated Text 20 Número de série
identificador da
reclamação associada
ProcessNumber Text 100 Número do processo da
Reclamação.
física
Campos com instruções especiais:
Nome do Campo Observações

SupplierId Valor para preenchimento pode ser obtido consultando o
serviço ListSupplier com o parâmetro onlyOperator = 1
ClaimantIdentityCardType Pode ser preenchido com os valores:
• ID_CARD = Bilhete de Identidade;
• CITIZEN_CARD = Cartão de Cidadão;
• PASSPORT = Passaporte;
• FOREIGN_DRIVER_LICENSE = Carta de Condução
Estrangeira;
• FOREIGN_ID_CARD = Bilhete de Identidade
Estrangeiro;
• FOREIGN_PASSPORT = Passaporte Estrangeiro:
04/05/2023 12
• UNKNOWN = Ilegível
ComplaintState O campo complaintState pode tomar os seguintes valores de
acordo com o estado da reclamação:
• ComplaintState = 1 , Estado = Recebida/Em análise;
• ComplaintState = 2 , Estado = Respondida/tratada;
• ComplaintState = 3 , Estado = Em Centro de
Arbitragem;
• ComplaintState = 4 , Estado = Análise pela entidade
reguladora/fiscalizadora;
• ComplaintState = 5 , Estado = Abertura de processo
de contraordenação;
• ComplaintState = 6 , Estado = Encerrado/Arquivado.
ComplaintSender Deve ser preenchido com uma das opções a seguir:
• CLAIMANT
• SUPPLIER
ComplaintMotives Valor(es) para preenchimento pode(m) ser obtido(s) da
seguinte forma:
1. Consultar Motivos associados ao Setor de Atividade
associado a esta reclamação através do serviço
FindByActivitySectororNipc com parâmetro Type =
COMPLAINT
2. Consultar os valores de motivo para cada Motivo
obtido acima (em 1) através do serviço
FindByBusinessConceptId
5.1.1.1.1 Exemplo de mensagem de envio:

5.1.1.1.1.1 SOAP
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<addUpdateComplaint xmlns="http://www.outsystems.com">
<complaintRequest>
<SupplierId>long</SupplierId>
<SupplierEmail>string</SupplierEmail>
<SupplierAddress>string</SupplierAddress>
<SupplierLocation>string</SupplierLocation>
04/05/2023 13
<SupplierName>string</SupplierName>
<SupplierPostalCode>string</SupplierPostalCode>
<SupplierTelephone>string</SupplierTelephone>
<SupplierWebsite>string</SupplierWebsite>
<ClaimantCountry>string</ClaimantCountry>
<ClaimantDoor>string</ClaimantDoor>
<ClaimantEmail>string</ClaimantEmail>
<ClaimantName>string</ClaimantName>
<ClaimantFamilyName>string</ClaimantFamilyName>
<ClaimantFloor>string</ClaimantFloor>
<ClaimantIdentityCardNumber>string</ClaimantIdentityCardNumber>
<ClaimantIdentityCardType>string</ClaimantIdentityCardType>
<ClaimantLocation>string</ClaimantLocation>
<ClaimantPhone>string</ClaimantPhone>
<ClaimantPostalCode>string</ClaimantPostalCode>
<ClaimantServiceAddress>string</ClaimantServiceAddress>
<ClaimantStreet>string</ClaimantStreet>
<ComplaintText>string</ComplaintText>
<ComplaintState>long</ComplaintState>
<ComplaintSender>string</ComplaintSender>
<ComplaintReceptionDate>string</ComplaintReceptionDate>
<ComplaintProcess>string</ComplaintProcess>
<ComplaintMotives>
<long>long</long>
<long>long</long>
</ComplaintMotives>
<ComplaintComments>string</ComplaintComments>
<complaintFiles>
<Attachment>
<File>string</File>
<fileExtension>string</fileExtension>
</Attachment>
<Attachment>
<File>string</File>
</Attachment>
</complaintFiles>
<ComplaintId>string</ComplaintId>
<ComplaintDate>string</ComplaintDate>
<ComplaintAssociated>string</ComplaintAssociated>
<ProcessNumber>string</ProcessNumber>
</complaintRequest>
</addUpdateComplaint>
</soap:Body>
</soap:Envelope>
5.1.1.1.1.2 REST:
{
"SupplierId": 1234567891234567,
"SupplierEmail": "",
"SupplierAddress": "",
"SupplierLocation": "",
"SupplierName": "",
"SupplierPostalCode": "",
"SupplierTelephone": "",
"SupplierWebsite": "",
"ClaimantCountry": "",
"ClaimantDoor": "",
"ClaimantEmail": "",
"ClaimantName": "",
04/05/2023 14
"ClaimantFamilyName": "",
"ClaimantFloor": "",
"ClaimantIdentityCardNumber": "",
"ClaimantIdentityCardType": "",
"ClaimantLocation": "",
"ClaimantPhone": "",
"ClaimantPostalCode": "",
"ClaimantServiceAddress": "",
"ClaimantStreet": "",
"ComplaintText": "",
"ComplaintState": 1234567891234567,
"ComplaintSender": "",
"ComplaintReceptionDate": "",
"ComplaintProcess": "",
"ComplaintMotives": [
1234567891234567
],
"ComplaintComments": "",
"complaintFiles": [
{
"File": "",
"fileExtension": ""
}
],
"ComplaintId": "",
"ComplaintDate": "",
"ComplaintAssociated": "",
"ProcessNumber": ""
}
Campos de mensagem de resposta:

Nome do Campo Tipo Tam. Max. / Formato Observações
Code Text Código de resposta de
sucesso ou erro
Message Text Mensagem associada
ao status enviado
5.1.1.2.1 Exemplo de mensagem de resposta:

5.1.1.2.1.1 SOAP
<soap:Body>
<addUpdateComplaintResponse xmlns="http://www.outsystems.com">
<addUpdateComplaintReturn>
<Code>string</Code>
<Message>string</Message>
</addUpdateComplaintReturn>
</addUpdateComplaintResponse>
</soap:Body>
</soap:Envelope>
5.1.1.2.1.2 REST
{
"Code": "",
"Message": ""
04/05/2023 15
}
EditComplaintPaper
Serviço responsável por editar reclamações.

Nome do Campo Tipo Tamanho Observações
Max. /
Formato
Fornecedor SupplierId Long 30 Nº Identificador do
Integer operador económico
* Ver Campos com
SupplierEmail Text 100 Email do operador
económico
SupplierAdress Text 200 Endereço do operador
económico
SupplierLocation Text 75 Localidade do operador
económico
SupplierName Text 160 Nome do operador
económico
SupplierPostalCode Text 50 Código Postal do
operador económico
SupplierTelephone Text 10 Telefone do operador
económico
SupplierWebsite Text 200 Website do operador
económico
SupplierNipc Text 50 Nipc do operador
económico
Reclamante ClaimantCountry Text 100 Código do país do
Reclamante
ClaimantDoor Text 10 Número da porta do
Reclamante
ClaimantEmail Text 100 Email do Reclamante
ClaimantName Text 75 Nome do Reclamante
ClaimantFamilyName Text 75 Apelido do Reclamante
ClaimantFloor Text 10 Andar do reclamante
ClaimantIdentityCardNumber Text 50 Nº do Documento do
Reclamante
ClaimantIdentityCardType Text 50 Tipo do Doc. Do
Reclamante
* Ver Campos com
ClaimantLocation Text 75 Localidade do
Reclamante
ClaimantPhone Text 10 Telefone do
Reclamante
04/05/2023 16
ClaimantPostalCode Text 10 Código Postal do
Reclamante
ClaimantStreet Text 30 Morada de
Fornecimento
ClaimantStreet Text 10 Rua do Reclamante
Reclamação ComplaintText Text 2000 Texto da Reclamação
ComplaintSender Text 50 Indica se a reclamação
foi enviada à entidade
reguladora pelo
operador económico ou
pelo reclamante
* Ver Campos com
ComplaintReceptionDate Text 20 Data/hora da receção
da reclamação na
entidade reguladora
Formato de
MM-dd HH:mm:ss
(2019-01-22 00:00:00)
ComplaintProcess Text 30 Número do processo da
reclamação
ComplaintMotives Integer[] Valores de Motivo da
reclamação
* Ver Campos com
ComplaintDate Text 20 Data/hora da
reclamação, Formato
de preenchimento:
yyyy-MM-dd HH:mm:ss
(2019-01-22 00:00:00)
ComplaintIdentifictionNumber Text 100 Número de série
identificador da
Reclamação
Nome do Campo Observações

SupplierId Valor para preenchimento pode ser obtido
consultando o serviço ListSupplier com o
parâmetro onlyOperator = 1
ClaimantIdentityCardType Pode ser preenchido com os valores:
• ID_CARD = Bilhete de Identidade;
• CITIZEN_CARD = Cartão de Cidadão;
• PASSPORT = Passaporte;
04/05/2023 17
• FOREIGN_DRIVER_LICENSE = Carta
de Condução Estrangeira;
• FOREIGN_ID_CARD = Bilhete de
Identidade Estrangeiro;
• FOREIGN_PASSPORT = Passaporte
Estrangeiro;
• UNKNOWN = Ilegível
ComplaintSender Deve ser preenchido com uma das opções a
seguir:
• CLAIMANT
• SUPPLIER
ComplaintMotives Valor(es) para preenchimento pode(m) ser
obtido(s) da seguinte forma:
1. Consultar Motivos associados ao
Setor de Atividade associado a esta
reclamação através do serviço
FindByActivitySectororNipc com
parâmetro Type = COMPLAINT
2. Consultar os valores de motivo para
cada Motivo obtido acima (em 1)
através do serviço

5.1.2.1.1.1 SOAP
<soap:Body>
<editComplaintPaper xmlns="http://www.outsystems.com">
<complaintRequest>
<ClaimantDoor>string</ClaimantDoor>
<ClaimantFamilyName>string</ClaimantFamilyName>
<ClaimantFloor>string</ClaimantFloor>
<ClaimantStreet>string</ClaimantStreet>
04/05/2023 18
<ComplaintIdentificationNumber>string</ComplaintIdentificationNumber>
<ComplaintMotives>
<long>long</long>
<long>long</long>
</ComplaintMotives>
<SupplierId>long</SupplierId>
<SupplierNipc>string</SupplierNipc>
</complaintRequest>
</editComplaintPaper>
</soap:Body>
</soap:Envelope>
5.1.2.1.1.2 REST
{
"ClaimantDoor": "",
"ClaimantFamilyName": "",
"ClaimantFloor": "",
"ClaimantName": "",
"ClaimantStreet": "",
"ComplaintIdentificationNumber": "",
"ComplaintMotives": [
1234567891234567
],
"ComplaintReceptionDate": "",
"SupplierId": 1234567891234567,
"SupplierName": "",
"SupplierNipc": "",
"SupplierWebsite": ""
}
04/05/2023 19
Nome do Campo Tipo Tam. Max. / Formato Observações
Code Text Código de resposta de
sucesso ou erro
Message Text Mensagem associada
ao status enviado

5.1.2.2.1.1 SOAP
<soap:Body>
<editComplaintPaperResponse xmlns="http://www.outsystems.com">
<editComplaintPaperReturn>
<Code>string</Code>
</editComplaintPaperReturn>
</editComplaintPaperResponse>
</soap:Body>
</soap:Envelope>
5.1.2.2.1.2 REST
{
"Code": "",
"Message": ""
}
FindByIdentificationNumbers
Consulta de dados de reclamação(ões) pelo(s) seu(s) número(s) de identificação.

Nome Campo Tipo Tam. Max. / Observações
Formato
IdentificationNumbers CHAR[] 20 Lista de números de
série identificadores
das reclamações

5.1.3.1.1.1 SOAP
<soap:Body>
<findByIdentificationNumbers xmlns="http://www.outsystems.com">
<identificationNumbers>
<string>string</string>
04/05/2023 20
</identificationNumbers>
</findByIdentificationNumbers>
</soap:Body>
</soap:Envelope>
5.1.3.1.1.2 REST
{
"Ids": [
{
"Value": ""
}
]
}
5.1.3.1.2 Campos de mensagem de resposta:

Nome Campo Tipo Tam.Max Observações
./
Formato
Dados do address Text 100 Morada do
Consumido Reclamante
r (concatenação
entre street, door e
floor)
Country Text 75 País do Reclamante
Door Text 10 Número da Porta do
Reclamante
Email Text 100 Email do
Reclamante
familyName Text 75 Apelido do
Reclamante
postalCode Text 75 Número do Código
Postal do
Reclamante
Street Text 80 Rua do Reclamante
Telephone Text 75 Número de telefone
do Reclamante
Floor Text 10 Andar do
Reclamante
givenName Text 75 Nome do
Reclamante
identityCardNumber Text 75 Número de
identificação civil do
Reclamante
idenittyCardType Text 75 Tipo de
Identificação do
Reclamante
Location Text 75 Cidade do
Reclamante
04/05/2023 21
Mobile Text 75 Número do
telemóvel do
Reclamante
Nif Text 75 Número de
Identificação fiscal
do Reclamante
Dados da numberOfUploadedDocuments Numbe 30 Número de
reclamação r Documentos/anexo
s inseridos pelo
Reclamante
fileContent Binary Conteúdo do
Data ficheiro anexo (.zip
com ficheiros)
question Text 2000 Texto da
reclamação
primaryKey Numbe 30 Chave primária
r da reclamação
regulatoryAuthorityActivitySector Text 200 Sector de
atividade sobre
o qual incide a
reclamação
regulatoryAuthoritySourceSystem Text 75 sourceSystemId
Id da Entidade
Reguladora
sobre a qual
incide a reclamação
identificationNumber Text 75 Número de série
identificador da
reclamação
id Numbe 30 Número de
r identificação da
reclamação
createDate Date Data de criação
Time da reclamação
uuid Text 75 Identificador
único
uploadedDocumentPath Text 75 Caminho para o
documento
anexado -
descontinuado
Dados dos businessConceptSourceSystemId Text 75 sourceSystemId
motivos da do motivo
reclamação associado ao valor
[] de motivo
selecionado pelo
Reclamante
businessConceptValueSourceSystemI Numbe 30 sourceSystemId
d r do valor de
motivo selecionado
pelo Reclamante
valueEn Text 75 Nome em inglês
04/05/2023 22
do valor de
motivo selecionado
pelo Reclamante
valuePt Text 75 Nome em
português do
valor de motivo
selecionado pelo
Reclamante
uuid Text 75 Identificador
Único –
descontinuado
id Numbe Identificador do
r valor de
Motivo selecionado
pelo Reclamante
primaryKey Numbe Chave primária
r do Valor de motivo
selecionado pelo
Reclamante

5.1.3.1.3.1 SOAP
<soap:Body>
<findByIdentificationNumbersResponse
xmlns="http://www.outsystems.com">
<findByIdentificationNumbersReturn>
<ComplaintSoap>
<Address>string</Address>
<Country>string</Country>
<Door>string</Door>
<Email>string</Email>
<FamilyName>string</FamilyName>
<PostalCode>string</PostalCode>
<Street>string</Street>
<Telephone>string</Telephone>
<Floor>string</Floor>
<GivenName>string</GivenName>
<IdentityCardNumber>string</IdentityCardNumber>
<IdentityCardType>string</IdentityCardType>
<Location>string</Location>
<Mobile>string</Mobile>
<Nif>string</Nif>
<NumberOfUploadedDocuments>int</NumberOfUploadedDocuments>
<FileContent>base64Binary</FileContent>
<PrimaryKey>long</PrimaryKey>
<RegulatoryAuthorityActivitySector>string</RegulatoryAuthorityActivitySec
tor>
<RegulatoryAuthoritySourceSystemId>string</RegulatoryAuthoritySourceSyste
mId>
04/05/2023 23
<IdentificationNumber>string</IdentificationNumber>
<Id>long</Id>
<CreateDate>dateTime</CreateDate>
<Uuid>string</Uuid>
<UploadedDocumentPath>string</UploadedDocumentPath>
<AssociatedComplaintReference>string</AssociatedComplaintReference>
<complaintTaxonomies>
<ComplaintTaxonomySoap xsi:nil="true" />
</complaintTaxonomies>
<Description>string</Description>
<ExistsServiceAddress>boolean</ExistsServiceAddress>
<ServiceAddress>string</ServiceAddress>
<ServiceDoor>string</ServiceDoor>
<ServiceFloor>string</ServiceFloor>
<ServiceLocation>string</ServiceLocation>
<ServicePostalCode>string</ServicePostalCode>
<ServiceStreet>string</ServiceStreet>
<ShareableWithOperator>boolean</ShareableWithOperator>
<SpecificBusinessValue>string</SpecificBusinessValue>
<SupplierNIPC>string</SupplierNIPC>
<SupplierSourceSystemId>string</SupplierSourceSystemId>
</ComplaintSoap>
<ComplaintSoap>
<Door>string</Door>
<Nif>string</Nif>
<PrimaryKey>long</PrimaryKey>
tor>
mId>
<Id>long</Id>
<CreateDate>dateTime</CreateDate>
<Uuid>string</Uuid>
04/05/2023 24
</ComplaintSoap>
</findByIdentificationNumbersReturn>
</findByIdentificationNumbersResponse>
</soap:Body>
</soap:Envelope>
5.1.3.1.3.2 REST
[
{
"Address": "",
"Country": "",
"Door": "",
"Email": "",
"FamilyName": "",
"PostalCode": "",
"Street": "",
"Telephone": "",
"Floor": "",
"GivenName": "",
"IdentityCardNumber": "",
"IdentityCardType": "",
"Location": "",
"Mobile": "",
"Nif": "",
"NumberOfUploadedDocuments": 0,
"FileContent": "string",
"PrimaryKey": 1234567891234567,
"RegulatoryAuthorityActivitySector": "",
"RegulatoryAuthoritySourceSystemId": "",
"IdentificationNumber": "",
"Id": 1234567891234567,
"CreateDate": "2014-12-31T23:59:59.938Z",
"Uuid": "",
"UploadedDocumentPath": "",
"AssociatedComplaintReference": "",
"complaintTaxonomies": [
04/05/2023 25
{
"BusinessConceptSourceSystemId": "",
"BusinessConceptValueSourceSystemId": "",
"ValueEn": "",
"ValuePt": "",
"Uuid": "",
"Id": 1234567891234567,
"PrimaryKey": 1234567891234567
}
],
"Description": "",
"ExistsServiceAddress": false,
"ServiceAddress": "",
"ServiceDoor": "",
"ServiceFloor": "",
"ServiceLocation": "",
"ServicePostalCode": "",
"ServiceStreet": "",
"ShareableWithOperator": false,
"SpecificBusinessValue": "",
"SupplierNIPC": "",
"SupplierName": "",
"SupplierSourceSystemId": "",
}
]
FindComplaintByNumber
Consulta de informação de reclamação por código da reclamação com retorno de anexos.

Nome campo Tipo Tam. Máx. / Observações
Formato
complaintId Text 20 Número de série
identificador da
reclamação

5.1.4.1.1.1 SOAP
<soap:Body>
<findComplaintByNumber xmlns="http://www.outsystems.com">
<complaintId>string</complaintId>
</findComplaintByNumber>
</soap:Body>
</soap:Envelope>
04/05/2023 26
5.1.4.1.1.2 REST
string
5.1.4.1.2 Campos de mensagem de resposta:

Nome Campo Tipo Tam.
Max. /
Formato
Dados Entidade regulatoryAuthorityExternalId Text 75 Identificação da
Reguladora entidade
Reguladora
responsável
pelo
setor de
atividade
reclamado
regulatoryAuthorityActivityName Text 160 Nome da
entidade
Reguladora
responsável
pelo
setor de
atividade
reclamado
regulatoryAuthorityActivitySector Text 80 Nome do Setor
de atividade
sobre o qual
incide a
reclamação
Dados Operador operatorExternalId Text 75 Identificação do
Económico operador
económico
operatorNIPC Text 9 Número de
Identificação de
Pessoa Coletiva
do operador
económico
operatorName Text 160 Designação
social do
operador
Económico
operatorAddress Text 80 Morada do
operador
económico
operatorPostalCode Text 8 Número do
código postal
do operador
económico
operatorLocation Text 75 Localidade do
operador
económico
04/05/2023 27
operatorTelephone Text 15 Telefone do
operador
económico
operatorWebsite Text 200 URL da página
de internet do
operador
económico
operatorEmail Text 100 E-mail do
operador
económico
Dados de loja storeId Text 75 Identificação da
loja onde
ocorreu a
reclamação –
em caso
aplicável
storeName Text 160 Designação
comercial da
loja – em caso
aplicável
storeAddress Text 80 Endereço da
loja – em caso
aplicável
storePostalCode Text 8 Código postal
da loja – em
caso aplicável
storeLocation Text 75 Localidade da
loja – em caso
aplicável
storeTelephone Text 15 Telefone da loja
– em caso
aplicável
storeWebsite Text 200 URL da página
de internet da
loja – em caso
aplicável
storeEmail Text 100 E-mail da loja –
em caso
aplicável
Dados do claimantNif Text 15 Número de
Reclamante Identificação
Fiscal do
Reclamante
claimantIdentityCardType Text 10 Tipo de
documento de
Identificação do
Reclamante
claimantIdentityCardNumber Text 30 Número de
documento de
Identificação do
Reclamante
04/05/2023 28
claimantName Text 160 Nome do
Reclamante
claimantAddress Text 80 Endereço do
Reclamante
claimantServiceAddress Text 80 Morada
relacionada
com a
prestação do
serviço
claimantPostalCode Text 8 Código postal
do Reclamante
claimantLocation Text 75 Localidade do
Reclamante
claimantCountry Text 2 Código do país,
tabela ISO
Alpha-2
claimantPhone Text 15 Telefone do
Reclamante
claimantEmail Text 100 Email do
Reclamante
Dados da complaintID Text 20 Número de
Reclamação série
identificador da
reclamação
complaintProcess Text 20 Número interno
da reclamação
fornecido pela
Entidade
Reguladora
complaintDate DateTime Data/hora da
reclamação
complaintReceptionDate DateTime Data/hora da
receção da
reclamação na
entidade
reguladora
(quando
aplicável)
complaintSender Text 20 Indica se a
reclamação foi
Enviada à
entidade
Reguladora
pelo operador
Económico ou
pelo
Reclamante
complaintText Text 2000 Texto da
reclamação
complaintComments Text 500 Observações
relativas à
04/05/2023 29
Reclamação
adicionadas
pela entidade
que a
Carrega
complaintFiles Binary 3x2MB Ficheiros
Data anexados à
reclamação (em
.zip)
Histórico da complaintState Text 20 Descrição do
Reclamação estado
complaintStateDescription Text 75 Descrição do
estado da
Reclamação
comments Text 200 Observações
relativas à
alteração de
estado da
Reclamação
reclamação
user Text 50 Utilizador que
fez a alteração
Id Number 75 Número
identificador do
Histórico da
reclamação
Motivo da ComplaintMotives Text 75 Motivo da
Reclamação reclamação
ID Text 20 Número
identificador do
Motivo da
reclamação
Status de Retorno Code Text Código de
resposta de
sucesso ou erro
Message Text Mensagem
associada ao
status enviado

5.1.4.1.3.1 SOAP
<soap:Body>
<findComplaintByNumberResponse xmlns="http://www.outsystems.com">
<findComplaintByNumberReturn>
<RegulatoryAuthorityExternalId>string</RegulatoryAuthorityExternalId>
04/05/2023 30
<RegulatoryAuthorityActivityName>string</RegulatoryAuthorityActivityName>
tor>
<OperatorExternalId>string</OperatorExternalId>
<OperatorNIPC>string</OperatorNIPC>
<OperatorName>string</OperatorName>
<OperatorAddress>string</OperatorAddress>
<OperatorPostalCode>string</OperatorPostalCode>
<OperatorLocation>string</OperatorLocation>
<OperatorTelephone>string</OperatorTelephone>
<OperatorWebsite>string</OperatorWebsite>
<OperatorEmail>string</OperatorEmail>
<StoreId>string</StoreId>
<StoreName>string</StoreName>
<StoreAddress>string</StoreAddress>
<StorePostalCode>string</StorePostalCode>
<StoreLocation>string</StoreLocation>
<StoreTelephone>string</StoreTelephone>
<StoreWebsite>string</StoreWebsite>
<StoreEmail>string</StoreEmail>
<ClaimantNif>string</ClaimantNif>
<ClaimantAddress>string</ClaimantAddress>
<ComplaintID>string</ComplaintID>
<ComplaintFiles>base64Binary</ComplaintFiles>
<complaintHistories>
<ComplaintHistory>
<ComplaintState>string</ComplaintState>
<ComplaintStateDescription>string</ComplaintStateDescription>
<Comments>string</Comments>
<user>string</user>
<id>string</id>
</ComplaintHistory>
<ComplaintHistory>
<user>string</user>
<id>string</id>
</ComplaintHistory>
</complaintHistories>
<complaintMotives>
<ComplaintMotives>
04/05/2023 31
<ComplaintMotives>string</ComplaintMotives>
<id>string</id>
</ComplaintMotives>
<ComplaintMotives>
<id>string</id>
</ComplaintMotives>
</complaintMotives>
<id>long</id>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
</findComplaintByNumberReturn>
</findComplaintByNumberResponse>
</soap:Body>
</soap:Envelope>
5.1.4.1.3.2 REST
{
"RegulatoryAuthorityExternalId": "",
"RegulatoryAuthorityActivityName": "",
"OperatorExternalId": "",
"OperatorNIPC": "",
"OperatorName": "",
"OperatorAddress": "",
"OperatorPostalCode": "",
"OperatorLocation": "",
"OperatorTelephone": "",
"OperatorWebsite": "",
"OperatorEmail": "",
"StoreId": "",
"StoreName": "",
"StoreAddress": "",
"StorePostalCode": "",
"StoreLocation": "",
"StoreTelephone": "",
"StoreWebsite": "",
"StoreEmail": "",
"StoreSourceSystemId": "",
"ClaimantNif": "",
"ClaimantName": "",
"ClaimantAddress": "",
"ClaimantServiceAddress": "",
"ComplaintID": "",
"ComplaintDate": "2014-12-31T23:59:59.938Z",
"ComplaintReceptionDate": "2014-12-31T23:59:59.938Z",
"ComplaintComments": "",
"ComplaintFiles": "string",
"complaintHistories": [
{
04/05/2023 32
"ComplaintState": "",
"ComplaintStateDescription": "",
"Comments": "",
"user": "",
"id": ""
}
],
"complaintMotives": [
{
"ComplaintMotives": "",
"id": ""
}
],
"id": "",
"AssociatedComplaintRef": "",
"IsOnline": false,
"ComplaintPaperSendby": "",
"IsTransfered": false,
"serviceResponse": {
"Code": "",
"Message": ""
},
"ComplaintMotives_V3": [
{
"valuePT": "",
"valueEN": "",
"busConceptValueSourceSysId": "",
"busConceptSourceSysId": "",
"priority": 0
}
]
}
FindComplaintByNumberV2
Retorna os dados de uma reclamação pelo seu número de identificação – sem detalhe de anexos.
NOTA: Este serviço será descontinuado pelo que deve utilizar o FindComplaintByNumber ou
FindComplaintByNumberV3.

Nome campo Tipo Tam.Máx. Formato Observações
complaintNumber Text 20 Número de série

identificador da
reclamação

5.1.5.1.1.1 SOAP
04/05/2023 33
<soap:Body>
<findComplaintByNumberV2 xmlns="http://www.outsystems.com">
</findComplaintByNumberV2>
</soap:Body>
</soap:Envelope>
5.1.5.1.1.2 REST
Serviço não existente em REST.

Nome campo Tipo Tam. Observações
Max./Formato
Dados regulatoryAuthorityExternalId Text 75 Identificação
Entidade da
Reguladora Entidade
Reguladora
responsável
pelo setor de
atividade
reclamado
regulatoryAuthorityActivityName Text 160 Nome da
entidade
reguladora
responsável
pelo setor de
atividade
reclamado
regulatoryAuthorityActivitySector Text 80 Setor de
atividade
sobre o qual
incide a
reclamação
Dados operatorExternalId Text 75 Identificação
Operador do
Económico operador
económico
operatorNIPC Text 9 Número de
Identificação
de
Pessoa
Coletiva do
Operador
económico
operatorName Text 160 Designação
social do
operador
económico
04/05/2023 34
operatorAddress Text 80 Morada do
operador
económico
operatorPostalCode Text 8 Número do
código postal
do operador
económico
operatorLocation Text 75 Localidade do
operador
económico
operatorLocation Text 15 Telefone do
operador
económico
operatorLocation Text 200 URL da página
de internet do
operador
económico
operatorEmail Text 100 E-mail do
operador
económico
Dados da loja storeId Text 75 Identificação
da loja onde
ocorreu a
reclamação –
se aplicável
storeId Text 160 Designação
comercial da
loja – se
aplicável
storeAddress Text 80 Endereço da
loja – se
aplicável
storePostalCode Text 8 Código postal
da loja – se
aplicável
storeLocation Text 75 Localidade da
loja – se
aplicável
storeTelephone Text 15 Telefone da
loja – se
aplicável
storeWebsite Text 200 URL da página
de internet da
loja – se
aplicável
storeEmail Text 100 E-mail da loja
– se aplicável
Reclamante Identificação
Fiscal do
reclamante
04/05/2023 35
claimantIdentityCardType Text 10 Tipo de
documento de
identificação
do reclamante
claimantIdentityCardNumber Text 30 Número de
documento de
identificação
do reclamante
claimantName Text 160 Nome do
reclamante
reclamante
claimantServiceAddress Text 80 Morada
relacionada
com a
prestação do
serviço
claimantPostalCode Text 8 Código postal
do reclamante
claimantLocation 75 Localidade do
reclamante
claimantCountry 2 Código do
país, tabela
ISO Alpha-2
claimantPhone 15 Telefone do
reclamante
claimantEmail 100 Email do
reclamante
Dados complaintID Text 20 Número de
Reclamação série
identificador
da reclamação
complaintProcess Text 20 Número
interno da
entidade que
carrega a
reclamação
complaintDate Date Data/hora da
Time reclamação
complaintReceptionDate Date Data/hora da
Time receção da
reclamação na
entidade
reguladora
complaintSender Text 20 Indica se a
reclamação foi
enviada à
entidade
reguladora
pelo operador
económico
04/05/2023 36
ou pelo
reclamante
complaintText Text 2000 Texto da
reclamação
complaintComments Text 20 Observações
relativas à
reclamação
adicionadas
pela entidade
que a carrega
Histórico da complaintState Text 20 Código do
Reclamação estado
complaintStateDescription Text 75 Descrição do
estado
comments Text 200 Observações
relativas
Histórico da
Reclamação à
alteração de
estado da
reclamação
reclamação
user Text 50 Utilizador que
fez a alteração
id Number 30 Número
identificador
do histórico da
reclamação
Motivo da ComplaintMotives 75 Motivo da
Reclamação reclamação
ID Text 20 Número
identificador
do motivo da
reclamação
Status de Code Text Código de
Retorno resposta de
sucesso ou
erro
Message Text Mensagem
associada ao
status enviado

5.1.5.2.1.1 SOAP
<soap:Body>
04/05/2023 37
<findComplaintByNumberV2Response xmlns="http://www.outsystems.com">
<findComplaintByNumberV2Return>
tor>
<StoreId>string</StoreId>
<ComplaintID>string</ComplaintID>
<ComplaintHistory>
<user>string</user>
<id>string</id>
</ComplaintHistory>
<ComplaintHistory>
<user>string</user>
<id>string</id>
</ComplaintHistory>
04/05/2023 38
<complaintMotives>
<ComplaintMotives>
<id>string</id>
</ComplaintMotives>
<ComplaintMotives>
<id>string</id>
</ComplaintMotives>
</complaintMotives>
<id>string</id>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
</findComplaintByNumberV2Return>
</findComplaintByNumberV2Response>
</soap:Body>
</soap:Envelope>
5.1.5.2.1.2 REST
Este serviço não devolve histórico, anexos e ficheiros da reclamação, sendo necessária a invocação de
outro serviço para o efeito.

Nome campo Tipo Tam.Máx. /Formato Observações
complaintNumber Text 20 Número de série
identificador da
reclamação

5.1.6.1.1.1 SOAP
<soap:Body>
<findComplaintByNumberV3 xmlns="http://www.outsystems.com">
</findComplaintByNumberV3>
</soap:Body>
</soap:Envelope>
5.1.6.1.1.2 REST
04/05/2023 39
Nome campo Tipo Tam.Máx Observações
.
Formato
Dados da RegulatoryAuthorityExternalId Text 75 Identificação da
Entidade entidade reguladora
Reguladora responsável pelo setor
de atividade
reclamado
regulatoryAuthorityActivityNam Text 160 Nome da entidade
e reguladora
responsável pelo setor
de atividade
reclamado
regulatoryAuthorityActivitySect Text 80 Nome do setor de
or atividade sobre o qual
incide a reclamação
Dados operatorExternalId Text 75 Identificação do
operador operador económico
Económico operatorNIPC Text 9 Número de
Identificação de Pessoa
Coletiva do operador
económico
operatorName Text 160 Designação social do
operador económico
operatorAddress Text 80 Morada do operador
económico
operatorPostalCode Text 8 Número do código
postal do operador
económico
operatorPostalCode Text 75 Localidade do
operador económico
operatorTelephone Text 15 Telefone do operador
económico
operatorWebsite Text 200 URL da página de
internet do operador
económico
operatorEmail Text 100 E-mail do operador
económico
Dados da storeSourceSystemId Text 75 Identificação da loja
loja onde ocorreu a
reclamação – se
aplicável
storeName Text 160 Designação comercial

da loja – se aplicável
storeAddress Text 80 Endereço da loja – se
aplicável
storePostalCode Text 8 Código postal da loja –
se aplicável
04/05/2023 40
storeLocation Text 75 Localidade da loja – se
aplicável
storeTelephone Text 15 Telefone da loja – se
aplicável
storeWebsite Text 200 URL da página de
internet da loja – se
aplicável
storeEmail Text 100 E-mail da loja – se
aplicável
Reclamante Identificação Fiscal do
reclamante
claimantIdentityCardType Text 10 Tipo de documento de
identificação do
reclamante
claimantIdentityCardNumber Text 30 Número de documento
de identificação do
reclamante
claimantName Text 160 Nome do reclamante
reclamante
claimantPostalCode Text 8 Código postal do
reclamante
claimantLocation Text 75 Localidade do
reclamante
claimantCountry Text 2 Código do país, tabela
ISO Alpha-2
claimantPhone Text 15 Telefone do
reclamante
claimantEmail Text 100 Email do reclamante
claimantServiceAddress Text 80 Morada relacionada
com a prestação do
serviço
Dados shareableWithOperator BOOLEA Indica se o reclamante
Reclamação N permite a partilha dos
dados pessoais com o
Operador/loja
selecionado/a
identificationNumber Text 20 Número de série
identificador da
reclamação
complaintProcess Text 20 Número interno da
entidade que carrega a
reclamação
complaintDate DateTim Data/hora da
e reclamação
complaintReceptionDate DateTim Data/hora da receção
e da reclamação na
entidade reguladora
complaintText Text 2000 Texto da reclamação
04/05/2023 41
associatedComplaintRef Text 20 Reclamação associada
isTransfered BOOLEA Indica se a reclamação
N foi transferida pela
entidade
reguladora/fiscalizador
a
inicial para outra
entidade
isOnline BOOLEA Indica se a reclamação
N é online (eletrónica) ou
em papel
complaintPaperSendby Text 75 Indica a proveniência
da reclamação em
papel, isto é, se os
dados foram inseridos
a partir da reclamação
submetida pelo
operador ou pelo
reclamante
Valores dos valuePT Text 255 Valor do motivo
motivos da (Português)
Reclamação[ valueEN Text 255 Valor do motivo
] (Inglês)
busConceptValueSourceSysId Text 75 sourceSystemId do
valor do motivo
busConceptSourceSysId Text 75 sourceSystemId do
motivo associado ao
valor de motivo
selecionado
priority Inteiro Hierarquia dos valores
Status de code Text Código de resposta de
resposta sucesso ou erro
message Text Mensagem associada
ao status enviado
23

5.1.6.2.1.1 SOAP
<soap:Body>
<findComplaintByNumberV3Response xmlns="http://www.outsystems.com">
<findComplaintByNumberV3Return>
tor>
04/05/2023 42
<StoreSourceSystemId>string</StoreSourceSystemId>
<complaintMotives>
<ComplaintMotives_V3>
<valuePT>string</valuePT>
<valueEN>string</valueEN>
<busConceptValueSourceSysId>string</busConceptValueSourceSysId>
<busConceptSourceSysId>string</busConceptSourceSysId>
<priority>int</priority>
</ComplaintMotives_V3>
<ComplaintMotives_V3>
<valuePT>string</valuePT>
<valueEN>string</valueEN>
<busConceptValueSourceSysId>string</busConceptValueSourceSysId>
<busConceptSourceSysId>string</busConceptSourceSysId>
</ComplaintMotives_V3>
</complaintMotives>
<id>long</id>
<AssociatedComplaintRef>string</AssociatedComplaintRef>
<IsOnline>string</IsOnline>
<ComplaintPaperSendby>string</ComplaintPaperSendby>
<IsTransfered>string</IsTransfered>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
04/05/2023 43
</findComplaintByNumberV3Return>
</findComplaintByNumberV3Response>
</soap:Body>
</soap:Envelope>
5.1.6.2.1.2 REST
FindComplaintHistory
Obtém o histórico associado à reclamação – identificada pelo seu número de identificação.
NOTA: Este serviço será descontinuado pelo que deve utilizar o FindComplaintHistoryV2.

Nome campo Nome campo Tam.Máx. /Formato Observações
complaintId Text 20 Número de série
identificador da
reclamação

5.1.7.1.1.1 SOAP
<soap:Body>
<findComplaintHistory xmlns="http://www.outsystems.com">
</findComplaintHistory>
</soap:Body>
</soap:Envelope>
5.1.7.1.1.2 REST
string

Nome campo Tipo Tam.Máx. Observações
/Formato
comments Text 20 Observações relativas à alteração de
estado da reclamação
complaintDate Text 20 Data da alteração do estado
complaintState Text 20 Estado da reclamação
Id Text 20 Identificador do histórico
complaintStateDescripti Text 100 Descrição do estado
on
user Text 20 Utilizador que realizou a alteração
04/05/2023 44
Code Text Código de resposta de sucesso ou erro
Message Text Mensagem associada ao status enviado

5.1.7.2.1.1 SOAP
<soap:Body>
<findComplaintHistoryResponse xmlns="http://www.outsystems.com">
<findComplaintHistoryReturn>
<ComplaintHistory>
<user>string</user>
<id>string</id>
</ComplaintHistory>
<ComplaintHistory>
<user>string</user>
<id>string</id>
</ComplaintHistory>
<id>string</id>
<response>
<Code>string</Code>
</response>
</findComplaintHistoryReturn>
</findComplaintHistoryResponse>
</soap:Body>
</soap:Envelope>
5.1.7.2.1.2 REST
{
"complaintHistories": [
{
"ComplaintState": "",
"ComplaintStateDescription": "",
"Comments": "",
"user": "",
"id": ""
}
],
"id": "",
"response": {
"Code": "",
"Message": ""
}
}
04/05/2023 45
FindComplaintHistoryV2

/Formato
identificationNumber CHAR 20 Número de série identificador da
reclamação
30

5.1.8.1.1.1 SOAP
<soap:Body>
<findComplaintHistoryV2 xmlns="http://www.outsystems.com">
<identificationNumber>string</identificationNumber>
</findComplaintHistoryV2>
</soap:Body>
</soap:Envelope>
5.1.8.1.1.2 REST
string

/Formato
complaintHistory[] comments CHAR 20 Observações
relativas à
alteração de
estado da
reclamação
createDate DATE Data da alteração
do estado
complaintState LONG Estado da
reclamação
Id LONG Identificador do
histórico
complaintStateDescription CHAR 100 Descrição do
estado
user CHAR 20 Utilizador que
realizou a
alteração
regAuthId LONG ID da entidade que
tratou (transferiu)
a reclamação
04/05/2023 46
regAuthName CHAR 255 Nome da entidade
que tratou
(transferiu) a
reclamação
regAuthIdRecipient LONG ID da entidade
para quem foi
transferida a
reclamação
regAuthNameRecipient CHAR 255 Nome da entidade
para quem foi
transferida a
reclamação
Status de resposta Code CHAR Código de resposta
de sucesso ou erro
Message CHAR Mensagem
associada ao status
enviado

5.1.8.2.1.1 SOAP
<soap:Body>
<findComplaintHistoryV2Response xmlns="http://www.outsystems.com">
<findComplaintHistoryV2Return>
<listComplaintHistory>
<ComplaintHistoryModelResponse>
<comments>string</comments>
<complaintState>long</complaintState>
<complaintStateDescription>string</complaintStateDescription>
<createDate>dateTime</createDate>
<id>long</id>
<regAuthId>long</regAuthId>
<regAuthIdRecipient>long</regAuthIdRecipient>
<regAuthName>string</regAuthName>
<regAuthNameRecipient>string</regAuthNameRecipient>
<user>string</user>
</ComplaintHistoryModelResponse>
<ComplaintHistoryModelResponse>
<comments>string</comments>
<complaintState>long</complaintState>
<complaintStateDescription>string</complaintStateDescription>
<id>long</id>
<regAuthName>string</regAuthName>
<regAuthNameRecipient>string</regAuthNameRecipient>
<user>string</user>
</ComplaintHistoryModelResponse>
</listComplaintHistory>
<returnServicesResponse>
<Code>string</Code>
04/05/2023 47
</returnServicesResponse>
</findComplaintHistoryV2Return>
</findComplaintHistoryV2Response>
</soap:Body>
</soap:Envelope>
5.1.8.2.1.2 REST
{
"listComplaintHistory": [
{
"comments": "",
"complaintState": 1234567891234567,
"complaintStateDescription": "",
"createDate": "2014-12-31T23:59:59.938Z",
"id": 1234567891234567,
"regAuthId": 1234567891234567,
"regAuthIdRecipient": 1234567891234567,
"regAuthName": "",
"regAuthNameRecipient": "",
"user": ""
}
],
"returnServicesResponse": {
"Code": "",
"Message": ""
}
}
FindComplaintsBetweenDates
Obtém a lista de reclamações dentro do intervalo de datas fornecido.
NOTA: Este serviço será descontinuado pelo que deve utilizar o FindComplaintsBetweenDatesV2.

Nome campo Tipo Tam.Máx. / Formato Observações
beginDate DATETIME Data inicial para
pesquisar reclamações
endDate DATETIME Data final para
pesquisar reclamações

5.1.9.1.1.1 SOAP
<soap:Body>
<findComplaintsBetweenDates xmlns="http://www.outsystems.com">
<beginDate>dateTime</beginDate>
<endDate>dateTime</endDate>
</findComplaintsBetweenDates>
</soap:Body>
</soap:Envelope>
04/05/2023 48
5.1.9.1.1.2 REST
{
"beginDate": "2014-12-31T23:59:59.938Z",
"endDate": "2014-12-31T23:59:59.938Z"
}

complaintIds CHAR[] 20 Lista de números de série identificadores das
reclamações no intervalo de datas
Code CHAR Código de resposta de sucesso ou erro
Message CHAR Mensagem associada ao status enviado

5.1.9.2.1.1 SOAP
<soap:Body>
<findComplaintsBetweenDatesResponse
<findComplaintsBetweenDatesReturn>
<complaintIds>
</complaintIds>
<response>
<Code>string</Code>
</response>
</findComplaintsBetweenDatesReturn>
</findComplaintsBetweenDatesResponse>
</soap:Body>
</soap:Envelope>
5.1.9.2.1.2 REST
{
"complaintIds": {
"Ids": [
{
"Value": ""
}
]
},
"response": {
"Code": "",
"Message": ""
}
}
FindComplaintsBetweenDatesV2
• Se o serviço for invocado por um operador, os parâmetros transferredToRegAuth, regAuthId
e supplierId serão ignorados.35
04/05/2023 49
• Se o serviço for invocado por uma entidade reguladora, os parâmetros regAuthId e supplierId
serão ignorados.
• Se o serviço for invocado pelo Administrador do portal, os parâmetros regAuthId e supplierId
serão utilizados para simular a invocação.
A resposta do serviço é paginada. O máximo de resultados por página será de 100.

Nome campo Tipo Observações
beginDate DATETIME Data inicial para pesquisar reclamações
endDate DATETIME Data final para pesquisar reclamações
complaintType LONG Especifica quais as reclamações que devem ser
pesquisadas.
Por omissão, serão devolvidas todas as reclamações
* Ver Campos com instruções especiais
transferredToRegAuth LONG Especifica se inclui na pesquisa também as reclamações
transferidas para a entidade reguladora/fiscalizadora.
As reclamações transferidas serão filtradas por data de
transferência.
Por omissão, serão devolvidas todas as reclamações
Ignorado se invocado por operador económico
regAuthId LONG ID da entidade reguladora/fiscalizadora
supplierId LONG ID do operador económico
pStart INT Inicio do intervalo de paginação
pEnd INT Fim do intervalo de paginação

complaintType LONG Valores possíveis:
0 – Todas as reclamações
1 – Reclamações eletrónicas
2 – Reclamações em papel inseridas na plataforma LRE
transferredToRegAuth LONG Valores possíveis:
0 – Todas as reclamações
1 – Reclamações transferidas para a entidade
reguladora/fiscalizadora
2 – Não inclui transferidas para a entidade
regAuthId LONG Valor para preenchimento pode ser obtido consultando o
serviço ListRegulatoryAuthority
supplierId LONG Valor para preenchimento pode ser obtido consultando o

5.1.10.1.1.1 SOAP
04/05/2023 50
<soap:Body>
<findComplaintsBetweenDatesV2 xmlns="http://www.outsystems.com">
<ComplaintsBetweenDatesInput>
<beginDate>dateTime</beginDate>
<complaintType>long</complaintType>
<transferredToRegAuth>long</transferredToRegAuth>
<supplierId>long</supplierId>
<pStart>int</pStart>
<pEnd>int</pEnd>
</ComplaintsBetweenDatesInput>
</findComplaintsBetweenDatesV2>
</soap:Body>
</soap:Envelope>
5.1.10.1.1.2 REST
{
"beginDate": "2014-12-31T23:59:59.938Z",
"endDate": "2014-12-31T23:59:59.938Z",
"complaintType": 1234567891234567,
"transferredToRegAuth": 1234567891234567,
"regAuthId": 1234567891234567,
"supplierId": 1234567891234567,
"pStart": 0,
"pEnd": 0
}

/Formato
complaintsArray[] identificationNumber CHAR 20 Número de série
identificador da
reclamação
complaintType LONG Indica o tipo de
reclamação:
1 – Reclamação
eletrónica
2 – Reclamações em
papel
transferredToRegAuth BOOLEAN Indica se a reclamação
foi
transferida para a
entidade
belongsToRegAuth BOOLEAN Indica se a reclamação
pertence à entidade
pStart INT Inicio do intervalo de
paginação
04/05/2023 51
pEnd INT Fim do intervalo de
paginação processado
pelo sistema
total LONG Total de resultados da
pesquisa
Status de code CHAR Código de resposta de
resposta sucesso ou erro
message CHAR Mensagem associada ao
status enviado

5.1.10.2.1.1 SOAP
<soap:Body>
<findComplaintsBetweenDatesV2Response
<findComplaintsBetweenDatesV2Return>
<complaintsArray>
<ComplaintData>
<complaintType>string</complaintType>
<transferredToRegAuth>boolean</transferredToRegAuth>
<belongsToRegAuth>boolean</belongsToRegAuth>
</ComplaintData>
<ComplaintData>
<complaintType>string</complaintType>
<transferredToRegAuth>boolean</transferredToRegAuth>
<belongsToRegAuth>boolean</belongsToRegAuth>
</ComplaintData>
</complaintsArray>
<response>
<Code>string</Code>
<pEnd>int</pEnd>
<pStart>int</pStart>
<total>long</total>
</response>
</findComplaintsBetweenDatesV2Return>
</findComplaintsBetweenDatesV2Response>
</soap:Body>
</soap:Envelope>
5.1.10.2.1.2 REST
{
"complaintsArray": [
{
"identificationNumber": "",
"complaintType": "",
"transferredToRegAuth": false,
"belongsToRegAuth": false
}
04/05/2023 52
],
"response": {
"Code": "",
"Message": "",
"pEnd": 0,
"pStart": 0,
"total": 1234567891234567
}
}
FindFileContents
Obtém anexos associados à reclamação.

/Formato
reclamação

5.1.11.1.1.1 SOAP
<soap:Body>
<findFileContents xmlns="http://www.outsystems.com">
</findFileContents>
</soap:Body>
</soap:Envelope>
5.1.11.1.1.2 REST
string

/Formato
findFileContentsReturn Base 64 Ficheiros anexos à reclamação (.zip
com os ficheiros)

5.1.11.2.1.1 SOAP
<soap:Body>
<findFileContentsResponse xmlns="http://www.outsystems.com">
<findFileContentsReturn>base64Binary</findFileContentsReturn>
</findFileContentsResponse>
</soap:Body>
</soap:Envelope>
04/05/2023 53
5.1.11.2.1.2 REST
BinaryData
FindFullDataByIdentificationNumbers
Obtém dados de reclamação(ões) identificados pelo(s) número(s) de identificação fornecido(s).

identificationNumbers CHAR [] 20 Número de série identificador da reclamação

5.1.12.1.1.1 SOAP
<soap:Body>
<findFullDataByIdentificationNumbers
</findFullDataByIdentificationNumbers>
</soap:Body>
</soap:Envelope>
5.1.12.1.1.2 REST
{
"Ids": [
{
"Value": ""
}
]
}

.
/Formato
Dados do Address CHAR 100 Morada do
Consumidor reclamante
(concatenação
de street, door
e floor)
Country CHAR 75 País do
reclamante
04/05/2023 54
Door CHAR 10 Número da
porta do
reclamante
Email CHAR 100 Correio
eletrónico do
reclamante
familyName CHAR 75 Apelido do
reclamante
postalCode CHAR 75 Número do
código postal
do reclamante
Street CHAR 80 Rua do
reclamante
telephone CHAR 75 Número de
telefone do
reclamante
Floor CHAR 10 Andar do
reclamante
givenName CHAR 75 Nome do
reclamante
identityCardNumber CHAR 75 Número de
identificação
civil do
reclamante
identityCardType CHAR 75 Tipo de
identificação
do reclamante
location CHAR 75 Localidade do
reclamante
Mobile CHAR 75 Número de
telemóvel do
reclamante
Nif CHAR 75 Número de
identificação
fiscal do
reclamante
numberOfUploadedDocuments NUMBER 30 Número de
documentos
anexados à
reclamação
Dados da fileContent BASE 64 Conteúdo do
reclamação ficheiro anexo
(.zip com todos
os anexos)
question CHAR 2000 Texto da
reclamação
primaryKey NUMBER 30 Chave primária
da reclamação
regulatoryAuthorityActivitySector CHAR 200 Nome do
Sector de
atividade sobre
04/05/2023 55
o qual incide
da reclamação
regulatoryAuthoritySourceSystemId CHAR 75 sourceSystemI
d da Entidade
Reguladora
sobre a qual
incide a
reclamação
identificationNumber CHAR 75 Número de
série
identificador
da reclamação
id NUMBER 30 Número de
identificação
da reclamação
createDate TIMESTAM Data de criação
P da reclamação
uuid CHAR 75 Identificador
único -
descontinuado
uploadedDocumentPath CHAR 75 Caminho para
o documento
anexado -
descontinuado
Dados dos businessConceptSourceSystemId CHAR 75 sourceSystemI
motivos da d do motivo da
reclamação[ reclamação
] businessConceptValueSourceSystemI NUMBER 30 sourceSystemI
d d do valor de
motivo da
reclamação
selecionado
pelo
reclamante
valueEn CHAR 75 Nome em
inglês do valor
de motivo
selecionado
pelo
reclamante
valuePt CHAR 75 Nome em
português do
valor de
motivo
selecionado
pelo
reclamante
único
Id NUMBER Identificador
do valor de
04/05/2023 56
motivo
selecionado
pelo
reclamante
primaryKey NUMBER Chave primária
do valor de
motivo
selecionado
pelo
reclamante

5.1.12.2.1.1 SOAP
<soap:Body>
<findFullDataByIdentificationNumbersResponse
<findFullDataByIdentificationNumbersReturn>
<ComplaintSoap_V2>
<Door>string</Door>
<Nif>string</Nif>
<primaryKey>long</primaryKey>
tor>
mId>
<id>long</id>
<uuid>string</uuid>
04/05/2023 57
</ComplaintSoap_V2>
<ComplaintSoap_V2>
<Door>string</Door>
<Nif>string</Nif>
tor>
mId>
<id>long</id>
<uuid>string</uuid>
04/05/2023 58
</ComplaintSoap_V2>
</findFullDataByIdentificationNumbersReturn>
</findFullDataByIdentificationNumbersResponse>
</soap:Body>
</soap:Envelope>
5.1.12.2.1.2 REST
[
{
"Address": "",
"Country": "",
"Door": "",
"Email": "",
"FamilyName": "",
"PostalCode": "",
"Street": "",
"Telephone": "",
"Floor": "",
"GivenName": "",
"IdentityCardNumber": "",
"IdentityCardType": "",
"Location": "",
"Mobile": "",
"Nif": "",
"NumberOfUploadedDocuments": 0,
"FileContent": "string",
"Description": "",
"primaryKey": 1234567891234567,
"RegulatoryAuthoritySourceSystemId": "",
"id": 1234567891234567,
"createDate": "2014-12-31T23:59:59.938Z",
"uuid": "",
"UploadedDocumentPath": "",
"complaintTaxonomies": [
{
"ValueEn": "",
"ValuePt": "",
"Uuid": "",
"Id": 1234567891234567,
"PrimaryKey": 1234567891234567
}
],
"AssociatedComplaintReference": "",
"ExistsServiceAddress": false,
04/05/2023 59
"ServiceDoor": "",
"ServiceFloor": "",
"ServiceLocation": "",
"ServiceStreet": "",
"SpecificBusinessValue": "",
"SupplierNIPC": "",
"SupplierName": "",
"SupplierSourceSystemId": "",
}
]
FindHistoryFileContents
Obtém os anexos associados ao histórico da reclamação. Estes são os anexos tipicamente inseridos
por Operadores Económicos/Entidades Reguladoras no tratamento da reclamação.

historyId NUMBER 30 Número identificador
do histórico da
reclamação
* Ver Campos com

Nome campo Observações
historyId Valor para preenchimento pode ser obtido
consultando o serviço FindComplaintHistoryV2

5.1.13.1.1.1 SOAP
<soap:Body>
<findHistoryFileContents xmlns="http://www.outsystems.com">
<historyId>long</historyId>
</findHistoryFileContents>
</soap:Body>
</soap:Envelope>
5.1.13.1.1.2 REST
identifier
04/05/2023 60
findHistoryFileContentsReturn Base 64 Ficheiros anexos ao tratamento da reclamação (.zip

com ficheiros)

5.1.13.2.1.1 SOAP
<soap:Body>
<findHistoryFileContentsResponse xmlns="http://www.outsystems.com">
<findHistoryFileContentsReturn>base64Binary</findHistoryFileContentsRetur
n>
</findHistoryFileContentsResponse>
</soap:Body>
</soap:Envelope>
5.1.13.2.1.2 REST
BinaryData
FindIdentificationNumbersByDate
Obtém a lista de identificadores das reclamações efetuadas no dia identificado.
NOTA: Este serviço será descontinuado pelo que deve utilizador o FindComplaintsBetweenDatesV2.

date DATETIME Data em que deseja realizar a consulta

5.1.14.1.1.1 SOAP
<soap:Body>
<findIdentificationNumbersByDate xmlns="http://www.outsystems.com">
<date>dateTime</date>
</findIdentificationNumbersByDate>
</soap:Body>
</soap:Envelope>
5.1.14.1.1.2 REST
2014-12-31T23:59:59.938Z
04/05/2023 61
/Formato
findIdentificationNumbersByDateReturn CHAR[] 20 Lista de números de
série identificadores
das reclamações no
intervalo de datas
41
5.1.14.2.1.1 SOAP
<soap:Body>
<findIdentificationNumbersByDateResponse
<findIdentificationNumbersByDateReturn>
</findIdentificationNumbersByDateReturn>
</findIdentificationNumbersByDateResponse>
</soap:Body>
</soap:Envelope>
5.1.14.2.1.2 REST
{
"Ids": [
{
"Value": ""
}
]
}
GetComplaintPdf
Obtém o comprovativo associado à reclamação identificada.

/Formato
reclamação

5.1.15.1.1.1 SOAP
04/05/2023 62
<soap:Body>
<getComplaintPdf xmlns="http://www.outsystems.com">
</getComplaintPdf>
</soap:Body>
</soap:Envelope>
5.1.15.1.1.2 REST
{
"Value": ""
}

/Formato
fileName CHAR 75 Nome do ficheiro
fileExtension CHAR 50 Extensão do ficheiro
file Base 64 Ficheiro em formato binário, com a
codificação especificada
code CHAR Código de resposta de sucesso ou erro
message CHAR Mensagem associada ao status enviado

5.1.15.2.1.1 SOAP
<soap:Body>
<getComplaintPdfResponse xmlns="http://www.outsystems.com">
<getComplaintPdfReturn>
<appMobileAttachment>
<file>base64Binary</file>
<fileName>string</fileName>
</appMobileAttachment>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
</getComplaintPdfReturn>
</getComplaintPdfResponse>
</soap:Body>
</soap:Envelope>
5.1.15.2.1.2 REST
{
"appMobileAttachment": {
"file": "string",
"fileExtension": "",
"fileName": ""
},
04/05/2023 63
"Code": "",
"Message": ""
}
}
TransferComplaint
Serviço responsável pela transferência da reclamação.
Pode ser invocado pelas entidades reguladoras/fiscalizadoras, DGC e administrador do portal.
O parâmetro regAuthIdSender apenas será considerado se for invocado com Admin, para indicar qual
a entidade reguladora/fiscalizadora que está a fazer a transferência, caso contrário será ignorado

/Formato
reclamação
internalObs CHAR 2000 Observações internas relativas à
transferência da reclamação
regAuthIdRecipient LONG ID da entidade reguladora para onde
será transferida a reclamação
regAuthIdSender LONG ID da entidade reguladora que vai
transferir a reclamação

regAuthIdRecipient Valor para preenchimento pode ser obtido consultando o
regAuthIdSender Valor para preenchimento pode ser obtido consultando o

5.1.16.1.1.1 SOAP
<soap:Body>
<transferComplaint xmlns="http://www.outsystems.com">
<internalObs>string</internalObs>
<regAuthIdSender>long</regAuthIdSender>
</transferComplaint>
</soap:Body>
</soap:Envelope>
04/05/2023 64
5.1.16.1.1.2 REST
{
"InternalObs": "",
"RegAuthIdRecipient": 1234567891234567,
"RegAuthIdSender": ""
}

code CHAR 10 Código de resposta de sucesso ou erro
message CHAR 200 Mensagem associada ao status enviado
5.1.16.2.1 Exemplo de mensagem de resposta

5.1.16.2.1.1 SOAP
<soap:Body>
<transferComplaintResponse xmlns="http://www.outsystems.com">
<transferComplaintReturn>
<Code>string</Code>
</transferComplaintReturn>
</transferComplaintResponse>
</soap:Body>
</soap:Envelope>
5.1.16.2.1.2 REST
{
"Code": "",
"Message": ""
}
UpdateComplaintStatus
Serviço de atualização de estado de uma reclamação.
Os operadores económicos só poderão alterar a reclamação para o estado de código 2 –

Respondida/tratada de acordo com a configuração atual da tabela de transição de estados.
2
/Formato
reclamação
status CHAR 20 Código do estado
04/05/2023 65
internalObs CHAR 200 Observações internas relativas à
alteração de estado da reclamação
claimantObs CHAR 200 Observações relativas à alteração de
estado da reclamação para apresentar
ao reclamante
file Base 64 Arquivo a ser anexado
fileExtension CHAR 50 Extensão do ficheiro anexado

status Os possíveis estados da reclamação são:
1- Recebida/Em análise
2- Respondida/tratada
3- Em Centro de Arbitragem
4- Análise pela entidade reguladora/fiscalizadora
5- Abertura de processo de contraordenação
6- Encerrado/Arquivado

5.1.17.1.1.1 SOAP
<soap:Body>
<updateComplaintStatus xmlns="http://www.outsystems.com">
<status>string</status>
<internalObs>string</internalObs>
<claimantObs>string</claimantObs>
<fileAttachment>
<Attachment>
<File>string</File>
</Attachment>
<Attachment>
<File>string</File>
</Attachment>
</fileAttachment>
</updateComplaintStatus>
</soap:Body>
</soap:Envelope>
5.1.17.1.1.2 REST
{
"IdentificationNumber": 0,
"status": "",
"internalObs": "",
"claimantObs": "",
"fileAttachment": [
{
"File": "",
"fileExtension": ""
}
04/05/2023 66
]
}

/Formato
code CHAR 10 Código de resposta de sucesso ou erro
message CHAR 200 Mensagem associada ao status enviado

5.1.17.2.1.1 SOAP
<soap:Body>
<updateComplaintStatusResponse xmlns="http://www.outsystems.com">
<updateComplaintStatusReturn>
<Code>string</Code>
</updateComplaintStatusReturn>
</updateComplaintStatusResponse>
</soap:Body>
</soap:Envelope>
5.1.17.2.1.2 REST
{
"Code": "",
"Message": ""
}
04/05/2023 67
5.2 Setores de Atividade
SOAP Produção 2.0 e [URLBase]/ActivitysectorServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_ActivitySectorService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/ActivitySectorServiceRestService/
Testes 2.0
InsertUpdateActivitySector
As Entidades Reguladoras podem gerir os seus setores de Atividade.
Inserir sectores de actividade:
• Para inserir um Setor de Atividade o campo id não deve ser preenchido.

• Se o serviço for invocado pelo administrador, o parâmetro regAuthId é obrigatório.
Alterar Setores de Atividade:
• Para alterar o Setor de Atividade, o campo id é de preenchimento obrigatório.

/Formato
Id LONG 30 Número de identificação do setor de
atividade
name CHAR 200 Nome do setor de atividade
allowsServiceAddress BOOL 1 Define se permite ou não especificar a
morada do serviço
status BOOL 1 Status do setor de atividade (Ativo ou
inativo)
specificHelpEn CHAR 300 Ajuda contextualizada em inglês
specificHelpPt CHAR 300 Ajuda contextualizada em português
specificValueEn CHAR 255 Valor do setor de atividade em inglês
specificValuePt CHAR 255 Valor do setor de atividade em português
regAuthId CHAR 30 Identificador número da Entidade
Reguladora

Id Valor para preenchimento pode ser obtido consultando o
serviço ListActivitySector
regAuthId Valor para preenchimento pode ser obtido consultando o
04/05/2023 68
5.2.1.1.1.1 SOAP
<soap:Body>
<insertUpdateActivitySector xmlns="http://www.outsystems.com">
<activitySectorRequest>
<allowsServiceAddress>boolean</allowsServiceAddress>
<id>long</id>
<name>string</name>
<specificHelpEn>string</specificHelpEn>
<specificHelpPt>string</specificHelpPt>
<specificValueEn>string</specificValueEn>
<specificValuePt>string</specificValuePt>
<status>boolean</status>
</activitySectorRequest>
</insertUpdateActivitySector>
</soap:Body>
</soap:Envelope>
5.2.1.1.1.2 REST
{
"allowsServiceAddress": false,
"id": 1234567891234567,
"name": "",
"regAuthId": 1234567891234567,
"specificHelpEn": "",
"specificHelpPt": "",
"specificValueEn": "",
"specificValuePt": "",
"status": false
}


5.2.1.2.1.1 SOAP
<soap:Body>
<insertUpdateActivitySectorResponse
<insertUpdateActivitySectorReturn>
<Code>string</Code>
</insertUpdateActivitySectorReturn>
</insertUpdateActivitySectorResponse>
</soap:Body>
04/05/2023 69
</soap:Envelope>
5.2.1.2.1.2 REST
{
"Code": "",
"Message": ""
}
ListActivitySector
Os operadores bem como as entidades reguladoras podem consultar a lista dos seus setores de
atividade previamente carregados.
O preenchimento do campo nipc é opcional, conforme o perfil do utilizador autenticado:
Entidades Reguladoras:
• Informar NIPC: O serviço retorna todos os setores de atividade do operador económico

relativo ao NIPC informado.
• Não preencher o campo NIPC: O serviço retorna todos os setores de atividade da entidade
reguladora.
Nota: o campo nipc é enviado por URL. Exemplo: /listActivitySector?nipc={nipc}
Operadores Económicos:
• Não é necessário preencher o campo NIPC, o operador económico pode consultar somente
os setores de atividade associados ao seu perfil.

NIPC CHAR 9 Número de Identificação de Pessoa Coletiva do operador
económico
1
5.2.2.1.1.1 SOAP
<soap:Body>
<listActivitySector xmlns="http://www.outsystems.com">
<nipc>string</nipc>
</listActivitySector>
</soap:Body>
</soap:Envelope>
5.2.2.1.1.2 REST
string
04/05/2023 70
id CHAR 10 Número de identificação do setor de atividade

name CHAR 200 Nome do setor de atividade
externalId CHAR 75 Identificador externo do setor de atividade
especificHelpEn CHAR 300 Ajuda contextualizada em inglês
especificHelpPt CHAR 300 Ajuda contextualizada em português
status NUMBER Status do setor de atividade (Ativo ou inativo)

5.2.2.2.1.1 SOAP
<soap:Body>
<listActivitySectorResponse xmlns="http://www.outsystems.com">
<listActivitySectorReturn>
<activitySectorModelArray>
<ActivitySectorModel>
<externalId>string</externalId>
<id>long</id>
<name>string</name>
</ActivitySectorModel>
<ActivitySectorModel>
<id>long</id>
<name>string</name>
</ActivitySectorModel>
</activitySectorModelArray>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
</listActivitySectorReturn>
</listActivitySectorResponse>
</soap:Body>
</soap:Envelope>
5.2.2.2.1.2 REST
{
"activitySectorModelArray": [
{
"externalId": "",
"id": 1234567891234567,
"name": "",
04/05/2023 71
"specificHelpEn": "",
"specificHelpPt": "",
"status": false
}
],
"Code": "",
"Message": ""
}
}
04/05/2023 72
5.3 Operadores Económicos e Lojas
SOAP Produção 2.0 e [URLBase]/SupplierServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_SupplierService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/SupplierServiceRestService/
Testes 2.0
AddActivitySectors
Adicionar setores de atividade aos operadores/lojas. As entidades reguladoras podem adicionar
setores de atividade aos operadores e respetivas lojas.
Associar setor de atividade:
• Para associar um ou mais setores de atividade, os campos nipc, activitySectors e onlyOperator

devem estar preenchidos.
• O serviço apenas pode ser invocado pelo administrador e entidades
reguladoras/fiscalizadoras.

nipc NUMBER 9 Número de Identificação de Pessoa Coletiva do

operador económico
activitySectors LONG[] Setores de Atividade do estabelecimento
onlyOperator BOOLEAN 1 Parâmetro para definir se deve associar os setores
somente com a loja principal ou com todas as lojas
TRUE – Todos os operadores e lojas;
FALSE – Apenas os operadores

activitySectors Valor para preenchimento pode ser obtido consultando o serviço

ListActivitySector

5.3.1.1.1.1 SOAP
<soap:Body>
<addActivitySectors xmlns="http://www.outsystems.com">
<nipc>string</nipc>
04/05/2023 73
<activitySectors>
<long>long</long>
<long>long</long>
</activitySectors>
<onlyOperator>boolean</onlyOperator>
</addActivitySectors>
</soap:Body>
</soap:Envelope>
5.3.1.1.1.2 REST
{
"nipc": "",
"activitySectors": [
Identifier
]
}


5.3.1.2.1.1 SOAP
<soap:Body>
<addActivitySectorsResponse xmlns="http://www.outsystems.com">
<addActivitySectorsReturn>
<Code>string</Code>
</addActivitySectorsReturn>
</addActivitySectorsResponse>
</soap:Body>
</soap:Envelope>
5.3.1.2.1.2 REST
{
"Code": "",
"Message": ""
}
FindSupplierById
Obtém dados de operador económico pelo seu identificador.

/Formato
ID NUMBER 30 Identificação do operador económico
04/05/2023 74
ID Valor para preenchimento pode ser obtido consultando o serviço
ListSupplier com o parâmetro onlyOperator = 1

5.3.2.1.1.1 SOAP
<soap:Body>
<findSupplierById xmlns="http://www.outsystems.com">
<Id_>long</Id_>
</findSupplierById>
</soap:Body>
</soap:Envelope>
5.3.2.1.1.2 REST
Identifier

Id NUMBER 30 Identificação do operador económico

Name CHAR 160 Designação social do operador económico
Brand CHAR 160 Nome comercial do operador económico
Address CHAR 80 Morada do operador económico
postalCode CHAR 8 Código Postal do operador económico
Location CHAR 75 Localidade do operador económico
Telefone CHAR 15 Telefone do operador económico
Website CHAR 200 URL da página de internet do operador económico
Email CHAR 100 Email do operador económico
Nipc CHAR 75 Número de Identificação de Pessoa Coletiva do
operador económico
StartDate DATETIME Data inicial para o operador económico estar ativo
EndDate DATETIME Data final para o operador económico estar ativo

5.3.2.2.1.1 SOAP
<soap:Body>
<findSupplierByIdResponse xmlns="http://www.outsystems.com">
<findSupplierByIdReturn>
04/05/2023 75
<serviceResponse>
<Code>string</Code>
</serviceResponse>
<supplier>
<id>long</id>
<name>string</name>
<brand>string</brand>
<address>string</address>
<postalCode>string</postalCode>
<location>string</location>
<telephone>string</telephone>
<website>string</website>
<email>string</email>
<nipc>string</nipc>
<startDate>dateTime</startDate>
</supplier>
</findSupplierByIdReturn>
</findSupplierByIdResponse>
</soap:Body>
</soap:Envelope>
5.3.2.2.1.2 REST
{
"Code": "",
"Message": ""
},
"supplier": {
"id": 1234567891234567,
"name": "",
"brand": "",
"address": "",
"postalCode": "",
"location": "",
"telephone": "",
"website": "",
"email": "",
"nipc": "",
"endDate": "2014-12-31T23:59:59.938Z",
"startDate": "2014-12-31T23:59:59.938Z"
}
}
FindSupplierByNIPC
Verifica se o Operador Económico com o Nipc fornecido existe.

nipc CHAR Nipc de operador
económico
04/05/2023 76
5.3.3.1.1.1 SOAP
<soap:Body>
<findSupplierByNIPC xmlns="http://www.outsystems.com">
<nipc>string</nipc>
</findSupplierByNIPC>
</soap:Body>
</soap:Envelope>
5.3.3.1.1.2 REST
string

Code CHAR Mensagem associada ao status enviado
supplierExists Boolean Resultado da pesquisa

5.3.3.2.1.1 SOAP
<soap:Body>
<findSupplierByNIPCResponse xmlns="http://www.outsystems.com">
<findSupplierByNIPCReturn>
<ReturnServicesResponse>
<Code>string</Code>
</ReturnServicesResponse>
<supplierExist>string</supplierExist>
</findSupplierByNIPCReturn>
</findSupplierByNIPCResponse>
</soap:Body>
</soap:Envelope>
5.3.3.2.1.2 REST
{
"ReturnServicesResponse": {
"Code": "",
"Message": ""
},
"supplierExist": ""
}
04/05/2023 77
InsertUpdateOperator
As entidades reguladoras podem gerir os seus operadores.
Inserir Operador Económico:75
• Para inserir um operador económico o campo id não deve ser preenchido.

• Se o serviço for invocado pelo administrador, o preenchimento do campo RegAuthExternalId
é obrigatório.
Alterar Operador Económico:
• Para alterar o operador económico o campo id é de preenchimento obrigatório.

/Formato
Id NUMBER 30 Identificação do operador económico
activitySector LONG[] 255 Setores de Atividade do operador
económico
address CHAR 255 Morada do operador económico
comercialName CHAR 255 Nome comercial do operador económico
email CHAR 100 Email de registo do operador económico
startDate CHAR yyyy-MM-dd Data inicial para o operador estar ativo
HH:mm:ss
endDate CHAR yyyy-MM-dd Data final para o operador estar ativo76
HH:mm:ss
location CHAR 75 Localidade do operador económico
nipc CHAR 9 Número de Identificação de Pessoa
Coletiva do operador económico
notificationEmail CHAR 100 Email de notificação operador económico
postalCode CHAR 30 Código postal do operador económico
regAuthExternalId 60 Identificador externo da entidade
reguladora
searchName CHAR 255 Nome de consulta do operador
económico
socialName CHAR 160 Designação social do operador
económico
telephone CHAR 15 Telefone do operador económico
webSite CHAR 200 URL da página de internet operador
económico

Id Valor para preenchimento pode ser obtido consultando o serviço
04/05/2023 78
activitySector Valor para preenchimento pode ser obtido consultando o serviço
ListActivitySector
regAuthExternalId Valor para preenchimento pode ser obtido consultando o serviço
ListRegulatoryAuthority

5.3.4.1.1.1 SOAP
<soap:Body>
<insertUpdateOperator xmlns="http://www.outsystems.com">
<supplierModel>
<id>long</id>
<activitySector>
<long>long</long>
<long>long</long>
</activitySector>
<comercialName>string</comercialName>
<startDate>string</startDate>
<endDate>string</endDate>
<nipc>string</nipc>
<notificationEmail>string</notificationEmail>
<regAuthExternalId>string</regAuthExternalId>
<searchName>string</searchName>
<socialName>string</socialName>
<webSite>string</webSite>
</supplierModel>
</insertUpdateOperator>
</soap:Body>
</soap:Envelope>
5.3.4.1.1.2 REST
{
"id": 1234567891234567,
"activitySector": [
1234567891234567
],
"address": "",
"comercialName": "",
"email": "",
"startDate": "",
"endDate": "",
"location": "",
"nipc": "",
"notificationEmail": "",
"postalCode": "",
"regAuthExternalId": "",
"searchName": "",
"socialName": "",
"telephone": "",
"webSite": ""
04/05/2023 79
}

/Formato

5.3.4.2.1.1 SOAP
<soap:Body>
<insertUpdateOperatorResponse xmlns="http://www.outsystems.com">
<insertUpdateOperatorReturn>
<Code>string</Code>
</insertUpdateOperatorReturn>
</insertUpdateOperatorResponse>
</soap:Body>
</soap:Envelope>
5.3.4.2.1.2 REST
{
"Code": "",
"Message": ""
}
InsertUpdateStore
Os operadores económicos podem gerir as suas lojas.
Inserir loja:
• Para inserir uma loja o campo id não deve ser preenchido.

• Se o serviço for invocado pelo administrador, o preenchimento do campo nipc é obrigatório.
Alterar loja:
• Para alterar a loja o campo id é de preenchimento obrigatório.

• Não é permitida a alteração do campo sourceSystemIdentifier

/Formato
Id NUMBER 30 Identificação da loja
04/05/2023 80
* Ver Campos com instruções
especiais
Name CHAR 160 Designação da loja
searchTags CHAR 255 Tag para pesquisa da loja
Address CHAR 300 Morada da loja
postalCode CHAR 8 Código Postal da loja
Location CHAR 75 Localidade da loja
Phone CHAR 15 Telefone da loja
Website CHAR 200 URL da página de internet da loja
Email CHAR 100 Email da loja
Status BOOLEAN 1 Status da loja (Ativo ou Inativo)
Nipc CHAR 9 Número de Identificação de Pessoa
Coletiva do operador económico
Sourcesystemid CHAR Identificador interno da loja. Valor
conhecido pelo utilizador que
invoca o serviço que serve como
mapeamento entre o LRE e o
sistema invocador.
* Este campo APENAS existe em
invocações REST nesta versão do
serviço. Consultar
InsertUpdateStoreV2 para ter
disponível este campo em
invocações SOAP
startDate CHAR yyyy-MM-dd Data inicial para a loja estar ativa
HH:mm:ss
endDate CHAR yyyy-MM-dd Data final para a loja estar ativa
HH:mm:ss


5.3.5.1.1.1 SOAP
<soap:Body>
<insertUpdateStore xmlns="http://www.outsystems.com">
<supplierStoreModelRequest>
<id>long</id>
<name>string</name>
<nipc>string</nipc>
<phone>string</phone>
04/05/2023 81
<searchTags>string</searchTags>
</supplierStoreModelRequest>
</insertUpdateStore>
</soap:Body>
</soap:Envelope>
5.3.5.1.1.2 REST
{
"address": "",
"email": "",
"endDate": "",
"id": 1234567891234567,
"location": "",
"name": "",
"nipc": "",
"phone": "",
"postalCode": "",
"searchTags": "",
"startDate": "",
"status": false,
"website": "",
"sourcesystemid": ""
}

/Formato

5.3.5.2.1.1 SOAP
<soap:Body>
<insertUpdateStoreResponse xmlns="http://www.outsystems.com">
<insertUpdateStoreReturn>
<Code>string</Code>
</insertUpdateStoreReturn>
</insertUpdateStoreResponse>
</soap:Body>
</soap:Envelope>
5.3.5.2.1.2 REST
{
"Code": "",
"Message": ""
04/05/2023 82
}
InsertUpdateStoreV2
Nota: Método disponível APENAS na versão 2.0 dos serviços
Os operadores económicos podem gerir as suas lojas.
Inserir loja:
• Para inserir uma loja o campo id não deve ser preenchido.

• Se o serviço for invocado pelo administrador, o preenchimento do campo nipc é obrigatório.
Alterar loja:
• Para alterar a loja o campo id é de preenchimento obrigatório.

• Não é permitida a alteração do campo sourceSystemIdentifier

/Formato
Id NUMBER 30 Identificação da loja
especiais
Name CHAR 160 Designação da loja
searchTags CHAR 255 Tag para pesquisa da loja
Address CHAR 300 Morada da loja
postalCode CHAR 8 Código Postal da loja
Location CHAR 75 Localidade da loja
Phone CHAR 15 Telefone da loja
Website CHAR 200 URL da página de internet da loja
Email CHAR 100 Email da loja
Status BOOLEAN 1 Status da loja (Ativo ou Inativo)
Nipc CHAR 9 Número de Identificação de
Pessoa Coletiva do operador
económico
Sourcesystemid CHAR Identificador interno da loja. Valor
conhecido pelo utilizador que
invoca o serviço que serve como
mapeamento entre o LRE e o
sistema invocador.
startDate CHAR yyyy-MM-dd Data inicial para a loja estar ativa
HH:mm:ss
endDate CHAR yyyy-MM-dd Data final para a loja estar ativa
HH:mm:ss
04/05/2023 83

5.3.6.1.1.1 SOAP
<soap:Body>
<insertUpdateStoreV2 xmlns="http://www.outsystems.com">
<supplierStoreModelRequest>
<id>long</id>
<name>string</name>
<nipc>string</nipc>
<phone>string</phone>
<searchTags>string</searchTags>
<sourcesystemid>string</sourcesystemid>
</supplierStoreModelRequest>
</insertUpdateStoreV2>
</soap:Body>
</soap:Envelope>

/Formato

5.3.6.2.1.1 SOAP
<soap:Body>
<insertUpdateStoreResponse xmlns="http://www.outsystems.com">
<insertUpdateStoreReturn>
<Code>string</Code>
</insertUpdateStoreReturn>
</insertUpdateStoreResponse>
04/05/2023 84
</soap:Body>
</soap:Envelope>
ListSupplier
Obtém lista de operadores/lojas associados ao utilizador que invoca o serviço.
• Informar NIPC: O serviço retorna as lojas associadas ao NIPC indicado.

• Não preencher o campo NIPC: O serviço retorna as lojas da Entidade Reguladora.
as lojas associadas ao seu perfil.
O serviço possui o limite de até 100 lojas por chamada.

nipc CHAR 75 Número de Identificação de Pessoa Coletiva do
operador
onlyOperator INT 1 Parâmetro para definir se deve retornar somente
operadores ou os operadores e lojas associadas.
0 – Todos os operadores e lojas;
1 – Apenas os operadores
begin NUMBER 30 Valor do início da paginação de estabelecimentos
end NUMBER 30 Valor final da paginação de estabelecimentos

5.3.7.1.1.1 SOAP
<soap:Body>
<listSupplier xmlns="http://www.outsystems.com">
<nipc>string</nipc>
<onlyOperator>int</onlyOperator>
<begin>int</begin>
<end>int</end>
</listSupplier>
</soap:Body>
</soap:Envelope>
04/05/2023 85
5.3.7.1.1.2 REST
{
"nipc": "",
"onlyOperator": 0,
"begin": 0,
"end": 0
}

id NUMBER 30 Identificação do operador económico/loja
brand CHAR 160 Designação comercial do operador económico/loja
name CHAR 160 Designação social do operador económico/loja
operador económico/loja
status BOOLEAN Estado do operador económico/loja
sourceSystemId CHAR Identificador interno do operador/loja. Valor
conhecido pelo utilizador que invoca o serviço que
serve como mapeamento entre o LRE e o sistema
invocador.
* Este campo APENAS existe em invocações REST
nesta versão do serviço. Consultar ListSupplierV2
para obter este campo em invocações SOAP
count NUMBER 30 Total de registos retornados na consulta

5.3.7.2.1.1 SOAP
<soap:Body>
<listSupplierResponse xmlns="http://www.outsystems.com">
<listSupplierReturn>
<count>int</count>
<listSupplierArray>
<STR_ListSupplier>
<id>long</id>
<name>string</name>
<nipc>string</nipc>
</STR_ListSupplier>
<STR_ListSupplier>
<id>long</id>
<name>string</name>
<nipc>string</nipc>
</STR_ListSupplier>
</listSupplierArray>
<serviceResponse>
<Code>string</Code>
04/05/2023 86
</serviceResponse>
</listSupplierReturn>
</listSupplierResponse>
</soap:Body>
</soap:Envelope>
5.3.7.2.1.2 REST
{
"count": 0,
"listSupplierArray": [
{
"brand": "",
"id": 1234567891234567,
"name": "",
"nipc": "",
"status": false,
"sourceSystemId": ""
}
],
"Code": "",
"Message": ""
}
}
ListSupplierV2
Nota: Método disponível APENAS na versão 2.0 dos serviços
Obtém lista de operadores/lojas associados ao utilizador que invoca o serviço. Versão do serviço
APENAS disponível em SOAP.
• Informar NIPC: O serviço retorna as lojas associadas ao NIPC indicado.

• Não preencher o campo NIPC: O serviço retorna as lojas da Entidade Reguladora.
as lojas associadas ao seu perfil.
O serviço possui o limite de até 100 lojas por chamada.

04/05/2023 87
operador
onlyOperator INT 1 Parâmetro para definir se deve retornar somente
operadores ou os operadores e lojas associadas.
0 – Todos os operadores e lojas;
1 – Apenas os operadores
begin NUMBER 30 Valor do início da paginação de estabelecimentos
end NUMBER 30 Valor final da paginação de estabelecimentos

5.3.8.1.1.1 SOAP
<soap:Body>
<listSupplier xmlns="http://www.outsystems.com">
<nipc>string</nipc>
<onlyOperator>int</onlyOperator>
<begin>int</begin>
<end>int</end>
</listSupplier>
</soap:Body>
</soap:Envelope>

id NUMBER 30 Identificação do operador económico/loja
brand CHAR 160 Designação comercial do operador económico/loja
name CHAR 160 Designação social do operador económico/loja
operador económico/loja
status BOOLEAN Estado do operador económico/loja
sourceSystemId CHAR Identificador interno do operador/loja. Valor
conhecido pelo utilizador que invoca o serviço que
serve como mapeamento entre o LRE e o sistema
invocador.
count NUMBER 30 Total de registos retornados na consulta

5.3.8.2.1.1 SOAP
<soap:Body>
<listSupplierV2Response xmlns="http://www.outsystems.com">
<listSupplierReturn>
<count>int</count>
<listSupplierArray>
04/05/2023 88
<STR_ListSupplierAction>
<id>long</id>
<name>string</name>
<nipc>string</nipc>
<sourceSystemId>string</sourceSystemId>
</STR_ListSupplierAction>
<STR_ListSupplierAction>
<id>long</id>
<name>string</name>
<nipc>string</nipc>
</STR_ListSupplierAction>
</listSupplierArray>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
</listSupplierReturn>
</listSupplierV2Response>
</soap:Body>
</soap:Envelope>
ListSupplierNipcs
Obtém a listagem de operadores registados no intervalo de datas indicado.

Nome campo Tipo Tam. Máx. /Formato Observações
beginDate DATETIME Data de Inicio
endDate DATETIME Data de fim
Begin Number Pagina de inicio
end Number Pagina final

5.3.9.1.1.1 SOAP
<soap:Body>
<listSupplierNipcs xmlns="http://www.outsystems.com">
<beginDate>string</beginDate>
<begin>int</begin>
<end>int</end>
</listSupplierNipcs>
</soap:Body>
</soap:Envelope>
04/05/2023 89
5.3.9.1.1.2 REST
{
"StartDate": "",
"EndDate": "",
"begin": 0,
"end": 0
}

Nome campo Tipo Tam. Máx. Observações
/Formato
operatorNipcList[] CHAR 75 Lista de NIPC’s do operador económico
Code CHAR
message CHAR Código de resposta de sucesso ou erro
total Number Mensagem associada ao status enviado

5.3.9.2.1.1 SOAP
<soap:Body>
<listSupplierNipcsResponse xmlns="http://www.outsystems.com">
<listSupplierNipcsReturn>
<operatorNipcList>
</operatorNipcList>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
<total>long</total>
</listSupplierNipcsReturn>
</listSupplierNipcsResponse>
</soap:Body>
</soap:Envelope>
5.3.9.2.1.2 REST
{
"operatorNipcList": [
""
],
"Code": "",
"Message": ""
},
"total": 1234567891234567
}
04/05/2023 90
5.4 Motivos
SOAP Produção 2.0 e [URLBase]/BusinessConceptServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_BusinessConceptService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/BusinessConceptServiceRestService/
Testes 2.0
FindByActivitySectorOrNipc
Obtém a lista de motivos associados ao sector de atividade ou NIPC indicado.
O preenchimento dos campos nipc e activitySectorId são opcionais, conforme o perfil do utilizador
autenticado:
• Informar somente NIPC: O serviço retorna todos os motivos associados aos setores de
atividade do operador económico relativo ao NIPC informado.
• Informar somente activitySectorId: O serviço retorna somente os motivos associados ao setor
de atividade informado.
• Não preencher informações para os campos NIPC e activitySectorId: O serviço retorna todos
os motivos associados aos setores de atividade da entidade reguladora.
• Não é necessário preencher o campo NIPC, o operador económico somente pode consultar
os motivos associados ao seu perfil.
• Informar somente activitySectorId: O serviço retorna somente os motivos associados ao setor
de atividade informado para o operador económico.
• Não preencher informações para os campos NIPC e activitySectorId: O serviço retorna todos
os motivos associados aos setores de atividade do operador económico.

Nome campo Tipo Tam. Máx. Observações
/Formato
activitySectorId Number 10 Identificação do setor de atividade
nipc CHAR 9 Número do NIPC do operador económico
type CHAR Identifica o tipo de motivos a consultar

activitySectorId Valor para preenchimento pode ser obtido consultando o serviço
ListActivitySector
type Valores disponíveis:
COMPLAINT
04/05/2023 91
INFO_REQUEST

5.4.1.1.1.1 SOAP
<soap:Body>
<findByActivitySectorOrNipc xmlns="http://www.outsystems.com">
<activitySectorId>long</activitySectorId>
<nipc>string</nipc>
<type>string</type>
</findByActivitySectorOrNipc>
</soap:Body>
</soap:Envelope>
5.4.1.1.1.2 REST
{
"activitySectorId": 1234567891234567,
"nicp": "",
"type": ""
}

id NUMBER 30 Identificação do Motivo
namePt CHAR 100 Título do Motivo (Português)
helpPt CHAR 200 Texto de ajuda do Motivo (Português)
nameEn CHAR 100 Título do Motivo (Inglês)
helpEn CHAR 200 Texto de ajuda do Motivo (Inglês)

5.4.1.2.1.1 SOAP
<soap:Body>
<findByActivitySectorOrNipcResponse
<findByActivitySectorOrNipcReturn>
<businessConcepts>
<BusinessConcept>
<helpEn>string</helpEn>
<helpPt>string</helpPt>
<id>long</id>
<nameEn>string</nameEn>
<namePt>string</namePt>
<parentBusinessConceptId>long</parentBusinessConceptId>
04/05/2023 92
</BusinessConcept>
<BusinessConcept>
<helpEn>string</helpEn>
<helpPt>string</helpPt>
<id>long</id>
<nameEn>string</nameEn>
<namePt>string</namePt>
<parentBusinessConceptId>long</parentBusinessConceptId>
</BusinessConcept>
</businessConcepts>
<Code>string</Code>
</findByActivitySectorOrNipcReturn>
</findByActivitySectorOrNipcResponse>
</soap:Body>
</soap:Envelope>
5.4.1.2.1.2 REST
{
"businessConcepts": [
{
"helpEn": "",
"helpPt": "",
"id": 1234567891234567,
"nameEn": "",
"namePt": "",
"parentBusinessConceptId": 1234567891234567
}
],
"Code": "",
"Message": ""
}
}
InsertOrUpdate
As Entidades Reguladoras podem gerir os seus motivos secundários e terciários. Os motivos primários
não podem ser inseridos ou alterados.
Inserir Motivos:
a inserir um motivo o campo businessConceptId não deve ser preenchido.

o serviço for invocado pelo administrador, o campo regAuthExternalId é de preenchimento obrigatório.
motivo será inserido para o setor de atividade informado no campo activitySectorId.
Alterar Motivos:
• Para alterar o motivo o campo businessConceptId é de preenchimento obrigatório.

• Os campos priority e businessConceptType não podem ser alterados.
04/05/2023 93
activitySectorId LONG 30 Identificador do setor de atividade
businessConceptId LONG 30 Identificação do motivo
businessConceptType CHAR 100 Tipo do motivo a ser inserido
Description CHAR 300 Descrição do motivo em português
description_EN CHAR 300 Descrição do motivo em inglês
Priority INTEGER 30 Prioridade do motivo (2 ou 3)
Status BOOLEAN 1 Status do motivo (Ativo ou inativo)
Title CHAR 255 Título do motivo em português
title_EN CHAR 255 Título do motivo em inglês
regAuthExternalId CHAR 75 Identificador externo da entidade
reguladora

activitySectorId Valor para preenchimento pode ser obtido consultando o
serviço ListActivitySector
businessConceptId Valor para preenchimento pode ser obtido consultando o
serviço FindByActivitySectororNipc com parâmetro Type =
COMPLAINT
businessConceptType Valores disponíveis:
COMPLAINT
INFO_REQUEST
regAuthExternalId Valor para preenchimento pode ser obtido consultando o

5.4.2.1.1.1 SOAP
<soap:Body>
<insertOrUpdate xmlns="http://www.outsystems.com">
<businessConceptRequest>
<activitySectorId>long</activitySectorId>
<businessConceptId>long</businessConceptId>
<businessConceptType>string</businessConceptType>
<description>string</description>
<description_EN>string</description_EN>
<regAuthExternalId>string</regAuthExternalId>
<title>string</title>
<title_EN>string</title_EN>
</businessConceptRequest>
</insertOrUpdate>
04/05/2023 94
</soap:Body>
</soap:Envelope>
5.4.2.1.1.2 REST
{
"activitySectorId": 1234567891234567,
"businessConceptId": 1234567891234567,
"businessConceptType": "",
"description": "",
"description_EN": "",
"priority": 0,
"regAuthExternalId": "",
"status": false,
"title": "",
"title_EN": ""
}

Nome campo Tipo Tam. Máx. /Formato Observações

5.4.2.2.1.1 SOAP
<soap:Body>
<insertOrUpdateResponse xmlns="http://www.outsystems.com">
<insertOrUpdateReturn>
<Code>string</Code>
</insertOrUpdateReturn>
</insertOrUpdateResponse>
</soap:Body>
</soap:Envelope>
5.4.2.2.1.2 REST
{
"Code": "",
"Message": ""
}
04/05/2023 95
5.5 Valores de Motivo
SOAP Produção 2.0 e [URLBase]/BusinessConceptValueServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_BusinessConceptValueService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/BusinessConceptValueServiceRestService/
Testes 2.0
Obtém lista de valores de motivos associados ao motivo identificado.

businessConceptId Number 30 Identificação do

motivo
* Ver Campos com

businessConceptId Valor para preenchimento pode ser obtido

consultando o serviço
FindByActivitySectororNipc com parâmetro
Type = COMPLAINT

5.5.1.1.1.1 SOAP
<soap:Body>
<findByBusinessConceptId xmlns="http://www.outsystems.com">
</findByBusinessConceptId>
</soap:Body>
</soap:Envelope>
5.5.1.1.1.2 REST
Identifier

id NUMBER 30 Identificação do Valor de Motivo
04/05/2023 96
status NUMBER 1 Estado (Ativo ou inativo)
valuePt VARCHAR 255 Nome em português do valor do
motivo
valueEn VARCHAR 255 Nome em inglês do valor do
motivo
sourceSystemId VARCHAR 75 Identificador interno do valor de
motivo
externalId VARCHAR 75 Identificador externo do valor de
motivo
parentBusinessConceptValueId NUMBER 30 Identificador do valor de motivo
pai/superior
complaintTimeToAnswer NUMBER 30 Tempo de resposta para as
reclamações
Code CHAR Código de resposta de sucesso ou
erro
Message CHAR Mensagem associada ao status
enviado

5.5.1.2.1.1 SOAP
<soap:Body>
<findByBusinessConceptIdResponse xmlns="http://www.outsystems.com">
<findByBusinessConceptIdReturn>
<businessConceptValueArray>
<BusinessConceptValue>
<id>long</id>
<valuePt>string</valuePt>
<valueEn>string</valueEn>
<SourceSystemId>string</SourceSystemId>
<parentBusinessConceptValueId>long</parentBusinessConceptValueId>
<complaintTimeToAnswer>int</complaintTimeToAnswer>
</BusinessConceptValue>
<BusinessConceptValue>
<id>long</id>
<SourceSystemId>string</SourceSystemId>
<complaintTimeToAnswer>int</complaintTimeToAnswer>
</BusinessConceptValue>
</businessConceptValueArray>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
</findByBusinessConceptIdReturn>
04/05/2023 97
</findByBusinessConceptIdResponse>
</soap:Body>
</soap:Envelope>
5.5.1.2.1.2 REST
{
"businessConceptValueArray": [
{
"id": 1234567891234567,
"status": false,
"valuePt": "",
"valueEn": "",
"SourceSystemId": "",
"externalId": "",
"parentBusinessConceptValueId": 1234567891234567,
"complaintTimeToAnswer": 0
}
],
"Code": "",
"Message": ""
}
}
AddUpdateBusinessConceptValue
As Entidades Reguladoras podem gerir os seus valores de motivo.
O Administrador e a DGC podem gerir os valores de motivos de qualquer entidade.
Inserir Valores de Motivo:
• Para inserir um valor de motivo o campo Id não deve ser preenchido.

• Os restantes campos são de preenchimento obrigatório.
• O valor de motivo será inserido e associado com o motivo informado no campo
businessConceptId.
Alterar Valores de Motivo:
• Para alterar o motivo o campo Id é de preenchimento obrigatório.
91
id NUMBER 75 Identificação do valor de motivo
especiais
parentBusinessConceptValueId Number 30 Identificação do valor de motivo
do nível superior
especiais
businessConceptId Number 30 Identificação do motivo
04/05/2023 98
especiais
valuePt CHAR 200 Descrição do valor de motivo
valueEn CHAR 200 Descrição do valor de motivo em
inglês
status BOOLEAN 1 Estado (Ativo ou inativo)

complaintTimeToAnswear Number 30 Tempo máximo de resposta para
uma reclamação com o motivo
associado

id Valor(es) para preenchimento pode(m) ser obtido(s) da
seguinte forma:
COMPLAINT
2. Consultar os valores de motivo para cada Motivo
obtido acima (em 1) através do serviço
parentBusinessConceptValueId Valor(es) para preenchimento pode(m) ser obtido(s) da
seguinte forma:
COMPLAINT
2. Consultar os valores de motivo para cada Motivo obtido
acima (em 1) através do serviço
businessConceptId Valor para preenchimento pode ser obtido consultando o
serviço FindByActivitySectororNipc com parâmetro Type =
COMPLAINT

5.5.2.1.1.1 SOAP
<soap:Body>
<addUpdateBusinessConceptValue xmlns="http://www.outsystems.com">
<businessConceptValueModel>
<id>long</id>
<complaintTimeToAnswer>long</complaintTimeToAnswer>
04/05/2023 99
</businessConceptValueModel>
</addUpdateBusinessConceptValue>
</soap:Body>
</soap:Envelope>
5.5.2.1.1.2 REST
{
"id": 1234567891234567,
"parentBusinessConceptValueId": 1234567891234567,
"businessConceptId": 1234567891234567,
"valuePt": "",
"valueEn": "",
"complaintTimeToAnswer": 1234567891234567,
"status": false
}

5.5.2.2.1 Exemplo de mensagem de resposta

5.5.2.2.1.1 SOAP
<soap:Body>
<addUpdateBusinessConceptValueResponse
<addUpdateBusinessConceptValueReturn>
<Code>string</Code>
</addUpdateBusinessConceptValueReturn>
</addUpdateBusinessConceptValueResponse>
</soap:Body>
</soap:Envelope>
5.5.2.2.1.2 REST
{
"Code": "",
"Message": ""
}
04/05/2023 100
5.6 Utilizadores
SOAP Produção 2.0 e [URLBase]/UserProfilesServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_UserProfilesService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/UserProfilesServiceRestService/
Testes 2.0
GetAvaiableProfiles
Obtém a lista de perfis existentes no portal.
Não é preciso preencher campos na mensagem de envio. Os perfis serão apresentados de acordo com
o utilizador autenticado.

Sem campos.

5.6.1.1.1.1 SOAP:
<soap:Body>
<getAvaiableProfiles xmlns="http://www.outsystems.com" />
</soap:Body>
</soap:Envelope>

/Formato
id CHAR 30 Identificação do perfil
name CHAR 75 Designação do perfil
description CHAR 400 Texto descritivo da permissão associada ao perfil
5
5.6.1.2.1.1 SOAP
<soap:Body>
<getAvaiableProfilesResponse xmlns="http://www.outsystems.com">
<getAvaiableProfilesReturn>
<Code>string</Code>
04/05/2023 101
<userProfiles>
<UserProfiles>
<id>long</id>
<name>string</name>
</UserProfiles>
<UserProfiles>
<id>long</id>
<name>string</name>
</UserProfiles>
</userProfiles>
</getAvaiableProfilesReturn>
</getAvaiableProfilesResponse>
</soap:Body>
</soap:Envelope>
5.6.1.2.1.2 REST
{
"Code": "",
"Message": ""
},
"userProfiles": [
{
"description": "",
"id": 1234567891234567,
"name": ""
}
]
}
GetUsersByStoreId
Os operadores económicos podem consultar os seus utilizadores.

/Formato
storeId LONG 30 Identificação interna do operador económico
Campos com intruções especiais:

storeId Valor para preenchimento pode ser obtido consultando o serviço

5.6.2.1.1.1 SOAP
04/05/2023 102
<soap:Body>
<getUsersByStoreId xmlns="http://www.outsystems.com">
<storeId>string</storeId>
</getUsersByStoreId>
</soap:Body>
</soap:Envelope>
5.6.2.1.1.2 REST
string

active boolean Estado do utilizador
email CHAR 75 Email do utilizador
id LONG 30 Identificador interno do utilizador
name CHAR 150 Nome e apelido do utilizador
userRoles CHAR[] Permissões do utilizador no estabelecimento

5.6.2.2.1.1 SOAP
<soap:Body>
<getUsersByStoreIdResponse xmlns="http://www.outsystems.com">
<getUsersByStoreIdReturn>
<Code>string</Code>
<userProfiles>
<StoreUser>
<isActive>boolean</isActive>
<id>string</id>
<name>string</name>
<userRoles xsi:nil="true" />
</StoreUser>
<StoreUser>
<isActive>boolean</isActive>
<id>string</id>
<name>string</name>
<userRoles xsi:nil="true" />
</StoreUser>
</userProfiles>
</getUsersByStoreIdReturn>
</getUsersByStoreIdResponse>
</soap:Body>
04/05/2023 103
</soap:Envelope>
5.6.2.2.1.2 REST
{
"Code": "",
"Message": ""
},
"userProfiles": [
{
"isActive": false,
"email": "",
"id": "",
"name": "",
"userRoles": [
""
]
}
]
}
InsertUpdateUser
Os operadores económicos podem gerir os seus utilizadores e respetivos dados.
Inserir Utilizador:
• Para inserir um utilizador o campo userId não deve ser preenchido.

• Se o serviço for invocado pelo administrador, o campo operatorId é de preenchimento
obrigatório.
Alterar Utilizador:
• Para alterar o utilizador o campo userId deve ser preenchido.

/Formato
userId LONG 30 Identificação interna do utilizador
firstname CHAR 75 Nome do utilizador
lastname CHAR 75 Apelido do utilizador
email CHAR 75 Email de autenticação do utilizador
status BOOLEAN 1 Estado do utilizador (Ativo ou inativo)
operatorId LONG 30 Identificação interna do operador

04/05/2023 104
userId Valor para preenchimento pode ser obtido consultando o serviço
GetUsersByStoreId
operatorId Valor para preenchimento pode ser obtido consultando o serviço

5.6.3.1.1.1 SOAP
<soap:Body>
<insertUpdateUser xmlns="http://www.outsystems.com">
<InputStoreUser>
<FirstName>string</FirstName>
<LastName>string</LastName>
<UserId>long</UserId>
<Status>boolean</Status>
<OperatorId>long</OperatorId>
</InputStoreUser>
</insertUpdateUser>
</soap:Body>
</soap:Envelope>
5.6.3.1.1.2 REST
{
"FirstName": "",
"LastName": "",
"Email": "",
"UserId": 1234567891234567,
"Status": false,
"OperatorId": 1234567891234567
}


5.6.3.2.1.1 SOAP
<soap:Body>
<insertUpdateUserResponse xmlns="http://www.outsystems.com">
<insertUpdateUserReturn>
<Code>string</Code>
</insertUpdateUserReturn>
04/05/2023 105
</insertUpdateUserResponse>
</soap:Body>
</soap:Envelope>
5.6.3.2.1.2 REST
{
"Code": "",
"Message": ""
}
RemoveUserProfiles
Remove permissões do utilizador identificado.

userId CHAR 30 Identificação interna do utilizador
storeId CHAR 30 Identificação do estabelecimento
userProfiles CHAR[] 10 Identificação do(s) perfil(is)

GetUsersByStoreId
userProfiles Valor para preenchimento pode ser obtido consultando o
GetAvaiableProfiles

5.6.4.1.1.1 SOAP
<soap:Body>
<removeUserProfiles xmlns="http://www.outsystems.com">
<StoreUserProfile>
<userId>string</userId>
<userProfiles>
</userProfiles>
</StoreUserProfile>
</removeUserProfiles>
</soap:Body>
</soap:Envelope>
5.6.4.1.1.2 REST
{
04/05/2023 106
"userId": "",
"storeId": "",
"userProfiles": [
""
]
}


5.6.4.2.1.1 SOAP
<soap:Body>
<removeUserProfilesResponse xmlns="http://www.outsystems.com">
<removeUserProfilesReturn>
<Code>string</Code>
</removeUserProfilesReturn>
</removeUserProfilesResponse>
</soap:Body>
</soap:Envelope>
5.6.4.2.1.2 REST
{
"Code": "",
"Message": ""
}
SetUserProfiles
Os operadores económicos podem adicionar perfis aos seus utilizadores.

userId CHAR 30 Identificação interna do utilizador

storeId CHAR 30 Identificação do estabelecimento
Profiles CHAR[] 10 Identificação do(s) perfil(is)

04/05/2023 107
GetUsersByStoreId
storeId Valor para preenchimento pode ser obtido consultando o serviço
Profiles Valor para preenchimento pode ser obtido consultando o
GetAvaiableProfiles

5.6.5.1.1.1 SOAP
<soap:Body>
<setUserProfiles xmlns="http://www.outsystems.com">
<StoreUserProfile>
<userId>string</userId>
<userProfiles>
</userProfiles>
</StoreUserProfile>
</setUserProfiles>
</soap:Body>
</soap:Envelope>
5.6.5.1.1.2 REST
{
"userId": "",
"storeId": "",
"userProfiles": [
""
]
}


5.6.5.2.1.1 SOAP
<soap:Body>
<setUserProfilesResponse xmlns="http://www.outsystems.com">
<setUserProfilesReturn>
<Code>string</Code>
04/05/2023 108
</setUserProfilesReturn>
</setUserProfilesResponse>
</soap:Body>
</soap:Envelope>
5.6.5.2.1.2 REST
{
"Code": "",
"Message": ""
}
04/05/2023 109
5.7 Entidades Reguladoras
SOAP Produção 2.0 e [URLBase]/RegulatoryAuthorityServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_RegulatoryAuthorityService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/RegulatoryAuthorityServiceRestService/
Testes 2.0
ListRegulatoryAuthority
Os operadores económicos, entidades reguladoras, o administrador do portal e a DGC podem
consultar a listagem com todas as entidades reguladoras disponíveis na plataforma. Para invocar o
serviço não é preciso preencher campos na mensagem de envio.

Sem campos.

5.7.1.1.1.1 SOAP
<soap:Body>
<listRegulatoryAuthority xmlns="http://www.outsystems.com" />
</soap:Body>
</soap:Envelope>

Nome campo Tipo Tam. Máx./ Observações
Formato
id LONG ID da entidade reguladora/fiscalizadora
name CHAR 255 Nome da entidade reguladora/fiscalizadora
sourceSystemId CHAR 75 SourceSystemId da entidade

5.7.1.2.1.1 SOAP5
<soap:Body>
<listRegulatoryAuthorityResponse xmlns="http://www.outsystems.com">
<listRegulatoryAuthorityReturn>
<regulatoryAuthoritys>
04/05/2023 110
<STR_RegulatoryAuthority>
<Id>long</Id>
<name>string</name>
</STR_RegulatoryAuthority>
<STR_RegulatoryAuthority>
<Id>long</Id>
<name>string</name>
</STR_RegulatoryAuthority>
</regulatoryAuthoritys>
<response>
<Code>string</Code>
</response>
</listRegulatoryAuthorityReturn>
</listRegulatoryAuthorityResponse>
</soap:Body>
</soap:Envelope>
5.7.1.2.1.2 REST
{
"regulatoryAuthoritys": [
{
"Id": 1234567891234567,
"name": "",
"sourceSystemId": ""
}
],
"response": {
"Code": "",
"Message": ""
}
}
04/05/2023 111
5.8 Estados de Reclamação
SOAP Produção 2.0 e [URLBase]/ComplaintStateServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_ComplaintStateService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/ComplaintStateServiceRestService/
Testes 2.0
ListComplaintState
Consultar os possíveis estados a atribuir à reclamação.
De acordo com a configuração atual, os possíveis códigos e estados da reclamação são:
4- Análise pela entidade reguladora/fiscalizadora
108
• Os campos stateId e entityType são opcionais de preenchimento. Se não forem preenchidos,

o serviço retorna todos os estados possíveis para a reclamação.
• Se o campo stateId for preenchido, serão retornados os estados possíveis a atribuir à
reclamação conforme o perfil do utilizador.

Nome campo Tipo Tam.Máx. / Observações
Formato
stateId LONG 30 Código do estado
* Ver Campos com
entityType CHAR 35 Tipo do perfil do utilizador
* Ver Campos com

stateId Valores possíveis:

4- Análise pela entidade
04/05/2023 112
entityType Valores disponíveis:
operator
regulatory-authority

5.8.1.1.1.1 SOAP
<soap:Body>
<listComplaintState xmlns="http://www.outsystems.com">
<stateId>long</stateId>
<entityType>string</entityType>
</listComplaintState>
</soap:Body>
</soap:Envelope>
5.8.1.1.1.2 REST
{
"StateId": 1234567891234567,
"EntityType": ""
}

/Formato
stateId LONG 30 Código do estado
stateDescription CHAR 75 Descrição do estado

5.8.1.2.1.1 SOAP
<soap:Body>
<listComplaintStateResponse xmlns="http://www.outsystems.com">
<listComplaintStateReturn>
<listComplaintState>
<ComplaintStateModelResponse>
<stateDescription>string</stateDescription>
</ComplaintStateModelResponse>
<ComplaintStateModelResponse>
<stateDescription>string</stateDescription>
</ComplaintStateModelResponse>
04/05/2023 113
</listComplaintState>
<Code>string</Code>
</listComplaintStateReturn>
</listComplaintStateResponse>
</soap:Body>
</soap:Envelope>
5.8.1.2.1.2 REST
{
"listComplaintState": [
{
"stateDescription": "",
"stateId": 1234567891234567
}
],
"Code": "",
"Message": ""
}
}
04/05/2023 114
5.9 Pedido de Informação
SOAP Produção 2.0 e [URLBase]/InformationRequestServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_InformationRequestService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/InformationRequestServiceRestService/
Testes 2.0
Consulta por número de identificação do pedido de Informação.

/Formato
identificationNumbers CHAR [] 20 Número de série identificador do
Pedido de Informação

5.9.1.1.1.1 SOAP
<soap:Body>
<findByIdentificationNumbers xmlns="http://www.outsystems.com">
</findByIdentificationNumbers>
</soap:Body>
</soap:Envelope>
5.9.1.1.1.2 REST
{
"Ids": [
{
"Value": ""
}
]
}
111
Nome campo Tipo Tam. Observações
Máx.
Dados do address CHAR 100 Morada do
Consumidor consumidor
04/05/2023 115
(concatenação de
street, door e
floor)
country CHAR 75 País do
consumidor
Door CHAR 10 Número da porta
do consumidor
Email CHAR 100 Email do
consumidor
consumidor
código postal do
consumidor
consumidor
telefone do
consumidor
consumidor
consumidor2
identificação civil
do consumidor
identificação do
consumidor
consumidor
telemóvel do
consumidor
identificação fiscal
do consumidor
Dados do numberOfUploadedDocuments NUMBER 30 Número de
Pedido de documentos
Informação anexados ao
pedido de
informação pelo
consumidor
fileContent BASE 64 Conteúdo do
ficheiro anexo
(.zip dos anexos)
question CHAR 2000 Questão do
pedido de
informação
04/05/2023 116
primaryKey NUMBER 30 Chave primária do
pedido de
informação
regulatoryAuthorityActivitySector CHAR 200 Sector de
atividade sobre o
qual incide o
pedido de
informação
regulatoryAuthoritySourceSystemId CHAR 75 sourceSystemId
da Entidade
Reguladora sobre
a qual incide o
pedido de
informação
identificationNumber CHAR 75 Número de série
identificador do
pedido de
informação
identificação do
pedido de
informação
createDate TIMESTAMP Data de criação
do pedido de
informação
único –
descontinuado
uploadedDocumentPath CHAR 75 Caminho para o
documento
anexado –
descontinuado
Dados dos businessConceptSourceSystemId CHAR 75 sourceSystemId
motivos do do motivo
pedido de associado ao valor
informação de motivo pelo
[] consumidor
businessConceptValueSourceSystemId NUMBER 30 sourceSystemId
do valor de
motivo
selecionado pelo
consumidor
valueEn CHAR 75 Nome em inglês
do valor de
motivo
selecionado pelo
consumidor
português do
valor de motivo
04/05/2023 117
selecionado pelo
consumidor
único
Id NUMBER Identificador do
valor de motivo
selecionado pelo
consumidor
primaryKey NUMBER Chave primária do
valor de motivo
selecionado pelo
consumidor

5.9.1.2.1.1 SOAP
<soap:Body>
<findByIdentificationNumbersResponse
<findByIdentificationNumbersReturn>
<InformationRequestSoap>
<country>string</country>
<door>string</door>
<familyName>string</familyName>
<street>string</street>
<floor>string</floor>
<givenName>string</givenName>
<identityCardNumber>string</identityCardNumber>
<identityCardType>string</identityCardType>
<mobile>string</mobile>
<nif>string</nif>
<numberOfUploadedDocuments>int</numberOfUploadedDocuments>
<fileContent>base64Binary</fileContent>
<question>string</question>
<regulatoryAuthorityActivitySector>string</regulatoryAuthorityActivitySec
tor>
<regulatoryAuthoritySourceSystemId>string</regulatoryAuthoritySourceSyste
mId>
<id>long</id>
<uuid>string</uuid>
<uploadedDocumentPath>string</uploadedDocumentPath>
<informationRequestTaxonomies>
04/05/2023 118
</informationRequestTaxonomies>
</InformationRequestSoap>
<door>string</door>
<nif>string</nif>
tor>
mId>
<id>long</id>
<uuid>string</uuid>
</findByIdentificationNumbersReturn>
</findByIdentificationNumbersResponse>
</soap:Body>
</soap:Envelope>
5.9.1.2.1.2 REST
[
{
"address": "",
"country": "",
"door": "",
"email": "",
"familyName": "",
"postalCode": "",
"street": "",
"telephone": "",
"floor": "",
"givenName": "",
"identityCardNumber": "",
"identityCardType": "",
"location": "",
"mobile": "",
04/05/2023 119
"nif": "",
"numberOfUploadedDocuments": 0,
"fileContent": "string",
"question": "",
"primaryKey": 1234567891234567,
"regulatoryAuthorityActivitySector": "",
"regulatoryAuthoritySourceSystemId": "",
"id": 1234567891234567,
"createDate": "2014-12-31T23:59:59.938Z",
"uuid": "",
"uploadedDocumentPath": "",
"informationRequestTaxonomies": [
{
"ValueEn": "",
"ValuePt": "",
"Uuid": "",
"Id": 1234567891234567,
"PrimaryKey": 1234567891234567
}
]
}
]
FindFileContents
Consulta de anexos associados ao pedido de informação identificado.

Nome campo Tipo Tam. Máx. / Observações
Formato
identificationNumber CHAR 20 Número de série identificador do pedido de
informação

5.9.2.1.1.1 SOAP
<soap:Body>
<findFileContents xmlns="http://www.outsystems.com">
</findFileContents>
</soap:Body>
</soap:Envelope>
5.9.2.1.1.2 REST
string

/Formato
04/05/2023 120
findFileContentsReturn Base 64 Ficheiros anexos ao pedido de
informação (.zip com os ficheiros)

5.9.2.2.1.1 SOAP
<soap:Body>
<findFileContentsResponse xmlns="http://www.outsystems.com">
<findFileContentsReturn>base64Binary</findFileContentsReturn>
</findFileContentsResponse>
</soap:Body>
</soap:Envelope>
5.9.2.2.1.2 REST
BinaryData
Consultar dados do pedido de informação por número de identificação.

/Formato
identificationNumbers CHAR [] 20 Número de série
identificador do pedido de
informação

5.9.3.1.1.1 SOAP
<soap:Body>
<findFullDataByIdentificationNumbers
</findFullDataByIdentificationNumbers>
</soap:Body>
</soap:Envelope>
5.9.3.1.1.2 REST
{
"Ids": [
{
"Value": ""
04/05/2023 121
}
]
}

.
Dados do Address CHAR 100 Morada do
Consumido consumidor
r (concatenação
de street, door
e floor)
Country CHAR 75 País do
consumidor
Door CHAR 10 Número da
porta do
consumidor
Email CHAR 100 Email do
consumidor
consumidor
código postal
do consumidor
consumidor
telefone do
consumidor
consumidor
consumidor
identificação
civil do
consumidor
identificação
do consumidor
consumidor
telemóvel do
consumidor
identificação
fiscal do
consumidor
numberOfUploadedDocuments NUMBER 30 Nº de
documentos
04/05/2023 122
anexados ao
pedido de
informação
pelo
consumidor
Dados do fileContent BASE 64 Conteúdo do
Pedido de ficheiro anexo
Informação (.zip com
anexos)
question CHAR 2000 Questão do
pedido de
informação
primaryKey NUMBER 30 Chave primária
do pedido de
informação
regulatoryAuthorityActivitySector CHAR 200 Sector de
atividade sobre
o qual incide o
pedido de
informação
regulatoryAuthoritySourceSystemId CHAR 75 sourceSystemI
d da Entidade
Reguladora
sobre a qual
incide o pedido
de informação
identificationNumber CHAR 75 Número de
série
identificador
do pedido
de informação
identificação
do
pedido de
informação
createDate TIMESTAM Data de criação
P do pedido de
informação
único
uploadedDocumentPath CHAR 75 Caminho para
o documento
anexado –
descontinuado
Dados dos businessConceptSourceSystemId CHAR 75 sourceSystemI
motivos do d do motivo
pedido de associado ao
informação valor de motivo
[] selecionado
04/05/2023 123
pelo
consumidor
businessConceptValueSourceSystemI NUMBER 30 sourceSystemI
d d
do valor de
motivo
selecionado
pelo
consumidor
valueEn CHAR 75 Nome em
inglês do valor
de motivo
selecionado
pelo
consumidor
português do
valor de motivo
selecionado
pelo
consumidor
único
Id NUMBER Identificador
do valor de
motivo
selecionado
pelo
consumidor
primaryKey NUMBER Chave primária
do valor de
motivo
selecionado
pelo
consumidor

5.9.3.2.1.1 SOAP
<soap:Body>
<findFullDataByIdentificationNumbersResponse
<findFullDataByIdentificationNumbersReturn>
04/05/2023 124
<door>string</door>
<nif>string</nif>
tor>
mId>
<id>long</id>
<uuid>string</uuid>
<door>string</door>
<nif>string</nif>
tor>
mId>
<id>long</id>
04/05/2023 125
<uuid>string</uuid>
</findFullDataByIdentificationNumbersReturn>
</findFullDataByIdentificationNumbersResponse>
</soap:Body>
</soap:Envelope>
5.9.3.2.1.2 REST
[
{
"address": "",
"country": "",
"door": "",
"email": "",
"familyName": "",
"postalCode": "",
"street": "",
"telephone": "",
"floor": "",
"givenName": "",
"identityCardNumber": "",
"identityCardType": "",
"location": "",
"mobile": "",
"nif": "",
"numberOfUploadedDocuments": 0,
"fileContent": "string",
"question": "",
"primaryKey": 1234567891234567,
"regulatoryAuthorityActivitySector": "",
"regulatoryAuthoritySourceSystemId": "",
"id": 1234567891234567,
"createDate": "2014-12-31T23:59:59.938Z",
"uuid": "",
"uploadedDocumentPath": "",
"informationRequestTaxonomies": [
{
"ValueEn": "",
"ValuePt": "",
"Uuid": "",
"Id": 1234567891234567,
"PrimaryKey": 1234567891234567
}
]
}
]
Consultar pedidos de informação por data.
04/05/2023 126
findIdentificationNumbersByDate DATETIME Data da solicitação do pedido de informação

5.9.4.1.1.1 SOAP
<soap:Body>
<findIdentificationNumbersByDate xmlns="http://www.outsystems.com">
<date>dateTime</date>
</findIdentificationNumbersByDate>
</soap:Body>
</soap:Envelope>
5.9.4.1.1.2 REST
2014-12-31T23:59:59.938Z

findIdentificationNumbersByDateResponse CHAR [] Lista de números de série identificadores dos

pedidos de informação

5.9.4.2.1.1 SOAP
<soap:Body>
<findIdentificationNumbersByDateResponse
<findIdentificationNumbersByDateReturn>
</findIdentificationNumbersByDateReturn>
</findIdentificationNumbersByDateResponse>
</soap:Body>
</soap:Envelope>
5.9.4.2.1.2 REST
{
"Ids": [
{
"Value": ""
}
]
}
04/05/2023 127
GetInformationRequestPdf
Obtém comprovativo associado a pedido de informação indicado.

identificationNumber CHAR 75 Número de série identificador do pedido de
informação

5.9.5.1.1.1 SOAP
<soap:Body>
<getInformationRequestPdf xmlns="http://www.outsystems.com">
</getInformationRequestPdf>
</soap:Body>
</soap:Envelope>
5.9.5.1.1.2 REST
string


fileExtension CHAR Extensão do ficheiro
file Base 64 Ficheiro em formato binário, com a codificação
especificada
code CHAR Código de resposta de sucesso ou erro26

5.9.5.2.1.1 SOAP
<soap:Body>
<getInformationRequestPdfResponse xmlns="http://www.outsystems.com">
<getInformationRequestPdfReturn>
<serviceResponse>
<Code>string</Code>
04/05/2023 128
</serviceResponse>
</getInformationRequestPdfReturn>
</getInformationRequestPdfResponse>
</soap:Body>
</soap:Envelope>
5.9.5.2.1.2 REST
{
"file": "string",
"fileName": ""
},
"Code": "",
"Message": ""
}
}
04/05/2023 129
5.10 Elogio e Sugestão
SOAP Produção 2.0 e [URLBase]/ComplimentSuggestionServiceSoapService.asmx
Testes 2.0
Produção 1.0 e [URLBase]/Plugin_PUC_ComplimentSuggestionService?wsdl
Testes 1.0 -
descontinuado
REST Produção 2.0 e [URLBase]/rest/ComplimentSuggestionServiceRestService/
Testes 2.0
GetComplimentSuggestionPdf
Obtém comprovativo associado a elogio/sugestão identificado.

identificationNumber CHAR 75 Número de série identificador do

elogio/sugestão

5.10.1.1.1.1 SOAP
<soap:Body>
<getComplimentSuggestionPdf xmlns="http://www.outsystems.com">
</getComplimentSuggestionPdf>
</soap:Body>
</soap:Envelope>
5.10.1.1.1.2 REST
string


fileExtension CHAR Extensão do ficheiro
file Base 64 Ficheiro em formato binário, com a codificação
especificada
code CHAR Código de resposta de sucesso ou erro26

5.10.1.2.1.1 SOAP
04/05/2023 130
<soap:Body>
<getComplimentSuggestionPdfResponse
<getComplimentSuggestionPdfReturn>
<serviceResponse>
<Code>string</Code>
</serviceResponse>
</getComplimentSuggestionPdfReturn>
</getComplimentSuggestionPdfResponse>
</soap:Body>
</soap:Envelope>
5.10.1.2.1.2 REST
{
"file": "string",
"fileName": ""
},
"Code": "",
"Message": ""
}
}
FindComplimentsSuggestionsBetweenDates
Obtém lista de elogios/sugestões no intervalo de datas identificados.

beginDate DATETIME Data inicial para
pesquisar
sugestões/elogios
endDate DATETIME Data final para
pesquisar
sugestões/elogios
Page_Start Number Pagina Inicial
Page_End Number Pagina Final

5.10.2.1.1.1 SOAP
04/05/2023 131
<soap:Body>
<getComplimentsBetweenDates xmlns="http://www.outsystems.com">
<InputData>
<Begin_Date>dateTime</Begin_Date>
<End_Date>dateTime</End_Date>
<Page_Start>int</Page_Start>
<Page_End>int</Page_End>
</InputData>
</getComplimentsBetweenDates>
</soap:Body>
</soap:Envelope>
5.10.2.1.1.2 REST
{
"Begin_Date": "2014-12-31T23:59:59.938Z",
"End_Date": "2014-12-31T23:59:59.938Z",
"Page_Start": 0,
"Page_End": 0
}

complaintIds CHAR[] 20 Lista de números de série identificadores
dos elogios/sugestões no intervalo de
datas

5.10.2.2.1.1 SOAP
<soap:Body>
<getComplimentsBetweenDatesResponse
<findComplaintsBetweenDatesReturn>
<complaintIds>
</complaintIds>
<response>
<Code>string</Code>
</response>
</findComplaintsBetweenDatesReturn>
</getComplimentsBetweenDatesResponse>
</soap:Body>
</soap:Envelope>
04/05/2023 132
5.10.2.2.1.2 REST
{
"complimentIds": {
"Ids": [
{
"Value": ""
}
]
},
"response": {
"Code": "",
"Message": ""
}
}
GetFullDataFromRequestNumbers
Obtém lista de dados de elogio(s)/sugestão(ões) associado(s) a número(s) de identificação.

RequestNumbers Text[] 50 Lista de números de
série identificadores de
elogios/sugestões

5.10.3.1.1.1 SOAP
<soap:Body>
<GetFullDataFromRequesrNrs xmlns="http://www.outsystems.com">
<RequestNumbers>
<STR_String>
<Value>string</Value>
</STR_String>
<STR_String>
<Value>string</Value>
</STR_String>
</RequestNumbers>
</GetFullDataFromRequesrNrs>
</soap:Body>
</soap:Envelope>
5.10.3.1.1.2 REST
{
"Ids": [
{
"Value": ""
}
]
}
04/05/2023 133
Detalhe ActivitySector CHAR 50 Setor de Atividade – não aplicável
do IdentificationNumber CHAR 50 Número de série identificador do
Pedido elogio/sugestão
ServiceAdress CHAR 50 Morada de serviço – não aplicável
ServiceDoorNumber CHAR 50 Nº Porta – não aplicável
ServiceFloorNumber CHAR 50 Andar – não aplicável
ServiceCity CHAR 50 Localidade – não aplicável
ServicePostalCode CHAR 50 Código Postal – não aplicável
Description CHAR 2000 Descrição do elogio/sugestão
AdditionalInformationValue CHAR 100 Informação Adicional – não
aplicável
AssociatedRequestNumber CHAR 100 Nº do Pedido Associado – não
aplicável
RequestDate DateTime Data do pedido
RequestExpirationDate DateTime Data de expiração
RequestType CHAR 50 Tipo de Pedido (Elogio/Sugestão)
RequestStatus CHAR 50 Estado do Pedido
BusinessConceptValuePrimary CHAR 50 Valor de motivo primário – não
aplicável
BusinessConceptValueSecondary CHAR 50 Valor de motivo secundário – não
aplicável
BusinessConceptValueTerciary CHAR 50 Valor de motivo terciário – não
aplicável
IsTransfered Boolean Pedido é transferido? – não
aplicável
RequestOrigin CHAR 50 Origem do Pedido – não aplicável
IsPaper Boolean 50 Reclamação é em papel? – não
aplicável
PaperSubmitedBy CHAR 50 Entidade que submeteu o pedido
– não aplicável
ProcessNumber CHAR 50 Nº de Processo – não aplicável
ReceptionDate DateTime Data de Recepção – não aplicável
Detalhe FirstName CHAR 50 Nome do Consumidor
do LastName CHAR 50 Apelido do Consumidor
Consumid Email CHAR 50 Email do Consumidor
or Telephone CHAR 50 Telefone do Consumidor
Nationality CHAR 50 Nacionalidade do Consumidor
VATNumber CHAR 50 VAT do Consumidor
IsVATNumberPT Boolean VAT é Português
IdentificationType CHAR 50 Tipo de Identificação
Address CHAR 50 Morada
DoorNumber CHAR 50 Nº de Porta
FloorNumber CHAR 50 Andar
City CHAR 50 Localidade
PostalCode CHAR 50 Código Postal do Consumidor
Country CHAR 50 País do Consumidor
Name CHAR 50 Nome do Operador
NIPC CHAR 50 VAT do Operador
04/05/2023 134
IsNIPCPT Boolean VAT é Português
Address CHAR 50 Morada do Operador
DoorNumber CHAR 50 Nº de Porta
Detalhe
City CHAR 50 Localidade do Operador
do
PostalCode CHAR 50 Código Postal do Operador
Operador
Telephone CHAR 50 Telefone do Operador
FaxNumber CHAR 50 Nº Fax do Operador
Website CHAR 50 Website do Operador
ExternalIdentifier CHAR 50 Identificador Externo
Histórico NewRequestStatus CHAR 50 Novo Estado do Pedido
do RequestMessage CHAR 2000 Mensagem
Pedido[] Consumer CHAR 50 VAT Consumidor
RegulatoryAuthority CHAR 50 Entidade Reguladora
EconomicOperator CHAR 50 Operador económico
OperationDate CHAR 50 Data da Operação
BusinessConceptPrimary CHAR 50 Motivo Primário
BusinessConceptValuePrimary CHAR 50 Valor de Motivo Primário
BusinessConceptSecondary CHAR 50 Motivo secundário
BusinessConceptValueSecondary CHAR 50 Valor de Motivo secundário
BusinessConceptTerciary CHAR 50 Motivo Terciário
BusinessConceptValueTerciary CHAR 50 Valor de Motivo Terciário
IsMessageVisibleToConsumer Boolean Mensagem é Visivel para o
Consumidor
Detalhe Name CHAR 50 Nome da Loja
da Loja Address CHAR 50 Morada da Loja
DoorNumber CHAR 50 Porta
PostalCode CHAR 50 Código Postal
City CHAR 50 Localidade
Telephone CHAR 50 Telefone
FaxNumber CHAR 50 Fax
ExternalIdentifier CHAR 50 Identificador Externo

5.10.3.2.1.1 SOAP
<soap:Body>
<GetFullDataFromRequesrNrsResponse xmlns="http://www.outsystems.com">
<ReturnData>
<ComplimentReturn>
<STR_ComplimentReturn>
<Request xsi:nil="true" />
<Consumer xsi:nil="true" />
<Operator xsi:nil="true" />
<RequestHistory xsi:nil="true" />
<Store xsi:nil="true" />
</STR_ComplimentReturn>
04/05/2023 135
<STR_ComplimentReturn>
<Request xsi:nil="true" />
<Consumer xsi:nil="true" />
<Operator xsi:nil="true" />
<RequestHistory xsi:nil="true" />
<Store xsi:nil="true" />
</STR_ComplimentReturn>
</ComplimentReturn>
<ServiceResponse>
<Code>string</Code>
</ServiceResponse>
</ReturnData>
</GetFullDataFromRequesrNrsResponse>
</soap:Body>
</soap:Envelope>
5.10.3.2.1.2 REST
[
{
"ComplimentReturn": [
{
"Request": {
"ActivitySector": "",
"ServiceDoorNumber": "",
"ServiceFloorNumber": "",
"ServiceCity": "",
"Description": "",
"AdditionalInformationValue": "",
"AssociatedRequestNumber": "",
"RequestDate": "2014-12-31T23:59:59.938Z",
"RequestExpirationDate": "2014-12-31T23:59:59.938Z",
"RequestType": "",
"RequestStatus": "",
"BusinessConceptValuePrimary": "",
"BusinessConceptValueSecondary": "",
"BusinessConceptValueTerciary": "",
"IsTransfered": false,
"RequestOrigin": "",
"IsPaper": false,
"PaperSubmitedBy": "",
"ProcessNumber": "",
"ReceptionDate": "2014-12-31T23:59:59.938Z"
},
"Consumer": {
"FirstName": "",
"LastName": "",
"Email": "",
"Telephone": "",
"Nationality": "",
"VATNumber": "",
"IsVATNumberPT": false,
"IdentificationType": "",
"Address": "",
"DoorNumber": "",
"FloorNumber": "",
"City": "",
"PostalCode": "",
04/05/2023 136
"Country": ""
},
"Operator": {
"Name": "",
"NIPC": "",
"IsNIPCPT": false,
"Address": "",
"DoorNumber": "",
"FloorNumber": "",
"City": "",
"PostalCode": "",
"Telephone": "",
"FaxNumber": "",
"Website": "",
"ExternalIdentifier": ""
},
"RequestHistory": [
{
"NewRequestStatus": "",
"RequestMessage": "",
"Consumer": "",
"RegulatoryAuthority": "",
"EconomicOperator": "",
"OperationDate": "2014-12-31T23:59:59.938Z",
"BusinessConceptPrimary": "",
"BusinessConceptValuePrimary": "",
"BusinessConceptSecondary": "",
"BusinessConceptValueSecondary": "",
"BusinessConceptTerciary": "",
"BusinessConceptValueTerciary": "",
"IsMessageVisibleToConsumer": false
}
],
"Store": {
"Name": "",
"Address": "",
"DoorNumber": "",
"FloorNumber": "",
"PostalCode": "",
"City": "",
"Telephone": "",
"FaxNumber": "",
"ExternalIdentifier": ""
}
}
],
"ServiceResponse": {
"Code": "",
"Message": ""
}
}
]
04/05/2023 137
6 Diagrama de invocação de serviços
Esta secção tem como intuito apresentar os vários serviços existentes, assim como a ordem de
invocação dos mesmos (com as devidas dependências).
6.1 Reclamações
1º Nível de invocação 2º Nível de Invocação 3º Nível de invocação
findByIdentificationumbers
findComplaintByNumber
FindComplaintHistory; FindHistoryFileContent
FindComplaintHistoryV2 s
FindFileContents
FindComplaintsBetweenDatesV
2 FindFullDataByIdentificationNumber
s
GetComplaintPdf
TransferComplaint
UpdateComplaintStatus
addUpdateComplaint
editComplaintPaper
Exemplos:
Exemplo 1: Pretende-se obter a lista de reclamações e seus detalhes (detalhe da reclamação,

comprovativo, anexos e histórico) de um determinado dia.
1- Invocar serviço FindComplaintsBetweenDatesV2, preenchendo os campos necessários, de

forma a obter a lista de reclamações associadas. Este serviço devolve os identificadores das
reclamações dentro do período pesquisado.
2- Invocar serviço FindComplaintByNumber para obter os detalhes da reclamação (operador,
loja, reclamante, histórico de reclamação, motivos e anexos)
Exemplo 2: Pretende-se actualizar o estado de uma reclamação.
1- Invocar o serviço UpdateComplaintStatus com o novo estado de reclamação (sendo possível

inserir um comentário visível ao consumidor através do campo claimantObs). O identificador
da reclamação pode ser obtido através dos serviços identificados no exemplo anterior
04/05/2023 138
6.2 Setores de Atividade
1º Nível de invocação 2º Nível de Invocação
ListActivitySector InsertUpdateActivitySector
6.3 Operadores Económicos e Lojas

ListSupplier FindSupplierById
ListSupplierNipcs FindSupplierByNIPC
AddActivitySectors
InsertUpdateOperator
InsertUpdateStore
6.4 Motivos
Sem dependências.
6.5 Valores de Motivo

Sem dependências.
6.6 Utilizadores
RemoveUserProfiles
GetAvaiableProfiles; GetUsersByStoreId
SetUserProfiles
GetUsersByStoreId InsertUpdateUser
6.7 Entidades Reguladoras

Sem dependências.
6.8 Estados de Reclamação

Sem dependências.
6.9 Pedidos de Informação

FindFileContents
GetInformationRequestPdf
04/05/2023 139
6.10 Elogios e Sugestões
GetComplimentSuggestionPdf
GetComplimentsBetweenDates
GetFullDataFromRequestNrs
04/05/2023 140
7 Mensagens
Os códigos e mensagens de retorno vão seguir um padrão de 3 caracteres com uma mensagem
associada.
Código Mensagem
200 O pedido foi realizado com sucesso
501 Não encontrado
502 O Utilizador não possui permissão de acesso
700 Erro durante a realização da operação, por favor contactar a equipa de suporte
701 Erro ao anexar o ficheiro, verificar o base64 informado
702 É possível anexar no máximo 3 ficheiros
703 Tamanho do arquivo excede o limite permitido
704 Extensão do Ficheiro é obrigatória
705 Extensão do ficheiro é incompatível
706 Por favor, preencha pelo menos um dos campos
707 Número de resultados excede o limite permitido
708 Parâmetros obrigatórios não informados ou inválidos
709 Erro - deve de existir pelo menos um administrador para o estabelecimento indicado
04/05/2023 141

Manual de Webservices - Livro de Reclamações

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual de Webservices - Livro de Reclamações

Enviado por

Direitos autorais:

Formatos disponíveis

Índice

5.2 Setores de Atividade ............................................................................................................. 68

5.3 Operadores Económicos e Lojas ........................................................................................... 73

5.5 Valores de Motivo ................................................................................................................. 96

5.6 Utilizadores ......................................................................................................................... 101

5.7 Entidades Reguladoras........................................................................................................ 110

5.8 Estados de Reclamação ....................................................................................................... 112

5.9 Pedido de Informação ......................................................................................................... 115

5.10 Elogio e Sugestão ................................................................................................................ 130

6 Diagrama de invocação de serviços ............................................................................................ 138

São disponibilizadas 2 formas de invocação de serviços:

• SOAP (Simple Object Access Protocol);

Produção v2.0 https://livroreclamacoes.pt/LRE_Operators_API/

Produção v1.0 (pré https://livroreclamacoes.pt/puc-incm-app-portlet/api/axis

Nota: esta operação não é necessária em produção.

A entidade integradora pretende ter a seguinte configuração

Deverá fornecer os seguintes dados:

Regras de inserção de reclamação física:

• Campos de preenchimento obrigatório:

Regras de edição de reclamação:

Ao inserir/editar uma reclamação física:

• O campo processNumber não é obrigatório e pode ser repetido;

Campos de mensagem de envio:

Campos com instruções especiais:

Nome do Campo Observações

5.1.1.1.1 Exemplo de mensagem de envio:

Campos de mensagem de resposta:

5.1.1.2.1 Exemplo de mensagem de resposta:

Campos de mensagem de envio:

Campos com instruções especiais:

Nome do Campo Observações

5.1.2.1.1 Exemplo de mensagem de envio:

5.1.2.2.1 Exemplo de mensagem de resposta:

Campos de mensagem de envio:

5.1.3.1.1 Exemplo de mensagem de envio:

5.1.3.1.2 Campos de mensagem de resposta:

5.1.3.1.3 Exemplo de mensagem de resposta:

Campos de mensagem de envio:

5.1.4.1.1 Exemplo de mensagem de envio:

5.1.4.1.2 Campos de mensagem de resposta:

5.1.4.1.3 Exemplo de mensagem de resposta:

Campos de mensagem de envio:

complaintNumber Text 20 Número de série

5.1.5.1.1 Exemplo de mensagem de envio:

Campos de mensagem de resposta:

5.1.5.2.1 Exemplo de mensagem de resposta:

Campos de mensagem de envio:

5.1.6.1.1 Exemplo de mensagem de envio:

storeName Text 160 Designação comercial

complaintText Text 2000 Texto da reclamação

5.1.6.2.1 Exemplo de mensagem de resposta:

Campos de mensagem de envio:

5.1.7.1.1 Exemplo de mensagem de envio:

Campos de mensagem de resposta:

5.1.7.2.1 Exemplo de mensagem de resposta:

Campos de mensagem de envio:

5.1.8.1.1 Exemplo de mensagem de envio:

Campos de mensagem de resposta:

5.1.8.2.1 Exemplo de mensagem de resposta:

Campos de mensagem de envio:

5.1.9.1.1 Exemplo de mensagem de envio:

Campos de mensagem de resposta:

5.1.9.2.1 Exemplo de mensagem de resposta:

A resposta do serviço é paginada. O máximo de resultados por página será de 100.