API Reference
Core Resources
- Entities
- Collectives
- Tenants
Onboarding API
- Entity Onboarding
- Collective Onboarding
- Guided Onboarding
Readings API
- Readings
- Aggregations
Commands API
- Trigger or Schedule
- GETRetrieve a Command
- GETList all Commands
- PATCHCancel a Command
Charge Sessions API
Entity Settings
- Features
- Locations
- Battery Capacity
- Heated Area
- Disaggregators
- Custom Properties
Offboarding API
- Offboard Entities
Retrieve a Guided Onboarding Session
Returns the Guided Onboarding Session with specified id.
curl --request GET \
--url https://platform.realto.io/api/v1/guided-onboarding-sessions/{onboardingSessionId} \
--header 'Authorization: Bearer <token>'
{
"companyName": "<string>",
"created": "2023-11-07T05:31:56Z",
"expired": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"manufacturer": "<string>",
"onboardingRequest": {
"action": {
"documentationLink": "<string>",
"redirectLink": "<string>",
"type": "Consent"
},
"created": "2023-11-07T05:31:56Z",
"data": {
"collective": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<any>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Household"
},
"entity": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"information": {
"code": "<string>",
"ean": "<string>",
"email": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"reference": "<string>",
"track": "<string>",
"type": "Battery",
"uuid": "<string>",
"vin": "<string>"
},
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<any>",
"reference": {
"manufacturer": "<string>",
"type": "<string>",
"reference": "<string>"
},
"systemProperties": "<any>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Battery"
},
"tenant": {
"type": "Company",
"administrator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"user": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"givenName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"surname": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"client": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isTenantAdmin": true
}
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestType": "Collective",
"returnUrl": "<string>",
"status": "Canceled",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
},
"vin": "<string>",
"url": "<string>"
}
Authorizations
Access Token Authentication
Path Parameters
The id of the Guided Onboarding Session
Response
A guided onboarding session
The company name displayed on the UI of the guided onboarding
The id of the guided onboarding session
The date and time the guided onboarding session was created
Is true
when the guided onboarding session is expired, false
otherwise
The manufacturer of the Entity that will be onboarded through the guided onboarding session
Represents an onboarding request
Represents an action for an onboarding request
The date and time the onboarding request was created.
Represents the data of an onboarding request
Represents data required to onboard a Collective
The id of the Collective
The name of the Collective
The owner of the Collective
The custom properties of the Collective
The id of the Tenant of the Collective
Household
, Fleet
, SolarFarm
, VirtualPowerPlant
Represents data required to onboard an Entity
The id of the Collective the Entity belongs to.
The id of the Entity
Represents information about an Entity
The code of an Entity
The EAN number of an Entity
The email address used for onboarding an Entity
The manufacturer of an Entity
The model of an Entity
The reference of an Entity
The track for an Entity
Battery
, Boiler
, ChargePole
, EV
, HeatPump
, PV
, RetrofitMeter
, SmartMeter
The unique identifier of an Entity
The Vehicle Identification Number of an Entity
The id of the owner of the Entity
The custom properties of the Entity
The system properties of the Entity
The id of the Tenant the Entity belongs to
Battery
, Boiler
, ChargePole
, EV
, HeatPump
, PV
, RetrofitMeter
, SmartMeter
Represents data required to onboard a Tenant
Company
, Educational
The id of the administrator of the Tenant
The id of the Tenant
The name of the Tenant
Represents data required to onboard a User
The id of the Collective the User belongs to
The email address of the User
The given name of the User
The id of the User
The language of the User
The surname of the User
The id of the Tenant the User belongs to
Represents data required to onboard a Client
The id of the Client
The name of the Client
The id of the Tenant the Client belongs to
Indicates whether the Client is a tenant admin
The id of the onboarding request
The id of the principal that initiated the onboarding request
Collective
, Entity
, Tenant
, User
, Client
The url where the User will be redirected to after completing the consent flow on the OEM page.
Canceled
, Failed
, InProgress
, Pending
, Succeeded
The VIN of the Entity that will be onboarded through the guided onboarding session
The url where the guided onboarding session can be accessed
Was this page helpful?
curl --request GET \
--url https://platform.realto.io/api/v1/guided-onboarding-sessions/{onboardingSessionId} \
--header 'Authorization: Bearer <token>'
{
"companyName": "<string>",
"created": "2023-11-07T05:31:56Z",
"expired": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"manufacturer": "<string>",
"onboardingRequest": {
"action": {
"documentationLink": "<string>",
"redirectLink": "<string>",
"type": "Consent"
},
"created": "2023-11-07T05:31:56Z",
"data": {
"collective": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<any>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Household"
},
"entity": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"information": {
"code": "<string>",
"ean": "<string>",
"email": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"reference": "<string>",
"track": "<string>",
"type": "Battery",
"uuid": "<string>",
"vin": "<string>"
},
"owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": "<any>",
"reference": {
"manufacturer": "<string>",
"type": "<string>",
"reference": "<string>"
},
"systemProperties": "<any>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Battery"
},
"tenant": {
"type": "Company",
"administrator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"user": {
"collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"givenName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"surname": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"client": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isTenantAdmin": true
}
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestType": "Collective",
"returnUrl": "<string>",
"status": "Canceled",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
},
"vin": "<string>",
"url": "<string>"
}