Asset Management API

Asset Groups

Download Spec

patch/asset-management/v1/asset-groups/{assetGroupId}/add-site-partners

Add site partners to an asset group

This endpoint allows you to add site partners to an asset group.

sitePartnersarray

required

Responses

Request examples

{
  "sitePartners": [
    "string"
  ]
}

Response examples

Success

{
  "data": {
    "id": "string",
    "type": "location",
    "network": {
      "id": "string"
    },
    "sitePartners": [
      {
        "id": "string"
      }
    ],
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z",
    "location": {
      "name": "string",
      "visibility": "EMPLOYEE_ONLY",
      "openingDate": "2023-06-07T17:32:28Z",
      "contactDetails": {
        "phone": "string",
        "email": "alice@example.com",
        "website": "string",
        "facebook": "string",
        "linkedIn": "string"
      },
      "images": [
        {
          "url": "string",
          "category": "string",
          "imgType": "string",
          "thumbnail": "string"
        }
      ],
      "businessType": "HOTEL",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "hours": {
        "twentyfourseven": true,
        "regularHours": [
          {
            "weekday": 123.0,
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ],
        "exceptionalOpenings": [
          {
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ],
        "exceptionalClosings": [
          {
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ]
      },
      "geoLocation": {
        "longitude": 123.0,
        "latitude": 123.0
      },
      "timezone": "string",
      "directionHint": "string",
      "allowChargingWhenClosed": true,
      "parkingType": "PARKING_GARAGE",
      "amenities": [
        "string"
      ],
      "visibilityNote": "string",
      "industryVertical": "RETAIL_AND_HOSPITALITY"
    },
    "metadata": {}
  }
}

get/asset-management/v1/asset-groups

List all asset groups

This endpoint retrieves a list of all asset-groups

limitstring

The maximum number of asset groups to return (default 20, maximum 100)

Pattern: ^[0-9][0-9]?$|^100$

startingAfterstring

The ID of the last asset group in the previous page of results. Results will start after this asset group

idsstring

A comma-separated list of asset group IDs to filter the results

Responses

Response examples

A list of asset groups

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "type": "location",
        "network": {
          "id": "string"
        },
        "sitePartners": [
          {
            "id": "string"
          }
        ],
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z",
        "location": {
          "name": "string",
          "visibility": "EMPLOYEE_ONLY",
          "openingDate": "2023-06-07T17:32:28Z",
          "contactDetails": {
            "phone": "string",
            "email": "alice@example.com",
            "website": "string",
            "facebook": "string",
            "linkedIn": "string"
          },
          "images": [
            {
              "url": "string",
              "category": "string",
              "imgType": "string",
              "thumbnail": "string"
            }
          ],
          "businessType": "HOTEL",
          "physicalAddress": {
            "streetNumber": "string",
            "streetName": "string",
            "streetDetails": "string",
            "city": "string",
            "state": "AL",
            "postalCode": "string",
            "countryCode": "US"
          },
          "hours": {
            "twentyfourseven": true,
            "regularHours": [
              {
                "weekday": 123.0,
                "periodBegin": "string",
                "periodEnd": "string"
              }
            ],
            "exceptionalOpenings": [
              {
                "periodBegin": "string",
                "periodEnd": "string"
              }
            ],
            "exceptionalClosings": [
              {
                "periodBegin": "string",
                "periodEnd": "string"
              }
            ]
          },
          "geoLocation": {
            "longitude": 123.0,
            "latitude": 123.0
          },
          "timezone": "string",
          "directionHint": "string",
          "allowChargingWhenClosed": true,
          "parkingType": "PARKING_GARAGE",
          "amenities": [
            "string"
          ],
          "visibilityNote": "string",
          "industryVertical": "RETAIL_AND_HOSPITALITY"
        },
        "metadata": {}
      }
    ]
  }
}

post/asset-management/v1/asset-groups

Create a new asset group

This endpoint creates a new asset group

typestring

required

The type of asset group to be created

Enum: location

networkstring

The ID of the network associated with the asset group

Min Length: 1
Max Length: 50

sitePartnersarray

required

An array of site partner IDs related to the asset group

