Message Component

Table of contents

Description

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

Structure

Key	Occurs	Format	Description
msg
msg / code	1	String	The request type code to which the message belongs.
msg / text	1	String	The text of the message.
msg / object	1	SimpleObject ( Component )	The object to which the message refers to.

XML-Example

View XML Beispiel

<msg>
	<code>EF4001001</code>
 	<text>Certificate could not be found.</text>
	<object>
		<type>certificate</type>
		<value>domain.com</value>
	</object>
</msg>

Code Example

Where Komponente Java

@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 */

}

Where Komponente PHP

class Message {

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

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

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

  	/* Getter + Setter */

}

Where Komponente C#

public class Message {

    private String code;

    private String text;

    private SimpleObject object;

	/* Getter + Setter */

}