+xns/Data
Message: Get

+xns/Core/XNSObject
   |
   +--+xns/Core/Message
         |
         +--+xns/Data/Get


Retrieves data of a specified type at a specified set of addresses from within identity documents.

An input data type is optional. If the data type is not specified, the data as type +xns/Core/XNSObject is returned.

The elements of the 'addresses' argument are XNS addresses. If an address does not specify an identity, the identity the message is sent to is assumed. A set of input addresses is optional. If no addresses are provided, then all instances of the specified data type from within the to-identity are returned.

Depth indicates how deep to traverse the XML. If the actual type of the object is derived from the specified type, then the actual type will be returned in the 'type=' attribute of the objects.

To: Identity supplying the data, either directly or via its contracts with other identities.
From: Identity requesting data.


 

Input
+xns/Core/TextList Addresses List of XNS addresses from which data is to be returned.
Integer Depth Indicator of how deep to traverse the XML.
Boolean IncludeTypes Should the type attribute be set on returned elements?
Integer Limit The maximum number of objects to be returned.
Integer Skip The number of objects to be skipped when satisfying the get request.
String Type The data type of the object to be created upon message return.
 

Output
+xns/Core/ElementList Data The data returned.
 

Exceptions
IncorrectType An object in the Addresses list was not of the type specified by the Type input parameter.
 

Input Detail

Addresses

List of XNS addresses from which data is to be returned.  

DataType: +xns/Core/TextList
 

List: true
 


Depth

Indicator of how deep to traverse the XML. If depth=0, then the elements of the object, but not of contained objects, are returned. If depth=-1, then all the data, as deep as exists, are returned.  

DataType: Integer
 


IncludeTypes

Should the type attribute be set on returned elements? True=the type attribute is set on all elements returned; False=the type attribute is set on the requested elements only if their data type does not match exactly the data type requested.  

DataType: Boolean
 


Limit

The maximum number of objects to be returned.  

DataType: Integer
 


Skip

The number of objects to be skipped when satisfying the get request.  

DataType: Integer
 


Type

The data type of the object to be created upon message return. This is a string in the format +xns/Core/XNSObject. If the data type is not known, a data type of +xns/Core/XNSObject can be specified; in this case, the actual data type of the derived object can be found in the 'type' attribute of +xns/Core/XNSObject.  

DataType: String
 


 

Output Detail

Data

The data returned.  

DataType: +xns/Core/ElementList
 

List: true
 


Publishing Identity: +xns
© 2002 XNSORG
Last Updated: 07/09/2002