Retrieving Device, Group, or Matrix Names and IDs

The following methods retrieve device, group, and matrix identification information.

Retrieving an Entity Name

The get_entity_name method returns the display name of a given group, device, or matrix entity ID.

Request Type: GetEntityNameRequest

Element	Type	Description
SessionIDMandatory	String	SessionID obtained from the connect method.
EntityTypeMandatory	AfaNonEmptyString	Entity type. One of the following: device group matrix
EntityIDMandatory	AfaNonEmptyString	Entity's tree name.

Response Type: GetEntityNameResponse

Element	Type	Description
GetEntityNameResponse	AfaNonEmptyString	On success, returns the entity's name. On failure, throws a SOAP Fault.

Retrieving an Entity ID

The get_entity_id method retrieves the entity ID of a given group, device, or matrix entity name.

Request Type: GetEntityIDRequest

Element	Type	Description
SessionIDMandatory	String	SessionID obtained from Connect method.
EntityTypeMandatory	AfaNonEmptyString	Entity type. One of the following: device group matrix
EntityNameMandatory	AfaNonEmptyString	Entity's display name.

Response Type: GetEntityIDResponse

Element	Type	Description
GetEntityIDResponse	AfaNonEmptyString	On success, returns the entity's ID (tree name). On failure, throws a SOAP Fault.