• Projects API

Projects

put

Activate a project

This endpoint activates a project by updating existing project with siteHost and location details.

rateIdstring

required

The unique identifier for the rate

liveSitePartnerUserIdstring

The ID of the live site partner user

projectSiteHostobject
namestring

required

The name of the project site host

Max Length
200
contactNamestring

required

The contact name of the project site host

Max Length
200
contactEmailstring

required

The contact email of the project site host

Format
email
contactPhonestring

The contact phone number of the project site host

Pattern
^\+[1-9]\d{1,14}$
streetNamestring

required

Street name of the project site host

Max Length
100
streetNumberstring

required

Street number of the project site host

Max Length
100
streetDetailsstring

Additional street details of the project site host

Max Length
100
citystring

required

City of the project site host

Max Length
100
statestring

required

State of the project site host

Max Length
100
postalCodestring

required

Postal code of the project site host

Max Length
15
countryCodestring

required

Country code of the project site host

Max Length
15
projectLocationobject

required

namestring

required

Name of the project location

Max Length
200
streetNamestring

required

Street name of the project location

Max Length
100
streetNumberstring

required

Street number of the project location

Max Length
100
streetDetailsstring

Additional street details of the project location

Max Length
100
citystring

required

City of the project location

Max Length
100
statestring

required

State of the project location

Max Length
100
postalCodestring

required

Postal code of the project location

Max Length
100
countryCodestring

required

Country code of the project location

Max Length
15
businessTypestring

required

Type of business at the project location

geoLocationLongnumber

required

Longitude of the project location

geoLocationLatnumber

required

Latitude of the project location

visibilitystring

required

Visibility of the project location

Default
"PUBLIC"
Enum
  • PUBLIC
  • PRIVATE
directionHintstring

Direction hint for the project location

Responses

Request examples

{
  "rateId": "string",
  "liveSitePartnerUserId": "string",
  "projectSiteHost": {
    "name": "string",
    "contactName": "string",
    "contactEmail": "alice@example.com",
    "contactPhone": "string",
    "streetName": "string",
    "streetNumber": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "countryCode": "string"
  },
  "projectLocation": {
    "name": "string",
    "streetName": "string",
    "streetNumber": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "countryCode": "string",
    "businessType": "string",
    "geoLocationLong": 123.0,
    "geoLocationLat": 123.0,
    "visibility": "PUBLIC",
    "directionHint": "string"
  }
}

Response examples

Ok response

