GET api/Units/PublicLink?serialNumber={serialNumber}

Gets the public link to a unit.

Request Information

URI Parameters

Name	Description	Type	Additional information
serialNumber		string	Required

Body Parameters

None.

Response Information

Resource Description

Gets the public link to a unit.

UnitPublicLinkModel

Name	Description	Type	Additional information
SerialNumber	ReadOnly. Unit serialnumber.	string	None.
PublishFromDate	Published data begins from this date and time (UTC). This property can be in the future, for a link that will activate later. This property cannot be earlier than your earliest data access for this unit.	date	None.
PublishToDate	Published data until this date and time (UTC). If set to null, the public link will show all data after PublishFromDate This property cannot be earlier than the effective PublishFromDate.	date	None.
GrantedAccess	The level of Access granted by this public link. Default (0) gives access to Map only (equivalent to GrantedAccess = 1). This is a flags value.	PublicLinkGrantedAccess	None.
PublishedUrl	Read only. URL of published link.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SerialNumber": "sample string 1",
  "PublishFromDate": "2025-11-01T17:42:00.882624+00:00",
  "PublishToDate": "2025-11-01T17:42:00.882624+00:00",
  "GrantedAccess": 0,
  "PublishedUrl": "sample string 3"
}

application/xml, text/xml

Sample:

<UnitPublicLinkModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
  <GrantedAccess>Default</GrantedAccess>
  <PublishFromDate>2025-11-01T17:42:00.882624+00:00</PublishFromDate>
  <PublishToDate>2025-11-01T17:42:00.882624+00:00</PublishToDate>
  <PublishedUrl>sample string 3</PublishedUrl>
  <SerialNumber>sample string 1</SerialNumber>
</UnitPublicLinkModel>