Assignments
Create assignment¶
POST
Request parameters
Name | Type | Location | Description |
---|---|---|---|
Secret | string | header | A secret defined for your customer at the Developer page of the flinkey Portal to secure the requests of the webhook. |
Target-Webhook-Address | string | header | A freely selectable address at which webhook can be received. For example: https://webhook.site |
Request body
{
"type": "object",
"properties": {
"checksum": {
"type": "string"
},
"assignmentId": {
"type": [
"number",
"null"
],
"format": "int32"
},
"carId": {
"type": "number",
"format": "int32"
},
"userId": {
"type": "number",
"format": "int32"
},
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"customerId": {
"type": "number",
"format": "int32"
},
"operationSucceeded": {
"type": "boolean"
},
"errorMessage": {
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"number",
"null"
],
"format": "int32"
},
"renewableAfter": {
"type": [
"number",
"null"
],
"format": "int32"
}
}
}
Update assignment¶
POST
Request parameters
Name | Type | Location | Description |
---|---|---|---|
Secret | string | header | A secret defined for your customer at the Developer page of the flinkey Portal to secure the requests of the webhook. |
Target-Webhook-Address | string | header | A freely selectable address at which webhook can be received. For example: https://webhook.site |
Request body
{
"type": "object",
"properties": {
"checksum": {
"type": "string"
},
"assignmentId": {
"type": "number",
"format": "int32"
},
"customerId": {
"type": "number",
"format": "int32"
},
"operationSucceeded": {
"type": "boolean"
},
"errorMessage": {
"type": [
"string",
"null"
]
},
"updateData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/carId",
"/userId",
"/start",
"/end",
"/lifetime",
"/renewableAfter"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
}
}
}
}
Delete assignment¶
POST
Request parameters
Name | Type | Location | Description |
---|---|---|---|
Secret | string | header | A secret defined for your customer at the Developer page of the flinkey Portal to secure the requests of the webhook. |
Target-Webhook-Address | string | header | A freely selectable address at which webhook can be received. For example: https://webhook.site |
Request body
{
"type": "object",
"properties": {
"checksum": {
"type": "string"
},
"assignmentId": {
"type": "number",
"format": "int32"
},
"customerId": {
"type": "number",
"format": "int32"
},
"operationSucceeded": {
"type": "boolean"
},
"errorMessage": {
"type": [
"string",
"null"
]
}
}
}