CRM · Utilities
Customer Requests
What the public and portal customers asked for — start, stop or move service, a leak or an outage, an arrangement — waiting for somebody to review it.
/api/crm/util-requestsPublished as /api/v1/util-requestsDownload specification (OpenAPI 3.1) Screen: Customer Requests
Overview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Customer Requests on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.util_requests · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/util-requestsList customer requests
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"request_no": "REQ-000001",
"request_type": "text",
"channel": "text",
"status": "draft",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"portal_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"problem_type": "text",
"full_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"address_text": "text",
"postal_code": "POS-000001"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/util-requests?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-requests/{id}Read one customer request
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"request_no": "REQ-000001",
"request_type": "text",
"channel": "text",
"status": "draft",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"portal_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"problem_type": "text",
"full_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"address_text": "text",
"postal_code": "POS-000001"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-requests/{id}/acceptAccept
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
noteResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/accept" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-requests/{id}/declineDecline
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
noteResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decline" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-requests/{id}/spamSpam
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
noteResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/spam" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-requests/{id}/doneDone
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
noteResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/done" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-requests/{id}/to-orderTo order
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
premise_idResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/to-order" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"premise_id":"value"}'GET/api/crm/util-requests/{id}/premise-matchesPremise matches
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/premise-matches" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-requests/{id}/match-premiseMatch premise
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
premise_idResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/match-premise" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"premise_id":"value"}'POST/api/crm/util-requestsPost customer requests
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-requests" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-requests/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/crm/util-requests/{id}Put customer requests
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/crm/util-requests/{id}Delete customer requests
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/util-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a customer request, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
request_no | text | read only | Request no |
request_type | text | read only | Request type |
channel | text | read only | Channel |
status | text | read only | Status |
service_account_id | uuid | read only | Service account id |
portal_user_id | uuid | read only | Portal user id |
problem_type | text | read only | Problem type |
full_name | text | read only | Full name |
email | text | read only | |
phone | text | read only | Phone |
address_text | text | read only | Address text |
postal_code | text | read only | Postal code |
requested_date | date | read only | Requested date |
details | text | read only | Details |
source_ip | text | read only | Source ip |
service_order_id | uuid | read only | Service order id |
reviewed_by | uuid | read only | Reviewed by |
reviewed_at | timestamp with time zone | read only | Reviewed at |
review_note | text | read only | Review note |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
premise_id | uuid | read only | Premise id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Customer Requests for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.