Estrutura dos parâmetros de saída

Estrutura dos parâmetros de saída

Campo
Descrição
Observações

Soap Header

Cabeçalho do envelope SOAP

+ RelatesTo

Identificador do pedido

Soap Body

Corpo do envelope SOAP

+ EV_*_Response

Tag root da resposta ao pedido de evidência

++ Identificador

Identificador da resposta

Por norma, este identificador é um GUID.

++ Entidade Emissora

Dados da entidade emissora da evidência

+++ Identificador

Identificador da entidade emissora

+++ Nome

Nome da entidade emissora

++ LocalEmissao

Dados do local de emissão da evidência

+++ Nome

Nome do local de emissão da evidência

++ EvEstruturada

Evidência em formato estruturado

No caso de a evidência ser em formato XML, a mesma deve ser incluída dentro desta tag.

Caso a evidência não seja no formato xml, esta tag deverá ser null.

++ SuporteDigital

Dados do tipo de conteúdo da evidência

+++ Tipo

Formato dos dados

Formatos:

• Text/xml

• Application/pdf

+++ Dados

Conteúdo codificado em base64 (só nos casos em que devolve uma evidência no formato pdf)

No caso da evidência ser no formato application/pdf, o mesmo deve ser codificado em base64 e colocado nesta tag.

Exemplo de Resposta (diploma do secundário no formato xml)

<soapenv:Envelope 
      xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
      xmlns:tem="http://tempuri.org/"
>
      <soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
            <wsa:RelatesTo>01c8cb73-8265-4149-90a7-5eb1425824a5</wsa:RelatesTo>
      </soapenv:Header>
      <soapenv:Body>
            <EV_DiplomaSecundario_Response>
                  <Identificador>987654321</Identificador>
                  <EntidadeEmissora>
                        <Identificador>123456789</Identificador>
                        <Nome>Nome da Entidade Emissora</Nome>
                  </EntidadeEmissora>
                  <DataEmissao>1986-01-01</DataEmissao>
                  <LocalEmissao>
                        <Nome>Local de Emissão da evidência</Nome>
                  </LocalEmissao>
                  <EvEstruturada>
                        <Titulo>Diploma do secundário</Titulo>
                        <Identificador>173767383737836</Identificador>
                        <Nacionalidade>Portuguesa</Nacionalidade>
                        <DataNascimento>1970-01-01</DataNascimento>
                        <UltimoNome>Silva</UltimoNome>
                        <PrimeiroNome>Manuel</PrimeiroNome>
                        <NomeMae>Silva Ana</NomeMae>
                        <NomePai>Silva José</NomePai>
                        <LocalNascimento>Lisboa</LocalNascimento>
                        <Genero>M</Genero>
                        <Media>13</Media>
                  </EvEstruturada>
                  <SuporteDigital>
                        <Tipo>text/xml</Tipo>
                        <Dados></Dados>
                  </SuporteDigital>
            </EV_DiplomaSecundario_Response>
      </soapenv:Body>
</soapenv:Envelope>

Exemplo de Resposta (diploma secundário no formato pdf)

<soapenv:Envelope 
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:tem="http://tempuri.org/"
>
        <soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
                <wsa:RelatesTo>01c8cb73-8265-4149-90a7-5eb1425824a5</wsa:RelatesTo>
        </soapenv:Header>
        <soapenv:Body>
                <EV_DiplomaSecundario_Response>
                        <Identificador>987654321</Identificador>
                        <EntidadeEmissora>
                                <Identificador>123456789</Identificador>
                                <Nome>Nome da Entidade Emissora</Nome>
                        </EntidadeEmissora>
                        <DataEmissao>1970-01-01</DataEmissao>
                        <LocalEmissao>
                                <Nome>Local de Emissão da evidência</Nome>
                        </LocalEmissao>
                        <EvEstruturada />
                        <SuporteDigital>
                                <Tipo>application/pdf</Tipo>
                                <Dados>(pdf codificado em base64)</Dados>
                        </SuporteDigital>
                </EV_DiplomaSecundario_Response>
        </soapenv:Body>
</soapenv:Envelope>

Last updated