Search in this section

Child pages
  • Task Element
Skip to end of metadata
Go to start of metadata


Table of contents

Description

The task element defines the structure of a task which is sent within a request to the API.

Structure

KeyOccursTypeFormatDescription
code0 - 1String

The code of the request type

reply_to0 - 1String
The subuser
email_confirmation0 - 1String 

The successful receipt of the request is confirmed by way of email.

ctid0 - 1String
The client transaction ID
execdate0 - 1Date

Execution timestamp. Format: yyyy-MM-dd HH:mm:ss

demo0 - 1Boolean

Demo mode

  • 1 = Demo mode active
  • 0 = Demo mode inactive
certificate0 - nCertificate ( Object )
The certificate object for requests
contact0 - nContact ( Object )
The contact object for requests

XML Example

XML Example
<task>
    <code>400101</code>
    <reply_to>john.doe@domain.com</reply_to>
	<email_confirmation>john.doe@domain.com</email_confirmation>
	<ctid>ABC123456</ctid>
	<execdate>2019-01-01 09:00:00</execdate>
	<demo>1</demo>
	<certificate>
	...
	</certificate>
</task>

Code Example

Where Component Java
@XmlRootElement(name = "task")
public class Task {

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

    @XmlElement(name="reply_to")
    private String replyTo;

    @XmlElement(name="email_confirmation")
    private String emailConfirmation;

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

    @XmlElement(name="execdate")
    private Date execDate;

    @XmlElement(name="certificate")
    private List<Certificate> certificate;

    @XmlElement(name="contact")
    private List<Contact> contact;

	/* Getter + Setter */

}
Where Component PHP
class Task {

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

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

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

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

    /**
     *
     * @var type Date
     */
    public $execDate;

    /**
     *
     * @var type List<Certificate>
     */
    public $certificate;

    /**
     *
     * @var type List<Certificate>
     */
    public $contact;

	/* Getter + Setter */

}
Where Component C#
public class Task {

    private String code;

    private String replyTo;

    private String emailConfirmation;

    private String ctid;

    private Date execDate;

    private List<Certificate> certificate;

 	private List<Contact> contact;

	/* Getter + Setter */

}