{
  "data": {
    "id": "string",
    "networkId": "string",
    "status": "PENDING",
    "statusUpdatedAt": "2023-06-07T17:32:28Z",
    "activationId": "string",
    "installerDetails": {
      "installerCompanyName": "string",
      "installerContactName": "string",
      "installerContactEmail": "alice@example.com",
      "installerContactPhone": "string",
      "installerContactSecondaryEmails": [
        "alice@example.com"
      ],
      "siteHostCompanyName": "string",
      "siteHostContactName": "string",
      "siteHostContactEmail": "alice@example.com",
      "siteHostContactPhone": "string"
    },
    "projectSiteHost": {
      "projectSiteHostId": "string",
      "liveSystemId": "string",
      "siteHostUserLiveSystemId": "string",
      "name": "string",
      "contactName": "string",
      "contactEmail": "alice@example.com",
      "contactPhone": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "string",
      "createdAt": "2023-06-07T17:32:28Z",
      "updatedAt": "2023-06-07T17:32:28Z"
    },
    "projectLocation": {
      "projectLocationId": "string",
      "liveSystemId": "string",
      "name": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "string",
      "businessType": "string",
      "geoLocationLong": 123.0,
      "geoLocationLat": 123.0,
      "visibility": "PUBLIC",
      "directionHint": "string",
      "createdAt": "2023-06-07T17:32:28Z",
      "updatedAt": "2023-06-07T17:32:28Z"
    },
    "rateId": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
post

Add a station to a project

This endpoint adds a station to a project.

stationIdstring

required

Max Length
50
sortOrdernumber

Responses

Request examples

{
  "stationId": "string",
  "sortOrder": 123.0
}

Response examples

Ok response

{
  "data": {
    "id": "string",
    "networkId": "string",
    "projectId": "string",
    "liveSystemId": "string",
    "serialNumber": "string",
    "vendor": "string",
    "model": "string",
    "iccid": "string",
    "shortCode": "string",
    "sortOrder": 123.0,
    "rateId": "string",
    "directionalHint": "string",
    "modelTemplateId": "string",
    "imageUrl": "string",
    "connection": {
      "connectionId": "string",
      "status": "string",
      "timestamp": "2023-06-07T17:32:28Z"
    },
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
get

List projects

limitint
Min
1
Max
100
startingAfterstring
Max Length
50

Responses

Response examples

OK

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "networkId": "string",
        "status": "PENDING",
        "statusUpdatedAt": "2023-06-07T17:32:28Z",
        "activationId": "string",
        "installerDetails": {
          "installerCompanyName": "string",
          "installerContactName": "string",
          "installerContactEmail": "alice@example.com",
          "installerContactPhone": "string",
          "installerContactSecondaryEmails": [
            "alice@example.com"
          ],
          "siteHostCompanyName": "string",
          "siteHostContactName": "string",
          "siteHostContactEmail": "alice@example.com",
          "siteHostContactPhone": "string"
        },
        "projectSiteHost": {
          "projectSiteHostId": "string",
          "liveSystemId": "string",
          "siteHostUserLiveSystemId": "string",
          "name": "string",
          "contactName": "string",
          "contactEmail": "alice@example.com",
          "contactPhone": "string",
          "streetName": "string",
          "streetNumber": "string",
          "streetDetails": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "countryCode": "string",
          "createdAt": "2023-06-07T17:32:28Z",
          "updatedAt": "2023-06-07T17:32:28Z"
        },
        "projectLocation": {
          "projectLocationId": "string",
          "liveSystemId": "string",
          "name": "string",
          "streetName": "string",
          "streetNumber": "string",
          "streetDetails": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "countryCode": "string",
          "businessType": "string",
          "geoLocationLong": 123.0,
          "geoLocationLat": 123.0,
          "visibility": "PUBLIC",
          "directionHint": "string",
          "createdAt": "2023-06-07T17:32:28Z",
          "updatedAt": "2023-06-07T17:32:28Z"
        },
        "rateId": "string",
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z"
      }
    ]
  }
}
post

Create a new project

This endpoint creates a new project.

installerCompanyNamestring

required

The name of the installer company

Min Length
1
installerContactNamestring

required

The contact name of the installer

Min Length
1
installerContactEmailstring

required

The contact email of the installer

Format
email
installerContactPhonestring

required

The contact phone number of the installer

Min Length
1
installerContactSecondaryEmailsarray

Optional list of secondary contact emails for the installer

Format
email
siteHostCompanyNamestring

required

The name of the site host company

Min Length
1
siteHostContactNamestring

required

The contact name of the site host

Min Length
1
siteHostContactEmailstring

required

The contact email of the site host

Format
email
siteHostContactPhonestring

required

The contact phone number of the site host

Min Length
1
networkIdstring

required

The unique identifier for the network

Min Length
1
stationsarray

Optional list of stations associated with the network

stationIdstring

required

The unique identifier of the station

Min Length
1
sortOrdernumber

required

The sort order of the station

Responses

Request examples

{
  "installerCompanyName": "string",
  "installerContactName": "string",
  "installerContactEmail": "alice@example.com",
  "installerContactPhone": "string",
  "installerContactSecondaryEmails": [
    "alice@example.com"
  ],
  "siteHostCompanyName": "string",
  "siteHostContactName": "string",
  "siteHostContactEmail": "alice@example.com",
  "siteHostContactPhone": "string",
  "networkId": "string",
  "stations": [
    {
      "stationId": "string",
      "sortOrder": 123.0
    }
  ]
}

