GET residentapi/externallinks/{linkName}

Returns the external link object by the unique link name

Request Information

URI Parameters

Name	Description	Type	Additional information
linkName		string	Required

Body Parameters

None.

Response Information

Resource Description

ExternalLink

Name	Description	Type	Additional information
Name	LinkName. Unique name for the link	string	None.
Description	Description. Description for the link	string	None.
Url	Url. Base url for the link	string	None.
Arguments	Aruments. Query String parameters for the link	string	None.
Key	Key. UniqueIdentifier for the link	string	None.

Response Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "description": "sample string 2",
  "url": "sample string 3",
  "arguments": "sample string 4",
  "key": "sample string 5"
}