curl --request PATCH \
--url https://prd.der-connect.eliagroup.eu/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>",
"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>",
"type": "Battery"
}
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestType": "Collective",
"returnUrl": "<string>",
"status": "Canceled",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}
Cancels the specified Collective Onboarding Request and returns that Collective Onboarding Request with updated status.
curl --request PATCH \
--url https://prd.der-connect.eliagroup.eu/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>",
"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>",
"type": "Battery"
}
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestType": "Collective",
"returnUrl": "<string>",
"status": "Canceled",
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}
Access Token Authentication
The id of the Collective Onboarding Request.
OK
Represents an onboarding request
Was this page helpful?