Get Recurring Routes
Changed onget/routes/recurring
Request
- Base URLhttps://dc-region.zuperpro.com/api
- URLhttps://dc-region.zuperpro.com/api/routes/recurring
- AuthAPI key in header x-api-key
Query parameters
pageinteger
countinteger
sort'DESC' | 'ASC'
sort_by'created_at' | 'recurring_route_name'
filter.keywordstring
filter.assigned_tostring
filter.created_bystring
filter.from_datestring date
filter.to_datestring date
filter.recurring_jobs_uidstring
Response
200
Example response
{
"type": "success",
"data": [
{
"recurring_route_uid": "f9d2996f-7bcb-4efc-9d60-1510156e29f0",
"recurring_route_name": "test recurring route 1",
"recurring_route_description": "test recurring route",
"duration": {
"value": 1,
"type": "WEEKS"
},
"repeat_frequency": "WEEKLY",
"repeat_on": {
"byweekday": [
{
"weekday": 3
}
]
},
"rrule": "DTSTART=20240919T110000Z;FREQ=WEEKLY;BYDAY=TH;UNTIL=20241019T110000",
"total_routes": 5,
"route_duration": 8,
"route_start": "2024-09-19T11:00:00.000Z",
"route_end": "2024-10-17T19:00:00.000Z",
"route_type": "FASTEST",
"transport_mode": "CAR",
"color": "#27ae60",
"start_location": {
"name": "Chennai",
"street": "Chennai domestic airport, Airport Departures Terminal Link, Meenambakkam",
"geo_cords": [
12.9826161
]
},
"end_location": {
"name": "Chennai",
"street": "Sholinganallur, Semmancheri",
"geo_cords": [
12.8594766
]
},
"assigned_to": [
{
"user": {
"user_uid": "fea19530-406f-11e8-b99a-59f39b812a88",
"first_name": "Henry",
"last_name": "Jones",
"email": "zuper.fe@ranjith.dev",
"home_phone_number": "6383917712",
"designation": "Devt",
"emp_code": "11345",
"work_phone_number": "9750183839",
"profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/b7b1dab9-a583-498c-b41a-7584a1436622.jpg",
"hourly_labor_charge": 99.99,
"is_active": true,
"created_at": "2018-04-15T05:43:59.000Z",
"updated_at": "2024-09-13T08:07:30.000Z",
"role": {
"role_name": "Field Executive",
"role_key": "FIELD_EXECUTIVE"
}
},
"team": {
"team_uid": "beeb0c3c-bb1b-4e5d-90c1-b465f1a1ceb9",
"team_name": "Team Android",
"team_color": "#0c9b24",
"is_active": true
}
}
],
"is_active": true,
"created_by": {
"user_uid": "1eb1d499-e8b1-4979-a04b-4b0599599529",
"first_name": "Ashin",
"last_name": "Thankachan",
"email": "ashin.t@zuper.co",
"designation": "Admin",
"emp_code": "Z103",
"work_phone_number": "8301907278",
"profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/d26d3dd0-0c47-11ee-b705-491517420371.jpg",
"hourly_labor_charge": 120,
"is_active": true,
"created_at": "2022-07-04T06:25:56.000Z",
"updated_at": "2024-09-02T09:26:10.000Z",
"role": {
"role_name": "Admin",
"role_key": "ADMIN"
}
},
"recurring_jobs": [
{
"recurring_job": {
"recurring_job_uid": "5f389163-be4d-4dfc-8665-17fa8b8d4abb",
"job_title": "12th Jul Test new filters"
}
}
],
"total_distance": 25756,
"total_time": 3214,
"id": "undefined"
}
],
"total_records": 359,
"current_page": 1,
"total_pages": 359
}Changes
- info
endpoint added
- info