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

Gets the public link to a unit.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serialNumber

string

Required

Body Parameters

None.

Response Information

Resource Description

Gets the public link to a unit.

UnitPublicLinkModel
NameDescriptionTypeAdditional information
SerialNumber

ReadOnly. Unit serialnumber.

 string

None.
PublishFromDate

Publish data from this date and time (UTC). This property is clamped to a time between current UTC time and your earliest data access for this unit.

 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": "2024-12-03T16:46:30.9129478+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>2024-12-03T16:46:30.9129478+00:00</PublishFromDate>
  <PublishedUrl>sample string 3</PublishedUrl>
  <SerialNumber>sample string 1</SerialNumber>
</UnitPublicLinkModel>