Retrieving Device, Group, or Matrix Names and IDs

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

Retrieving an Entity Name

NOTE: We recommend using the REST API instead. For details, refer to the GET /api/v1/devices/{deviceName} endpoint in the Swagger documentation. REST services are more advanced and are the preferred option over SOAP for this operation.

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

Request Type: GetEntityNameRequest

Element

Type

Description
SessionID Mandatory

String

SessionID obtained from the connect method.
EntityType Mandatory

AfaNonEmptyString

Entity type. One of the following:

  • device
  • group
  • matrix
EntityID Mandatory

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

NOTE: We recommend using the REST API instead. For details, refer to the GET /api/v1/device/{device} endpoint in the Swagger documentation. REST services are more advanced and are the preferred option over SOAP for this operation.

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

Request Type: GetEntityIDRequest

Element

Type

Description
SessionID Mandatory

String

SessionID obtained from Connect method.
EntityType Mandatory

AfaNonEmptyString

Entity type. One of the following:

  • device
  • group
  • matrix
EntityName Mandatory

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.