Min Length: 1
Max Length: 50

locationobject (CreateLocationParams)

Details specific to the location type of asset group

namestring

required

Min Length: 1
Max Length: 200

visibilitystring

required

Indicates if the location is public or has some level of restricted access.

Default: "PUBLIC"
Enum: EMPLOYEE_ONLY
RESIDENT_ONLY
PUBLIC
PRIVATE
IN_NETWORK_ONLY

openingDatestring

Format: date-time
Min Length: 1
Max Length: 25

contactDetailsobject

required

imagesarray

businessTypestring

required

Enum: HOTEL
RESTAURANT
CAFE
SHOPPING_MALL
SUPERMARKET
SPORTS_ARENA
RECREATION_AREA
NATURE
MUSEUM
BUS_STOP
TAXI_STAND
TRAM_STOP
TRAIN_STATION
AIRPORT
PARKING_LOT
CARPOOL_PARKING
GAS_STATION
RESIDENTIAL
OFFICE_PARK
CAR_DEALERSHIP
FLEET_DEPOT
OTHER

physicalAddressobject

required

Physical address details

hoursobject

required

Specifies the opening hours of the location. At a minimum you must specify if the location is open 24/7 via the twentyfourseven property.

geoLocationobject (GeoLocation)

required

Geolocation details for the location

directionHintstring

Directional hint for the location

Min Length: 1
Max Length: 200

allowChargingWhenClosedboolean

required

Indicates that if the location is closed charging is still available.

parkingTypestring

Type of parking available at the location

Enum: PARKING_GARAGE
PARKING_LOT
DRIVEWAY
ON_STREET
OTHER

amenitiesarray

Amenities available at the location

visibilityNotestring

Additional notes regarding visibility

Min Length: 1
Max Length: 200

industryVerticalstring or null

Enum: RETAIL_AND_HOSPITALITY
MULTI_UNIT_DWELLING
WORKPLACE
PUBLIC_DCFC
MUNICIPAL_FLEET
DELIVER_DEPOT

metadataobject

Additional metadata for the asset group

Responses

Request examples

