Collective Onboarding
Cancel a Collective Onboarding Request
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
Collective Onboarding
Cancel a Collective Onboarding Request
Cancels the specified Collective Onboarding Request and returns that Collective Onboarding Request with updated status.
PATCH
/
v1
/
onboarding
/
collectives
/
{onboardingRequestId}
/
cancel
curl --request PATCH \
--url https://platform.realto.io/api/v1/onboarding/collectives/{onboardingRequestId}/cancel \
--header 'Authorization: Bearer <token>'
{
"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>"
}
]
}
Authorizations
Access Token Authentication
Path Parameters
The id of the Collective Onboarding Request.
Response
200
application/json
OK
Represents an onboarding request
Was this page helpful?
curl --request PATCH \
--url https://platform.realto.io/api/v1/onboarding/collectives/{onboardingRequestId}/cancel \
--header 'Authorization: Bearer <token>'
{
"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>"
}
]
}