reference |
In order to allow your system to easily associate the DRS responses
to your requests, the robot reproduces the same
value in the field reference as
it was in your e-mail application.
This data is only available if the DRS response is a reaction to an
e-mail application and if a reference
value was used in the application which was being processed.
|
my-reference-12322 |
result.code |
This field includes a numeric code, which represents the
result
of the application on which the response is based.
A listing of all
the result codes dispatched by the DRS is also available.
Positive results (successful processing) can be identified by the
leading cipher 1, as opposed to
failures, which start with ciphers 2 and above.
In addition to this result code a number of indexed (i.e. serially numbered)
sub-results are being dispatched in case of an
error. This is done by means of the following fields.
|
10000 |
result.msg |
This field provides a textual description of the result which is
displayed in the result.code field
in English.
This field is primarily intended to improve readability by humans;
but automated processing should always incorporate the
result.code field
instead.
|
Command completed successfully |
result.<n>.code |
This field includes a numeric code, which represents the
<n>th sub-result
of the application on which the response is based.
In case of an error this could be for example an erroneous completed
field in the e-mail template.
A listing of all
the result codes dispatched by the DRS is also available.
|
20206 |
result.<n>.msg |
This field provides a textual description of the sub-result which is
displayed in the
result.<n>.code
field in English.
|
invalid field content |
result.<n>.key resp.
result.<n>.key.<n> |
If the DRS response represents the reaction to an erroneous e-mail
template, the key of the wrong field is included here.
This result field may be double indexed due to an additional numbering.
|
fax |
result.<n>.value resp.
result.<n>.value.<n> |
If the DRS response represents the reaction to an erroneous e-mail
template, the value of the wrong field is included here.
This result field may be double indexed due to an additional numbering.
|
|
result.<n>.line.no |
If the DRS response represents the reaction to an erroneous e-mail
template this field provides the number of the line where the
erroneous field was found in the template.
|
72 |
result.<n>.section |
If the DRS response represents the reaction to an erroneous e-mail
template this field provides the number of the section where the
erroneous field was found in the template.
|
2 |
result.
<n>.line.content |
If the DRS response represents the reaction to an erroneous e-mail
template in certain cases this field provides the whole content
of the relevant line (e.g. if syntactically invalid lines exist).
|
Content of the displaced line |
result.<n>.
data.<n>.key |
In different cases it is necessary that responses or notices of the
DRS robot dispatch generic informations.
To avoid constantly adding new fields to the present table such fields
are being encoded in the response or notice by this field and the
following field result.<n>.data.<n>.value
as "nested" key-value pairs.
In the example
described here the deadline for an outgoing transfer is included.
|
deadline |
result.<n>.
data.<n>.value |
This field includes the value of the "nested" key-value pair, which
is encoded as described above. To simplify associating the
appropriate key has the same numbering.
|
2003- 08-30T06:06:48.100Z |
domain.name |
When it comes to managing/creating a particular domain,
this field (if present) provides the name of the domain.
|
acme.info |
domain.id |
When it comes to managing/creating a particular domain,
this field (if present) provides the handle of the domain.
|
D-12345 |
contact.id |
When it comes to managing/creating a particular contact,
this field (if present) provides the name of the contact.
|
R23-1345454-PIR |
contact.<n>.id |
If the response of the DRS robot concerns the creation or modification
of an object using contacts (e.g. a domain), this field (if present)
contains the handle of the n-th used or created contact.
|
R23-1345454-PIR |
contact.<n>.type |
If a response of the DRS robot concerns the creation or modification
of an object using contacts (e.g. a domain), this field (if present)
contains the type of the n-th used or created contact.
The type reflects whether the n-th contact is used as the objects'
registrant (registrant),
administrative contact (admin),
technical contact (tech),
zone contact (zone) or
billing contact (billing).
|
registrant |
host.name |
When it comes to managing/creating a particular host,
this field (if present) provides the name of the host.
|
ns1.acme.info |
host.id |
When it comes to managing/creating a particular host,
this field (if present) provides the handle of the host.
|
H-12345 |
ns.<n>.name |
If a response of the DRS robot concerns the creation or modification
of an object using name servers (e.g. a domain), this field (if present)
contains the name of the n-th used or created host.
|
ns2.myns.de |
ns.<n>.id |
If a response of the DRS robot concerns the creation or modification
of an object using name servers (e.g. a domain), this field (if present)
contains the handle of the n-th used or created host.
|
H1345454-PIR |
ns.<n>.role |
If a response of the DRS robot concerns the creation or modification
of an object using name servers (e.g. a domain), this field (if present)
contains the role of the n-th used or created host within the object.
The only value currently occurring for this field is
primary), indicating the master
name server for the domain.
|
primary |
deletion.scheduled |
If the response of the DRS concerns the successful scheduling
of the deletion of an object (e.g. a domain), the value of this
field contains the date on which the affected object will be
permanently removed from your inventory.
|
2004-02-24T00:00:00.0Z |