{
  "type": "location",
  "network": "string",
  "sitePartners": [
    "string"
  ],
  "location": {
    "name": "string",
    "visibility": "EMPLOYEE_ONLY",
    "openingDate": "2023-06-07T17:32:28Z",
    "contactDetails": {
      "phone": "string",
      "email": "alice@example.com",
      "website": "string",
      "facebook": "string",
      "linkedIn": "string"
    },
    "images": [
      {
        "url": "string",
        "category": "string",
        "imgType": "string",
        "thumbnail": "string"
      }
    ],
    "businessType": "HOTEL",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "hours": {
      "twentyfourseven": true,
      "regularHours": [
        {
          "weekday": 123.0,
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ],
      "exceptionalOpenings": [
        {
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ],
      "exceptionalClosings": [
        {
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ]
    },
    "geoLocation": {
      "longitude": 123.0,
      "latitude": 123.0
    },
    "directionHint": "string",
    "allowChargingWhenClosed": true,
    "parkingType": "PARKING_GARAGE",
    "amenities": [
      "string"
    ],
    "visibilityNote": "string",
    "industryVertical": "RETAIL_AND_HOSPITALITY"
  },
  "metadata": {}
}

Response examples

Asset group successfully created

{
  "id": "string",
  "type": "location",
  "network": {
    "id": "string"
  },
  "sitePartners": [
    {
      "id": "string"
    }
  ],
  "createdAt": "2023-06-07T17:32:28Z",
  "updatedAt": "2023-06-07T17:32:28Z",
  "location": {
    "name": "string",
    "visibility": "EMPLOYEE_ONLY",
    "openingDate": "2023-06-07T17:32:28Z",
    "contactDetails": {
      "phone": "string",
      "email": "alice@example.com",
      "website": "string",
      "facebook": "string",
      "linkedIn": "string"
    },
    "images": [
      {
        "url": "string",
        "category": "string",
        "imgType": "string",
        "thumbnail": "string"
      }
    ],
    "businessType": "HOTEL",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "hours": {
      "twentyfourseven": true,
      "regularHours": [
        {
          "weekday": 123.0,
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ],
      "exceptionalOpenings": [
        {
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ],
      "exceptionalClosings": [
        {
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ]
    },
    "geoLocation": {
      "longitude": 123.0,
      "latitude": 123.0
    },
    "timezone": "string",
    "directionHint": "string",
    "allowChargingWhenClosed": true,
    "parkingType": "PARKING_GARAGE",
    "amenities": [
      "string"
    ],
    "visibilityNote": "string",
    "industryVertical": "RETAIL_AND_HOSPITALITY"
  },
  "metadata": {}
}

patch/asset-management/v1/asset-groups/{assetGroupId}/remove-site-partners

Remove site partners from an asset group

This endpoint allows you to remove site partners from an asset group.

sitePartnersarray

required

Responses

Request examples

{
  "sitePartners": [
    "string"
  ]
}

Response examples

Success

{
  "data": {
    "id": "string",
    "type": "location",
    "network": {
      "id": "string"
    },
    "sitePartners": [
      {
        "id": "string"
      }
    ],
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z",
    "location": {
      "name": "string",
      "visibility": "EMPLOYEE_ONLY",
      "openingDate": "2023-06-07T17:32:28Z",
      "contactDetails": {
        "phone": "string",
        "email": "alice@example.com",
        "website": "string",
        "facebook": "string",
        "linkedIn": "string"
      },
      "images": [
        {
          "url": "string",
          "category": "string",
          "imgType": "string",
          "thumbnail": "string"
        }
      ],
      "businessType": "HOTEL",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "hours": {
        "twentyfourseven": true,
        "regularHours": [
          {
            "weekday": 123.0,
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ],
        "exceptionalOpenings": [
          {
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ],
        "exceptionalClosings": [
          {
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ]
      },
      "geoLocation": {
        "longitude": 123.0,
        "latitude": 123.0
      },
      "timezone": "string",
      "directionHint": "string",
      "allowChargingWhenClosed": true,
      "parkingType": "PARKING_GARAGE",
      "amenities": [
        "string"
      ],
      "visibilityNote": "string",
      "industryVertical": "RETAIL_AND_HOSPITALITY"
    },
    "metadata": {}
  }
}

post/asset-management/v1/asset-groups/{assetGroupId}/site-contacts

Create a new site contact for an asset group

This endpoint creates a new site contact for an asset group

namestring

required

The name of the site contact

emailstring

required

The email address of the site contact

phonestring

The phone number of the site contact

typestring

required

The type of site contact (e.g., FLEET_MANAGER)

Enum: FLEET_MANAGER

Responses

Request examples

{
  "name": "string",
  "email": "string",
  "phone": "string",
  "type": "FLEET_MANAGER"
}

Response examples

Success

{
  "data": {
    "id": "string",
    "networkId": "string",
    "assetGroupId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "type": "FLEET_MANAGER",
    "isArchived": true,
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

delete/asset-management/v1/asset-groups/{assetGroupId}/site-contacts/{siteContactId}

Archive a site contact for an asset group

This endpoint archives a site contact for an asset group
WARNING! This action is potentially dangerous and irreversible!

assetGroupIdstring

required

The ID of the asset group

siteContactIdstring

required

The ID of the site contact

Responses

Response examples

Success

{
  "data": {
    "id": "string",
    "networkId": "string",
    "assetGroupId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "type": "FLEET_MANAGER",
    "isArchived": true,
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

patch/asset-management/v1/asset-groups/{assetGroupId}

Update an asset group

This endpoint updates an existing asset group by its ID.

locationobject (UpdateLocationParams)

namestring

The name of the location

Min Length: 1
Max Length: 50

visibilitystring

Indicates if the location is public or has some level of restricted access.

Enum: EMPLOYEE_ONLY
RESIDENT_ONLY
PUBLIC
PRIVATE
IN_NETWORK_ONLY

openingDatestring or null

The date the location opened

Format: date-time

contactDetailsobject

Updating contact details does not support partial updates. You must specify all contact detail properties you want.

imagesarray

Images associated with the location

businessTypestring

Type of business associated with the location

Enum: HOTEL
RESTAURANT
CAFE
SHOPPING_MALL
SUPERMARKET
SPORTS_ARENA
RECREATION_AREA
NATURE
MUSEUM
BUS_STOP
TAXI_STAND
TRAM_STOP
TRAIN_STATION
AIRPORT
PARKING_LOT
CARPOOL_PARKING
GAS_STATION
RESIDENTIAL
OFFICE_PARK
CAR_DEALERSHIP
FLEET_DEPOT
OTHER

physicalAddressobject (PhysicalAddress)

Physical address details

hoursobject

Specifies the opening hours of the location. At a minimum you must specify if the location is open 24/7 via the twentyfourseven property.

geoLocationobject (GeoLocation)

Geolocation details for the location

directionHintstring or null

Min Length: 1
Max Length: 200

allowChargingWhenClosedboolean

Indicates that if the location is close charging is still available.

parkingTypestring or null

Enum: PARKING_GARAGE
PARKING_LOT
DRIVEWAY
ON_STREET
OTHER

amenitiesarray

visibilityNotestring or null

Min Length: 1
Max Length: 200

industryVerticalstring or null

Enum: RETAIL_AND_HOSPITALITY
MULTI_UNIT_DWELLING
WORKPLACE
PUBLIC_DCFC
MUNICIPAL_FLEET
DELIVER_DEPOT

metadataobject

Additional metadata for the asset group

Responses

Request examples

{
  "location": {
    "name": "string",
    "visibility": "EMPLOYEE_ONLY",
    "openingDate": "2023-06-07T17:32:28Z",
    "contactDetails": {
      "phone": "string",
      "email": "alice@example.com",
      "website": "string",
      "facebook": "string",
      "linkedIn": "string"
    },
    "images": [
      {
        "url": "string",
        "category": "string",
        "imgType": "string",
        "thumbnail": "string"
      }
    ],
    "businessType": "HOTEL",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "hours": {
      "twentyfourseven": true,
      "regularHours": [
        {
          "weekday": 123.0,
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ],
      "exceptionalOpenings": [
        {
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ],
      "exceptionalClosings": [
        {
          "periodBegin": "string",
          "periodEnd": "string"
        }
      ]
    },
    "geoLocation": {
      "longitude": 123.0,
      "latitude": 123.0
    },
    "directionHint": "string",
    "allowChargingWhenClosed": true,
    "parkingType": "PARKING_GARAGE",
    "amenities": [
      "string"
    ],
    "visibilityNote": "string",
    "industryVertical": "RETAIL_AND_HOSPITALITY"
  },
  "metadata": {}
}

Response examples

Success. Returns the updated asset group.

{
  "data": {
    "id": "string",
    "type": "location",
    "network": {
      "id": "string"
    },
    "sitePartners": [
      {
        "id": "string"
      }
    ],
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z",
    "location": {
      "name": "string",
      "visibility": "EMPLOYEE_ONLY",
      "openingDate": "2023-06-07T17:32:28Z",
      "contactDetails": {
        "phone": "string",
        "email": "alice@example.com",
        "website": "string",
        "facebook": "string",
        "linkedIn": "string"
      },
      "images": [
        {
          "url": "string",
          "category": "string",
          "imgType": "string",
          "thumbnail": "string"
        }
      ],
      "businessType": "HOTEL",
      "physicalAddress": {
        "streetNumber": "string",
        "streetName": "string",
        "streetDetails": "string",
        "city": "string",
        "state": "AL",
        "postalCode": "string",
        "countryCode": "US"
      },
      "hours": {
        "twentyfourseven": true,
        "regularHours": [
          {
            "weekday": 123.0,
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ],
        "exceptionalOpenings": [
          {
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ],
        "exceptionalClosings": [
          {
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ]
      },
      "geoLocation": {
        "longitude": 123.0,
        "latitude": 123.0
      },
      "timezone": "string",
      "directionHint": "string",
      "allowChargingWhenClosed": true,
      "parkingType": "PARKING_GARAGE",
      "amenities": [
        "string"
      ],
      "visibilityNote": "string",
      "industryVertical": "RETAIL_AND_HOSPITALITY"
    },
    "metadata": {}
  }
}

Was this page helpful?