Response examples

OK

{
  "id": "string",
  "networkId": "string",
  "status": "PENDING",
  "statusUpdatedAt": "2023-06-07T17:32:28Z",
  "activationId": "string",
  "installerDetails": {
    "installerCompanyName": "string",
    "installerContactName": "string",
    "installerContactEmail": "alice@example.com",
    "installerContactPhone": "string",
    "installerContactSecondaryEmails": [
      "alice@example.com"
    ],
    "siteHostCompanyName": "string",
    "siteHostContactName": "string",
    "siteHostContactEmail": "alice@example.com",
    "siteHostContactPhone": "string"
  },
  "rateId": "string",
  "createdAt": "2023-06-07T17:32:28Z",
  "updatedAt": "2023-06-07T17:32:28Z"
}
post

Deploy a project

This endpoint deploys a project.

resultsDestinationEmailstring

The email address to send the deployment results to

Format
email

Responses

Request examples

{
  "resultsDestinationEmail": "alice@example.com"
}

Response examples

Ok response

{
  "id": "string",
  "networkId": "string",
  "status": "PENDING",
  "statusUpdatedAt": "2023-06-07T17:32:28Z",
  "activationId": "string",
  "installerDetails": {
    "installerCompanyName": "string",
    "installerContactName": "string",
    "installerContactEmail": "alice@example.com",
    "installerContactPhone": "string",
    "installerContactSecondaryEmails": [
      "alice@example.com"
    ],
    "siteHostCompanyName": "string",
    "siteHostContactName": "string",
    "siteHostContactEmail": "alice@example.com",
    "siteHostContactPhone": "string"
  },
  "projectSiteHost": {
    "projectSiteHostId": "string",
    "liveSystemId": "string",
    "siteHostUserLiveSystemId": "string",
    "name": "string",
    "contactName": "string",
    "contactEmail": "alice@example.com",
    "contactPhone": "string",
    "streetName": "string",
    "streetNumber": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "countryCode": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  },
  "projectLocation": {
    "projectLocationId": "string",
    "liveSystemId": "string",
    "name": "string",
    "streetName": "string",
    "streetNumber": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "countryCode": "string",
    "businessType": "string",
    "geoLocationLong": 123.0,
    "geoLocationLat": 123.0,
    "visibility": "PUBLIC",
    "directionHint": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  },
  "rateId": "string",
  "createdAt": "2023-06-07T17:32:28Z",
  "updatedAt": "2023-06-07T17:32:28Z"
}
delete

Remove a station from a project

This endpoint removes a station from a project.

stationIdstring

The station id to remove from the project

Responses

Request examples

{
  "stationId": "string"
}

Response examples

Ok response

