Nesta página são especificados os tipos de dados (data types) comuns definidos para os elementos das mensagens que não foram incluídos nas definições das operações.
Data attributes or Name of Array |
Mandatory/Optional |
Field Type |
Array Type |
Notes/Service Specific Business Rules |
succeeded |
M |
boolean |
No |
Indica se a operação foi invocada com sucesso. |
error |
O |
Complex
ErrorType |
No |
No caso de invocações em sucesso da operação (succeeded = false) este elemento providencia mais detalhe acerca da falha ocorrida.
Verificar a estrutura deste elemento aqui. |
Data attributes or Name of Array |
Mandatory/Optional |
Field Type |
Array Type |
Notes/Service Specific Business Rules |
code |
M |
string |
No |
Código (normalizado) do erro ocorrido. |
message |
M |
string |
No |
Mensagem (normalizada) do erro ocorrido. |
detail |
O |
anyType |
No |
Elemento que fornece mais detalhe acerca do erro ocorrido. |
source |
O |
string |
No |
Elemento que permite identificar o componente de código no qual o erro teve origem. |
native |
O |
Complex
|
Yes
0..* |
Este elemento permite agregar informação sobre a falha ocorrida de forma não normalizada, ou seja tal como retirado dos sistemas de back-end.
Verificar a estrutura deste elemento aqui.
|
Data attributes or Name of Array |
Mandatory/Optional |
Field Type |
Array Type |
Notes/Service Specific Business Rules |
code |
M |
string |
No |
Código não normalizado do erro ocorrido, tal como extraído dos sistemas de back-end. |
message |
M |
string |
No |
Mensagem não normalizada do erro ocorrido, tal como extraída dos sistemas de back-end. |
detail |
O |
anyType |
No |
Elemento que fornece mais detalhe acerca do erro ocorrido nos sistemas de back-end. Pode incluir stack traces. |
source |
O |
string |
No |
Elemento que permite identificar o componente de código no sistema de back-end no qual o erro teve origem |