Ashley DeBon: /* Successful Response (200) */

2026-07-20T09:19:52Z

‎Successful Response (200)

Ashley DeBon: /* Get Assigned Routes */

2026-07-20T09:19:21Z

‎Get Assigned Routes

Ashley DeBon: Created page with "== Get Assigned Routes == === Base URL === https://apimobile.callproof.com === Endpoint === /api/get-assign-routes === Purpose === Retrieves routes assigned to users in the..."

2026-07-20T09:19:09Z

Created page with "== Get Assigned Routes == === Base URL === https://apimobile.callproof.com === Endpoint === /api/get-assign-routes === Purpose === Retrieves routes assigned to users in the..."

New page

== Get Assigned Routes ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/get-assign-routes

=== Purpose ===
Retrieves routes assigned to users in the same market as the authenticated user, excluding routes the authenticated user owns. Useful for seeing routes assigned by others that are relevant to the user’s market.

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
None.

=== Successful Response (200) ===
Returns assigned routes for the user’s market.

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| user_id || integer || Identifier of the authenticated user
|-
| company_id || integer || Identifier of the authenticated user’s company
|-
| data || object || Assigned routes payload
|-
| uri || string || Requested resource URI
|}

==== data.route_details[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| route_id || integer || Unique identifier of the route
|-
| route_name || string || Route name
|-
| route_assigned_by_id || integer/string || User ID of the person who assigned the route (empty string when not set)
|-
| route_assigned_by_name || string || Full name of the person who assigned the route
|-
| created || string || Created timestamp (format: <code>Y-m-d H:i:s</code>), or empty string when unavailable
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – assigned routes could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''400''' – An error occurred while retrieving routes (for example, "Error while retriving the routes").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 09:19, 20 July 2026
Line 1:		Line 1:
−	== Get Assigned Routes ==	+	== [[Mobile_API]] »Get Assigned Routes ==

	=== Base URL ===		=== Base URL ===

@@ Line 33: / Line 33: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Get Assigned Routes - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Get Assigned Routes */

Ashley DeBon: Created page with "== Get Assigned Routes == === Base URL === https://apimobile.callproof.com === Endpoint === /api/get-assign-routes === Purpose === Retrieves routes assigned to users in the..."