Contrato histórico: PUT update-driver-group
Contrato histórico de API. Esta página describe un contrato anterior. Los métodos, las rutas y las respuestas pueden diferir de la API vigente.
Significado histórico
Editar grupo de repartidores
Este endpoint de la API se utiliza para editar un grupo de repartidores.
API vigente
Para desarrollar una integración nueva, consulta la referencia o guía vigente enlazada.
Ver la referencia de la API vigenteParámetros
[
{
"name": "language",
"in": "path",
"schema": {
"type": "string",
"default": "en"
},
"required": true
},
{
"name": "project",
"in": "path",
"schema": {
"type": "string",
"default": "<redacted-personal>"
},
"required": true
},
{
"name": "drivergroup_id",
"in": "path",
"schema": {
"type": "integer",
"format": "int32"
},
"required": true
},
{
"name": "api_version",
"in": "path",
"schema": {
"type": "string",
"default": "v400"
},
"required": true
}
]
Cuerpo de solicitud
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"administrator_id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"drivers": {
"type": "string",
"format": "json"
},
"enabled": {
"type": "boolean"
}
}
}
}
}
}
Respuestas
{
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": false,\n \"result\": {\n \"id\": 3,\n \"administrator_id\": 8,\n \"name\": \"<redacted-personal>\",\n \"enabled\": true,\n \"created_at\": \"2018-11-29 23:21:06\",\n \"updated_at\": \"2018-11-29 23:21:06\",\n \"administrator\": {\n \"id\": 8,\n \"name\": \"<redacted-personal>\",\n \"lastname\": null,\n \"email\": \"<redacted-email>\",\n \"login_type\": 0,\n \"social_id\": null,\n \"photo\": null,\n \"birthdate\": null,\n \"phone\": null,\n \"cellphone\": null,\n \"city_id\": null,\n \"dropdown_option_id\": null,\n \"address\": null,\n \"address_notes\": null,\n \"zipcode\": null,\n \"location\": null,\n \"level\": 5,\n \"language_id\": 1,\n \"push_notifications\": true,\n \"busy\": false,\n \"available\": false,\n \"enabled\": true,\n \"created_at\": \"2018-10-08 15:56:23\",\n \"updated_at\": \"2018-10-08 15:56:23\",\n \"deleted_at\": null\n },\n \"drivers\": [\n {\n \"id\": 9,\n \"name\": \"<redacted-personal>\",\n \"lastname\": \"Bot\",\n \"email\": \"<redacted-email>\",\n \"login_type\": 0,\n \"social_id\": null,\n \"photo\": null,\n \"birthdate\": null,\n \"phone\": null,\n \"cellphone\": \"<redacted-personal>\",\n \"city_id\": 1,\n \"dropdown_option_id\": null,\n \"address\": \"<redacted-personal>\",\n \"address_notes\": null,\n \"zipcode\": null,\n \"location\": {\n \"lat\": 0,\n \"lng\": 0\n },\n \"level\": 4,\n \"language_id\": 1,\n \"push_notifications\": true,\n \"busy\": false,\n \"available\": true,\n \"enabled\": true,\n \"created_at\": \"2018-10-08 15:57:56\",\n \"updated_at\": \"2018-11-29 23:25:13\",\n \"deleted_at\": null,\n \"pivot\": {\n \"driver_group_id\": 3,\n \"driver_id\": 9\n }\n }\n ],\n \"business\": [\n {\n \"id\": 51,\n \"name\": \"<redacted-personal>\",\n \"email\": \"<redacted-email>\",\n \"slug\": \"takeawaymanchester\",\n \"schedule\": [\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n }\n ],\n \"description\": null,\n \"about\": null,\n \"logo\": null,\n \"header\": null,\n \"phone\": null,\n \"cellphone\": null,\n \"owner_id\": 1,\n \"city_id\": 1,\n \"address\": \"<redacted-personal>\",\n \"address_notes\": null,\n \"zipcode\": null,\n \"location\": {\n \"lat\": 53.478816582398984,\n \"lng\": -2.2408510183158836,\n \"zipcode\": -1,\n \"zoom\": 15\n },\n \"featured\": true,\n \"timezone\": \"Europe/London\",\n \"currency\": null,\n \"food\": true,\n \"alcohol\": false,\n \"groceries\": false,\n \"laundry\": false,\n \"use_printer\": false,\n \"printer_id\": null,\n \"minimum\": 0,\n \"delivery_price\": 0,\n \"always_deliver\": false,\n \"tax_type\": 1,\n \"tax\": 0,\n \"delivery_time\": null,\n \"pickup_time\": null,\n \"service_fee\": 5,\n \"fixed_usage_fee\": 0,\n \"percentage_usage_fee\": 0,\n \"enabled\": true,\n \"pivot\": {\n \"driver_group_id\": 3,\n \"business_id\": 0\n }\n }\n ]\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": false,
"default": true
},
"result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3,
"default": 0
},
"administrator_id": {
"type": "integer",
"example": 8,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2018-11-29 23:21:06"
},
"updated_at": {
"type": "string",
"example": "2018-11-29 23:21:06"
},
"administrator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 8,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"lastname": {},
"email": {
"type": "string",
"example": "<redacted-email>"
},
"login_type": {
"type": "integer",
"example": 0,
"default": 0
},
"social_id": {},
"photo": {},
"birthdate": {},
"phone": {},
"cellphone": {},
"city_id": {},
"dropdown_option_id": {},
"address": {},
"address_notes": {},
"zipcode": {},
"location": {},
"level": {
"type": "integer",
"example": 5,
"default": 0
},
"language_id": {
"type": "integer",
"example": 1,
"default": 0
},
"push_notifications": {
"type": "boolean",
"example": true,
"default": true
},
"busy": {
"type": "boolean",
"example": false,
"default": true
},
"available": {
"type": "boolean",
"example": false,
"default": true
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2018-10-08 15:56:23"
},
"updated_at": {
"type": "string",
"example": "2018-10-08 15:56:23"
},
"deleted_at": {}
}
},
"drivers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 9,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"lastname": {
"type": "string",
"example": "Bot"
},
"email": {
"type": "string",
"example": "<redacted-email>"
},
"login_type": {
"type": "integer",
"example": 0,
"default": 0
},
"social_id": {},
"photo": {},
"birthdate": {},
"phone": {},
"cellphone": {
"type": "string",
"example": "<redacted-personal>"
},
"city_id": {
"type": "integer",
"example": 1,
"default": 0
},
"dropdown_option_id": {},
"address": {
"type": "string",
"example": "<redacted-personal>"
},
"address_notes": {},
"zipcode": {},
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"example": 0,
"default": 0
},
"lng": {
"type": "number",
"example": 0,
"default": 0
}
}
},
"level": {
"type": "integer",
"example": 4,
"default": 0
},
"language_id": {
"type": "integer",
"example": 1,
"default": 0
},
"push_notifications": {
"type": "boolean",
"example": true,
"default": true
},
"busy": {
"type": "boolean",
"example": false,
"default": true
},
"available": {
"type": "boolean",
"example": true,
"default": true
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"created_at": {
"type": "string",
"example": "2018-10-08 15:57:56"
},
"updated_at": {
"type": "string",
"example": "2018-11-29 23:25:13"
},
"deleted_at": {},
"pivot": {
"type": "object",
"properties": {
"driver_group_id": {
"type": "integer",
"example": 3,
"default": 0
},
"driver_id": {
"type": "integer",
"example": 9,
"default": 0
}
}
}
}
}
},
"business": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 51,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"email": {
"type": "string",
"example": "<redacted-email>"
},
"slug": {
"type": "string",
"example": "takeawaymanchester"
},
"schedule": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"lapses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"example": 0,
"default": 0
},
"minute": {
"type": "integer",
"example": 0,
"default": 0
}
}
},
"close": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"example": 23,
"default": 0
},
"minute": {
"type": "integer",
"example": 59,
"default": 0
}
}
}
}
}
}
}
}
},
"description": {},
"about": {},
"logo": {},
"header": {},
"phone": {},
"cellphone": {},
"owner_id": {
"type": "integer",
"example": 1,
"default": 0
},
"city_id": {
"type": "integer",
"example": 1,
"default": 0
},
"address": {
"type": "string",
"example": "<redacted-personal>"
},
"address_notes": {},
"zipcode": {},
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"example": 53.478816582398984,
"default": 0
},
"lng": {
"type": "number",
"example": -2.2408510183158836,
"default": 0
},
"zipcode": {
"type": "integer",
"example": -1,
"default": 0
},
"zoom": {
"type": "integer",
"example": 15,
"default": 0
}
}
},
"featured": {
"type": "boolean",
"example": true,
"default": true
},
"timezone": {
"type": "string",
"example": "Europe/London"
},
"currency": {},
"food": {
"type": "boolean",
"example": true,
"default": true
},
"alcohol": {
"type": "boolean",
"example": false,
"default": true
},
"groceries": {
"type": "boolean",
"example": false,
"default": true
},
"laundry": {
"type": "boolean",
"example": false,
"default": true
},
"use_printer": {
"type": "boolean",
"example": false,
"default": true
},
"printer_id": {},
"minimum": {
"type": "integer",
"example": 0,
"default": 0
},
"delivery_price": {
"type": "integer",
"example": 0,
"default": 0
},
"always_deliver": {
"type": "boolean",
"example": false,
"default": true
},
"tax_type": {
"type": "integer",
"example": 1,
"default": 0
},
"tax": {
"type": "integer",
"example": 0,
"default": 0
},
"delivery_time": {},
"pickup_time": {},
"service_fee": {
"type": "integer",
"example": 5,
"default": 0
},
"fixed_usage_fee": {
"type": "integer",
"example": 0,
"default": 0
},
"percentage_usage_fee": {
"type": "integer",
"example": 0,
"default": 0
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"pivot": {
"type": "object",
"properties": {
"driver_group_id": {
"type": "integer",
"example": 3,
"default": 0
},
"business_id": {
"type": "integer",
"example": 0,
"default": 0
}
}
}
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"The driver group could not be updated\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "The driver group could not be updated"
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"You do not have permission.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "You do not have permission."
}
}
}
}
}
}
}
}