Get site by external site ID

x-ms-visibility: "important"

Retrieve a specific site by its external site ID.

Path Parameters

externalSiteId string required

External ID of the site to retrieve.

Responses

• 200
• 400
• 401

---

Details of the requested site.

application/json

Schema

Example (from schema)

---

Schema

id int64 nullable
name string nullable
publicName string
isPublicSite boolean nullable
groupType string
externalId string
streetAddress string
city string
postalCode string
country string
latitude double nullable
longitude double nullable
timezone string
parentSiteId int64 nullable
payerId int64 nullable
costId string
paymentRecipientId int64 nullable
parkingType string
parentName string
numberOfChargers int64 nullable
numberOfSubsites int64 nullable
sitePath object[]
Array [
siteId int64
siteName string
]
tariffReferences object[]
Array [
groupId string
tariffId string
usageType int32 nullable
Possible values: [0, 1]
Default value: 0
]
metadata string[]
notes string

{
  "id": 0,
  "name": "string",
  "publicName": "string",
  "isPublicSite": true,
  "groupType": "string",
  "externalId": "string",
  "streetAddress": "string",
  "city": "string",
  "postalCode": "string",
  "country": "string",
  "latitude": 0,
  "longitude": 0,
  "timezone": "string",
  "parentSiteId": 0,
  "payerId": 0,
  "costId": "string",
  "paymentRecipientId": 0,
  "parkingType": "string",
  "parentName": "string",
  "numberOfChargers": 0,
  "numberOfSubsites": 0,
  "sitePath": [
    {
      "siteId": 0,
      "siteName": "string"
    }
  ],
  "tariffReferences": [
    {
      "groupId": "string",
      "tariffId": "string",
      "usageType": 0
    }
  ],
  "metadata": [
    "string"
  ],
  "notes": "string"
}

Exception Details

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorised

Loading...