Difference between revisions of "Glass America Territories"
Ashley DeBon (talk | contribs) (Created page with "== Get Glass America Territories == === Base URL === https://apimobile.callproof.com === Endpoint === /api/glass-america/territories === Purpose === Retrieves the list of G...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Get Glass America Territories == | + | == [[Mobile_API]] »Get Glass America Territories == |
=== Base URL === | === Base URL === | ||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/glass-america/territories' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Phpsessid: YOUR_OMEGA_SESSION_ID' \ --header 'Cookie1: YOUR_OMEGA_COOKIE_VALUE' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/glass-america/territories' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Phpsessid: YOUR_OMEGA_SESSION_ID' \ --header 'Cookie1: YOUR_OMEGA_COOKIE_VALUE' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 14:28, 21 July 2026
Mobile_API »Get Glass America Territories
Base URL
https://apimobile.callproof.com
Endpoint
/api/glass-america/territories
Purpose
Retrieves the list of Glass America / Omega territories available for dashboard filtering. Territory data is loaded from the external Omega EDI territories service and returned as a simplified id/name list.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
| Phpsessid | Yes | Omega EDI session identifier used for the external territories request |
| Cookie1 | Yes | Omega EDI cookie value used for the external territories request |
Security
- Yes – Requires Bearer Token authentication (and two-factor authentication middleware applied to this route group).
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/glass-america/territories' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Phpsessid: YOUR_OMEGA_SESSION_ID' \ --header 'Cookie1: YOUR_OMEGA_COOKIE_VALUE'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/glass-america/territories' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Phpsessid: YOUR_OMEGA_SESSION_ID' \ --header 'Cookie1: YOUR_OMEGA_COOKIE_VALUE'
Successful Response (200)
Returns the territories list for dashboard use.
| 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 | Territories payload |
| uri | string | Requested resource URI |
data.territories_details[]
| Field | Type | Description |
|---|---|---|
| id | integer/string | Unique identifier of the territory |
| name | string | Territory display name |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – territories could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – External Omega territories request failed, or another error occurred while loading territories.
- 401 – Authentication failed or the access token is missing/expired.
