Search in this section

Child pages
  • Message Element

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
titleColor#FFFFFF
titleBGColor#E44313
titleTable of contents

Table of Contents
outlinetrue
stylenone


Description

The message component element defines a message which belongs to the result. This message is returned within the result of the response.

Structure

KeyOccursFormatDescription
msg


msg / code1String

The request type code to which the message belongs.

msg / text1StringThe text of the message.
msg / object1SimpleObject ( Component )

The object to which the message refers to.

XML

-

Example

Code Block
languagexml
titleXML Example
linenumberstrue
<msg>
	<code>EF4001001</code>
 	<text>Certificate could not be found.</text>
	<object>
		<type>certificate</type>
		<value>domain.com</value>
	</object>
</msg>

Code Example

Code Block
languagejava
titleWhere Component Java
linenumberstrue
@XmlRootElement(name = "msg")
public class Message {

    @XmlElement(name="code")
    private String code;

    @XmlElement(name="text")
    private String text;

	@XmlElement(name="object")
    private SimpleObject object;

  	/* Getter + Setter */

}
Code Block
languagephp
titleWhere Component PHP
linenumberstrue
class Message {

    /**
     *
     * @var type String
     */
    public $code;

    /**
     *
     * @var type String
     */
    public $text;

    /**
     *
     * @var type SimpleObject
     */
    public $object;

  	/* Getter + Setter */

}
Code Block
languagec#
titleWhere Component C#
linenumberstrue
public class Message {

    private String code;

    private String text;

    private SimpleObject object;

	/* Getter + Setter */

}