{
  "data": {
    "id": "string",
    "networkId": "string",
    "projectId": "string",
    "liveSystemId": "string",
    "serialNumber": "string",
    "vendor": "string",
    "model": "string",
    "iccid": "string",
    "shortCode": "string",
    "sortOrder": 123.0,
    "rateId": "string",
    "directionalHint": "string",
    "modelTemplateId": "string",
    "imageUrl": "string",
    "connection": {
      "connectionId": "string",
      "status": "string",
      "timestamp": "2023-06-07T17:32:28Z"
    },
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
get

Retrieve a project

This endpoint retrieves a project.

projectIdstring

required

Responses

Response examples

Ok response

{
  "data": {
    "id": "string",
    "networkId": "string",
    "status": "PENDING",
    "statusUpdatedAt": "2023-06-07T17:32:28Z",
    "activationId": "string",
    "installerDetails": {
      "installerCompanyName": "string",
      "installerContactName": "string",
      "installerContactEmail": "alice@example.com",
      "installerContactPhone": "string",
      "installerContactSecondaryEmails": [
        "alice@example.com"
      ],
      "siteHostCompanyName": "string",
      "siteHostContactName": "string",
      "siteHostContactEmail": "alice@example.com",
      "siteHostContactPhone": "string"
    },
    "projectSiteHost": {
      "projectSiteHostId": "string",
      "liveSystemId": "string",
      "siteHostUserLiveSystemId": "string",
      "name": "string",
      "contactName": "string",
      "contactEmail": "alice@example.com",
      "contactPhone": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "string",
      "createdAt": "2023-06-07T17:32:28Z",
      "updatedAt": "2023-06-07T17:32:28Z"
    },
    "projectLocation": {
      "projectLocationId": "string",
      "liveSystemId": "string",
      "name": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "string",
      "businessType": "string",
      "geoLocationLong": 123.0,
      "geoLocationLat": 123.0,
      "visibility": "PUBLIC",
      "directionHint": "string",
      "createdAt": "2023-06-07T17:32:28Z",
      "updatedAt": "2023-06-07T17:32:28Z"
    },
    "rateId": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
patch

Update a project

This endpoint updates a project.

projectSiteHostobject
namestring

The name of the project site host

Max Length
200
liveSystemIdstring

livesystemId of site host in production

contactNamestring

The contact name of the project site host

Max Length
200
contactEmailstring

The contact email of the project site host

Format
email
contactPhonestring

The contact phone number of the project site host

Pattern
^\+[1-9]\d{1,14}$
streetNamestring

Street name of the project site host

Max Length
100
streetNumberstring

Street number of the project site host

Max Length
100
streetDetailsstring

Additional street details of the project site host

Max Length
100
citystring

City of the project site host

Max Length
100
statestring

State of the project site host

Max Length
100
postalCodestring

Postal code of the project site host

Max Length
15
countryCodestring

Country code of the project site host

Max Length
15
projectLocationobject
namestring

Name of the project location

Max Length
200
liveSystemIdstring

livesystemId of location in production

streetNamestring

Street name of the project location

Max Length
100
streetNumberstring

Street number of the project location

Max Length
100
streetDetailsstring

Additional street details of the project location

Max Length
100
citystring

City of the project location

Max Length
100
statestring

State of the project location

Max Length
100
postalCodestring

Postal code of the project location

Max Length
100
countryCodestring

Country code of the project location

Max Length
15
businessTypestring

Type of business at the project location

geoLocationLongnumber

Longitude of the project location

geoLocationLatnumber

Latitude of the project location

installerDetailsobject
installerCompanyNamestring

The name of the installer company

Min Length
1
installerContactNamestring

The contact name of the installer

Min Length
1
installerContactEmailstring

The contact email of the installer

Format
email
installerContactPhonestring

The contact phone number of the installer

Min Length
1
installerContactSecondaryEmailsarray

Optional list of secondary contact emails for the installer

Format
email
siteHostCompanyNamestring

The name of the site host company

Min Length
1
siteHostContactNamestring

The contact name of the site host

Min Length
1
siteHostContactEmailstring

The contact email of the site host

Format
email
siteHostContactPhonestring

The contact phone number of the site host

Min Length
1
networkIdstring

The unique identifier for the network

Min Length
1

Responses

Request examples

{
  "projectSiteHost": {
    "name": "string",
    "liveSystemId": "string",
    "contactName": "string",
    "contactEmail": "alice@example.com",
    "contactPhone": "string",
    "streetName": "string",
    "streetNumber": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "countryCode": "string"
  },
  "projectLocation": {
    "name": "string",
    "liveSystemId": "string",
    "streetName": "string",
    "streetNumber": "string",
    "streetDetails": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "countryCode": "string",
    "businessType": "string",
    "geoLocationLong": 123.0,
    "geoLocationLat": 123.0
  },
  "installerDetails": {
    "installerCompanyName": "string",
    "installerContactName": "string",
    "installerContactEmail": "alice@example.com",
    "installerContactPhone": "string",
    "installerContactSecondaryEmails": [
      "alice@example.com"
    ],
    "siteHostCompanyName": "string",
    "siteHostContactName": "string",
    "siteHostContactEmail": "alice@example.com",
    "siteHostContactPhone": "string",
    "networkId": "string"
  }
}

Response examples

Ok response

{
  "data": {
    "id": "string",
    "networkId": "string",
    "status": "PENDING",
    "statusUpdatedAt": "2023-06-07T17:32:28Z",
    "activationId": "string",
    "installerDetails": {
      "installerCompanyName": "string",
      "installerContactName": "string",
      "installerContactEmail": "alice@example.com",
      "installerContactPhone": "string",
      "installerContactSecondaryEmails": [
        "alice@example.com"
      ],
      "siteHostCompanyName": "string",
      "siteHostContactName": "string",
      "siteHostContactEmail": "alice@example.com",
      "siteHostContactPhone": "string"
    },
    "projectSiteHost": {
      "projectSiteHostId": "string",
      "liveSystemId": "string",
      "siteHostUserLiveSystemId": "string",
      "name": "string",
      "contactName": "string",
      "contactEmail": "alice@example.com",
      "contactPhone": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "string",
      "createdAt": "2023-06-07T17:32:28Z",
      "updatedAt": "2023-06-07T17:32:28Z"
    },
    "projectLocation": {
      "projectLocationId": "string",
      "liveSystemId": "string",
      "name": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetDetails": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "string",
      "businessType": "string",
      "geoLocationLong": 123.0,
      "geoLocationLat": 123.0,
      "visibility": "PUBLIC",
      "directionHint": "string",
      "createdAt": "2023-06-07T17:32:28Z",
      "updatedAt": "2023-06-07T17:32:28Z"
    },
    "rateId": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
post

Send an ocpp command to an asset

This endpoint sends a raw request to the station.
WARNING! This action is potentially dangerous and irreversible!

actionstring

required

The type of OCPP action to be executed

Enum
  • BootNotification
  • Heartbeat
  • MeterValues
  • StatusNotification
  • Authorize
  • StartTransaction
  • StopTransaction
  • DataTransfer
  • DiagnosticsStatusNotification
  • FirmwareStatusNotification
  • SignCertificate
  • GetConfiguration
  • ChangeConfiguration
  • RemoteStartTransaction
  • RemoteStopTransaction
  • Reset
  • UnlockConnector
  • UpdateFirmware
payloadstring

required

JSON string of the ocpp payload based on the action and protocol

protocolstring

required

The OCPP protocol version

Enum
  • OCPP_1_6

Responses

Request examples

{
  "action": "BootNotification",
  "payload": "string",
  "protocol": "OCPP_1_6"
}

Response examples

Success

{
  "data": {
    "id": "string",
    "assetId": "string",
    "networkId": "string",
    "action": "CancelReservation",
    "request": {
      "timestamp": "2023-06-07T17:32:28Z",
      "payload": {}
    },
    "status": "Success",
    "confirmation": {
      "timestamp": "2023-06-07T17:32:28Z",
      "payload": {}
    },
    "error": {
      "reason": "string",
      "timestamp": "2023-06-07T17:32:28Z"
    },
    "protocol": "OCPP_1_6"
  }
}
post

Send project activation email

This endpoint sends a project activation email.

projectIdstring

required

Responses

Response examples

Ok response

{
  "message": "string"
}
post

Send a station to production

This endpoint sends a station to production.

stationIdstring

required

Responses

Response examples

Ok response

{
  "id": "string",
  "assetId": "string",
  "serialNumber": "string",
  "networkId": "string",
  "request": {
    "timestamp": "2023-06-07T17:32:28Z",
    "payload": {}
  },
  "action": "CancelReservation",
  "protocol": "OCPP_1_6",
  "status": "Success",
  "confirmation": {
    "timestamp": "2023-06-07T17:32:28Z",
    "payload": {}
  }
}

Was this page helpful?