• Asset Management API

Networks

post

Create a new network

This endpoint creates a new network.

namestring

required

The name of the network

physicalAddressobject (PhysicalAddress)

required

Physical address details

streetNumberstring

required

Min Length
1
Max Length
100
streetNamestring

required

Min Length
1
Max Length
100
streetDetailsstring
Min Length
1
Max Length
100
citystring

required

Min Length
1
Max Length
100
statestring

required

Enum
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
  • DC
  • AS
  • GU
  • MP
  • PR
  • UM
  • VI
postalCodestring

required

Min Length
1
Max Length
10
countryCodestring

required

Enum
  • US
  • CA
productOfferingsarray

required

Array of product offerings associated with the network

nameobject (InternationalString)

required

descriptionobject (InternationalString)
featuresobject (InternationalStringArray)
currencystring

required

pricingDetailsarray

required

contactDetailsobject

required

Contact details for the network

phonestring

required

websitestring

required

emailstring
enrolledServicesobject

The services that the network is enrolled in. Specify the keys that should be enrolled.

billingobject
ticketingobject
emailobject
ocpiobject
installerJourneyobject
plugAndChargeobject
energyManagementobject
siteHostDashboardUrlstring

The URL to the siteHost dashboard

typestring
Enum
  • FLEET
  • PUBLIC

Responses

Request examples

{
  "name": "string",
  "physicalAddress": {
    "streetNumber": "string",
    "streetName": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "AL",
    "postalCode": "string",
    "countryCode": "US"
  },
  "productOfferings": [
    {
      "name": {
        "en_US": "string"
      },
      "description": {
        "en_US": "string"
      },
      "features": {
        "en_US": [
          "string"
        ]
      },
      "currency": "string",
      "pricingDetails": [
        {
          "type": "MONTHLY",
          "value": 123.0,
          "isPrivate": true
        }
      ]
    }
  ],
  "contactDetails": {
    "phone": "string",
    "website": "string",
    "email": "string"
  },
  "enrolledServices": {
    "billing": {},
    "ticketing": {},
    "email": {},
    "ocpi": {
      "roles": [
        "CPO"
      ]
    },
    "installerJourney": {},
    "plugAndCharge": {},
    "energyManagement": {}
  },
  "siteHostDashboardUrl": "string",
  "type": "FLEET"
}

Response examples

Created

{
  "data": {
    "id": "string",
    "name": "string",
    "physicalAddress": {
      "streetNumber": "string",
      "streetName": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "AL",
      "postalCode": "string",
      "countryCode": "US"
    },
    "productOfferings": [
      {
        "name": {
          "en_US": "string"
        },
        "description": {
          "en_US": "string"
        },
        "features": {
          "en_US": [
            "string"
          ]
        },
        "currency": "string",
        "pricingDetails": [
          {
            "type": "MONTHLY",
            "value": 123.0,
            "isPrivate": true
          }
        ]
      }
    ],
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z",
    "contactDetails": {
      "phone": "string",
      "website": "string",
      "email": "string"
    },
    "enrolledServices": {
      "billing": {
        "finishedOnboarding": true
      },
      "ticketing": {},
      "email": {},
      "ocpi": {
        "roles": [
          "CPO"
        ]
      },
      "installerJourney": {},
      "plugAndCharge": {},
      "guestCharging": {
        "connectedAccountId": "string",
        "convenienceFeeInCents": 123.0,
        "currency": "string"
      },
      "energyManagement": {}
    },
    "siteHostDashboardUrl": "string",
    "type": "FLEET",
    "siteManagerMfaRequired": true
  }
}
patch

Update a network

This endpoint updates an existing network.

physicalAddressobject (PhysicalAddress)

Physical address details

streetNumberstring

required

Min Length
1
Max Length
100
streetNamestring

required

Min Length
1
Max Length
100
streetDetailsstring
Min Length
1
Max Length
100
citystring

required

Min Length
1
Max Length
100
statestring

required

Enum
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
  • DC
  • AS
  • GU
  • MP
  • PR
  • UM
  • VI
postalCodestring

required

Min Length
1
Max Length
10
countryCodestring

required

Enum
  • US
  • CA
contactDetailsobject

Contact details for the network

phonestring

required

websitestring

required

emailstring
enrolledServicesobject

The services that the network is enrolled in. Updating enrolled services does not support partial updates. Meaning if you want to update the billing service, you need to send the entire object with all services that should and should not be included.

billingobject
ticketingobject
emailobject
ocpiobject
installerJourneyobject
plugAndChargeobject
guestChargingobject
energyManagementobject
siteHostDashboardUrlstring

The URL to the siteHost dashboard

typestring
Enum
  • FLEET
  • PUBLIC
siteManagerMfaRequiredboolean

If true, MFA is required for all site host users within this network.

Responses

Request examples

{
  "physicalAddress": {
    "streetNumber": "string",
    "streetName": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "AL",
    "postalCode": "string",
    "countryCode": "US"
  },
  "contactDetails": {
    "phone": "string",
    "website": "string",
    "email": "string"
  },
  "enrolledServices": {
    "billing": {
      "finishedOnboarding": true
    },
    "ticketing": {},
    "email": {},
    "ocpi": {
      "roles": [
        "CPO"
      ]
    },
    "installerJourney": {},
    "plugAndCharge": {},
    "guestCharging": {
      "connectedAccountId": "string",
      "convenienceFeeInCents": 123.0,
      "currency": "string"
    },
    "energyManagement": {}
  },
  "siteHostDashboardUrl": "string",
  "type": "FLEET",
  "siteManagerMfaRequired": true
}

Response examples

Returns the updated network.

{
  "id": "string",
  "name": "string",
  "physicalAddress": {
    "streetNumber": "string",
    "streetName": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "AL",
    "postalCode": "string",
    "countryCode": "US"
  },
  "productOfferings": [
    {
      "name": {
        "en_US": "string"
      },
      "description": {
        "en_US": "string"
      },
      "features": {
        "en_US": [
          "string"
        ]
      },
      "currency": "string",
      "pricingDetails": [
        {
          "type": "MONTHLY",
          "value": 123.0,
          "isPrivate": true
        }
      ]
    }
  ],
  "createdAt": "2023-06-07T17:32:28Z",
  "updatedAt": "2023-06-07T17:32:28Z",
  "contactDetails": {
    "phone": "string",
    "website": "string",
    "email": "string"
  },
  "enrolledServices": {
    "billing": {
      "finishedOnboarding": true
    },
    "ticketing": {},
    "email": {},
    "ocpi": {
      "roles": [
        "CPO"
      ]
    },
    "installerJourney": {},
    "plugAndCharge": {},
    "guestCharging": {
      "connectedAccountId": "string",
      "convenienceFeeInCents": 123.0,
      "currency": "string"
    },
    "energyManagement": {}
  },
  "siteHostDashboardUrl": "string",
  "type": "FLEET",
  "siteManagerMfaRequired": true
}

Was this page helpful?