Table of Contents
  1. JSON
  2. XML
  3. Input Parameters
  4. Response Parameters
  5. Javascript Library

/Account/DomainInfo

Gets human-readable information about the domain of the server. This resource is accessed using HTTP GET, so there is no payload sent to resource. The request can be made anonymously. No authentication is required. This resource is typically called in the beginning of an on-boarding process, where the user is given a choice to select service provider (i.e. domain).

JSON

Response (if successful)
{
    "domain":Optional(Str(PDomain)),
    "useEncryption":Required(Boolean(PUseEncryption)),
    "humanReadableName":Optional(Str(PHumanReadableName)),
    "humanReadableDescription":Optional(Str(PHumanReadableDescription))
}

XML

Response (if successful)
<DomainInfo xmlns="https://waher.se/Schema/BrokerAgent.xsd"
            domain=(Optional(Str(PDomain)))
            useEncryption=(Required(Boolean(PUseEncryption)))
            humanReadableName=(Optional(Str(PHumanReadableName)))
            humanReadableDescription=(Optional(Str(PHumanReadableDescription))) />

Input Parameters

Header Description
Accept-Language The Accept-Language is used to select which language to use for human-readable strings returned.

Response Parameters

Parameter Description
PDomain Domain name of server.
PUseEncryption If encryption is enabled on domain.
PHumanReadableName A human-readable name given to the server domain.
PHumanReadableDescripton A human-readable description describing the purpose of the domain.

Javascript Library

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

var Response = await AgentAPI.Account.DomainInfo(Language);

Note: The Language argument can be empty, to use default (or system configured) language headers. If specified, can be a language code, or a string compatible with the Accept-Language HTTP header.

Test


Response Payload: