/Xmpp/InformationQuery

Sends an Information Query (iq) to an entity on the XMPP network, given its Full JID. For connected entities, you need to have an presence subscription to that entity, approved by the entity, to get the Full JID. You get the Full JID using the Presence Probe resource.

JSON

Request

{
	"to":Required(Str(PTo)),
	"type":Required(Str(PType)),
	"xml":Required(Xml(PQuery))
}

Response (if successful)

{
	"ok": Required(Boolean(POk)),
	"errorCode": Optional(Int(PErrorCode)),
	"errorText": Optional(Str(PErrorText)),
	"errorType": Optional(Str(PErrorType)),
	"ErrorElement": Optional(PErrorElement),
	"Stanza": Optional(PStanza)
}

XML

Request

<InformationQuery xmlns="https://waher.se/Schema/BrokerAgent.xsd"
                  to=(Required(Str(PTo)))
                  type=(Required(Str(PType)))>
    <[Required(Xml(PQuery))]>
</InformationQuery>

Response (if successful)

<QueryResult xmlns="https://waher.se/Schema/BrokerAgent.xsd"
             ok=(Required(Boolean(POk)))
			 errorCode=(Optional(Int(PErrorCode)))
			 errorText=(Optional(Str(PErrorText)))
			 errorType=(Optional(Str(PErrorType)))>
	<[Required(Xml(PContent))]>
</QueryResult>

Input Parameters

Response Parameters

Note Underlying communication protocol is XMPP, which encodes information using XML. When requesting information encoded as JSON, this XML is automatically transformed into JSON. When XML is transformed into JSON objects, the special names __name and __ns can be used to get information about what XML names and namespaces have been used. XML attributes are encoded as properties. Child elements are also encoded as properties (if only one child element occurs with the same name), or as vectors of objects (if more than one child element occurs with the same name).

Javascript Library

Use the following asynchronous method in the Javascript Library, to call this resource.

var Response = await AgentAPI.Xmpp.InformationQuery(FullJid, Type, QueryXml);