{ "item": [ { "name": "api", "description": "", "item": [ { "name": "client", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "requests", "description": "", "item": [ { "id": "c00c3dfd-3531-416b-840a-5b52a2012aa0", "name": "List requests", "request": { "name": "List requests", "description": { "content": "Retrieve a paginated list of requests (fault reports and work orders) for the authenticated agent. Supports keyword search, status filtering, date range filtering, and custom sorting.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1b581ce3-b93d-4805-b094-2e76fc5f4cde", "name": "List of requests retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"pending\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"canceled\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n }\n ],\n \"page\": \"\",\n \"per_page\": \"\",\n \"total_pages\": \"\",\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28c5a0e9-7e24-4b54-a135-698d10780fe4", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a62b6e8f-1df1-4589-9716-d61199f0a766", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "all_status", "description": "", "item": [ { "id": "5f9e7f00-bf62-471b-85a9-f2e9eecbebf5", "name": "Get all request statuses", "request": { "name": "Get all request statuses", "description": { "content": "Retrieve the complete list of available request lifecycle statuses and configured custom workflow statuses for the agent.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests", "all_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f1045c3f-d924-419a-984b-685490aa2db6", "name": "List of request statuses retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "all_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"value\": \"\",\n \"title\": \"\"\n },\n {\n \"value\": \"\",\n \"title\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c15d5fd1-c2ae-4f4e-bb6d-6c3b06660b7f", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "all_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "report_fault", "description": "", "item": [ { "id": "6995c9ba-4eb1-4137-a2a9-c6586b586edb", "name": "Create fault report", "request": { "name": "Create fault report", "description": { "content": "Submit a new fault report using pre-uploaded attachment IDs and existing requestor UID. Returns the newly created request record.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests", "report_fault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requestor_uid\": \"\",\n \"description\": \"\",\n \"fault_location\": \"\",\n \"fault_type_id\": \"\",\n \"fault_sub_type_id\": \"\",\n \"fault_location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"fault_attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7a793e3e-5f39-4dc3-8aa0-e4d024f9a547", "name": "Fault report created successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requestor_uid\": \"\",\n \"description\": \"\",\n \"fault_location\": \"\",\n \"fault_type_id\": \"\",\n \"fault_sub_type_id\": \"\",\n \"fault_location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"fault_attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"pending\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7bb8856-1de5-4095-932e-1f17f5025930", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requestor_uid\": \"\",\n \"description\": \"\",\n \"fault_location\": \"\",\n \"fault_type_id\": \"\",\n \"fault_sub_type_id\": \"\",\n \"fault_location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"fault_attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35393abc-1523-4433-b515-108b71b6cb8b", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requestor_uid\": \"\",\n \"description\": \"\",\n \"fault_location\": \"\",\n \"fault_type_id\": \"\",\n \"fault_sub_type_id\": \"\",\n \"fault_location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"fault_attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11e9efa-269a-4436-8955-99a03c7a27c0", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"requestor_uid\": \"\",\n \"description\": \"\",\n \"fault_location\": \"\",\n \"fault_type_id\": \"\",\n \"fault_sub_type_id\": \"\",\n \"fault_location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"fault_attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "upload_fault_attachment", "description": "", "item": [ { "id": "707552af-0a00-4b3b-9b01-d01d89c56427", "name": "Upload fault attachment", "request": { "name": "Upload fault attachment", "description": { "content": "Upload an image or video attachment for a fault report prior to submission. Returns the created attachment details including ID and URL.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests", "upload_fault_attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image or video file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fda26f35-900d-41e5-aa1d-1b8fbd21e761", "name": "Attachment uploaded successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "upload_fault_attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image or video file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fa15717-2271-4165-8025-679c16d06634", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "upload_fault_attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image or video file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94081215-641e-45df-963f-82f4cafed5aa", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "upload_fault_attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Image or video file to upload", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "report_fault_with_files", "description": "", "item": [ { "id": "588a57c5-fa32-4dbd-9b39-2d811859e026", "name": "Create fault report with files", "request": { "name": "Create fault report with files", "description": { "content": "Submit a new fault report and upload media files directly in a single multipart/form-data request. Maximum 5 files allowed. Returns the newly created request record.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e00a5470-ebef-4004-b87f-f5673d2dacb9", "name": "Fault report created successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"pending\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f608bf11-07b7-4c16-a30e-19ca72390b86", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "809f182f-ca85-481d-bd2d-c951c84cb14e", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f80a2145-dadc-474f-ae84-aac13bd7e027", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "report_fault_with_files_v2", "description": "", "item": [ { "id": "bcb865f2-5145-429e-8328-16f0b61c53a1", "name": "Create fault report with files (V2)", "request": { "name": "Create fault report with files (V2)", "description": { "content": "Submit a new fault report with auto-creation of the requestor profile if not found, priority specification, and media file attachments in a single multipart/form-data request. Returns the newly created request record.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files_v2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) First name of the requestor (created if does not exist)", "type": "text/plain" }, "key": "first_name", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "Urgency priority level", "type": "text/plain" }, "key": "priority", "value": "low", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0b8ddbd3-3a47-468b-833d-88df84cf5222", "name": "Fault report created successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files_v2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) First name of the requestor (created if does not exist)", "type": "text/plain" }, "key": "first_name", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "Urgency priority level", "type": "text/plain" }, "key": "priority", "value": "low", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"pending\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ebf8d6-60f0-4eb9-80de-1cebbbd674c2", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files_v2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) First name of the requestor (created if does not exist)", "type": "text/plain" }, "key": "first_name", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "Urgency priority level", "type": "text/plain" }, "key": "priority", "value": "low", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78052ddd-5456-470c-9382-240658635732", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files_v2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) First name of the requestor (created if does not exist)", "type": "text/plain" }, "key": "first_name", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "Urgency priority level", "type": "text/plain" }, "key": "priority", "value": "low", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b76e09f4-4727-4171-a5c2-30743082c0e9", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "report_fault_with_files_v2" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) UID of the requestor", "type": "text/plain" }, "key": "requestor_uid", "value": "", "type": "text" }, { "description": { "content": "(Required) First name of the requestor (created if does not exist)", "type": "text/plain" }, "key": "first_name", "value": "", "type": "text" }, { "description": { "content": "(Required) Detailed fault description", "type": "text/plain" }, "key": "description", "value": "", "type": "text" }, { "description": { "content": "(Required) Specific location where the fault occurred", "type": "text/plain" }, "key": "fault_location", "value": "", "type": "text" }, { "description": { "content": "Urgency priority level", "type": "text/plain" }, "key": "priority", "value": "low", "type": "text" }, { "description": { "content": "ID of the fault type category", "type": "text/plain" }, "key": "fault_type_id", "value": "", "type": "text" }, { "description": { "content": "ID of the fault sub-type", "type": "text/plain" }, "key": "fault_sub_type_id", "value": "", "type": "text" }, { "description": { "content": "JSON string array of location tag IDs (e.g. \"[101, 102]\")", "type": "text/plain" }, "key": "fault_location_tag_ids", "value": "", "type": "text" }, { "description": { "content": "Optional media files to attach (maximum 5 files)", "type": "text/plain" }, "key": "files", "value": ",", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "service_request", "description": "", "item": [ { "id": "d1c7bbe4-67bd-4b28-9d95-b2e64a83fbfe", "name": "Create service request", "request": { "name": "Create service request", "description": { "content": "Submit a custom service request based on a configured Request Type. Requires a valid request type ID, requestor UID, and dynamic JSON meta_data payload matching the request type form fields.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests", "service_request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_type_id\": \"\",\n \"meta_data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestor_uid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fac93c65-d824-4316-93ec-6a02a43ba6dc", "name": "Service request created successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "service_request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_type_id\": \"\",\n \"meta_data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestor_uid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"canceled\",\n \"priority\": \"urgent\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35e7f1e6-685a-4476-883e-b3d7a3ca1f1f", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "service_request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_type_id\": \"\",\n \"meta_data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestor_uid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fb46cd0-6fdc-41bf-9196-ddb6c20338db", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "service_request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_type_id\": \"\",\n \"meta_data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestor_uid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfead334-8f65-4ab3-ab87-33f6436f25e7", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", "service_request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_type_id\": \"\",\n \"meta_data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"compulsory\": \"\",\n \"title\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n }\n ],\n \"requestor_uid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{id}", "description": "", "item": [ { "id": "5bbca511-d12e-4716-9910-0429a8ae1863", "name": "Detail a request", "request": { "name": "Detail a request", "description": { "content": "Retrieve comprehensive details of a specific request by ID, including fault details, media attachments, requestor information, assigned managers, and activity notes.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ef1094e6-c6bb-41d8-9d7e-c98f6d93575b", "name": "Request details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"pending\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a19f0f82-e61a-4c08-8606-36f4c1ef546f", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb814892-3a3b-4316-97a5-b3e36c2fc6fa", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e217edc-ee57-473e-80fd-243f859df84f", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "status", "description": "", "item": [ { "id": "bf3259fa-c352-4b08-828f-f865cdf46cb1", "name": "Update request status", "request": { "name": "Update request status", "description": { "content": "Update the lifecycle status of a request (e.g. processing, complete, canceled, or custom statuses). Can include resolution/cancellation remarks and optional evidence photos/files (maximum 5 files).\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requests", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"remarks\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d3141b29-204f-4366-a20f-b17b34069aa3", "name": "Request status updated successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"remarks\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"pending\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8276c9f9-8db5-4029-9272-eab99a31c829", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"remarks\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3781a467-694a-4063-b692-d355518b7bad", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"remarks\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c120372-054f-4878-9e68-c67482ebe5b8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requests", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"remarks\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "request_types", "description": "", "item": [ { "id": "f8d331ed-9d5e-4f01-b7e7-8f8789cef499", "name": "List available request types", "request": { "name": "List available request types", "description": { "content": "Returns all request types configured for the authenticated agent/manager. Results can be filtered by a search query string and sorted by name, sortable number, or creation timestamp.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "request_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request type name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field to sort results by (This can only be one of name,sortable_number,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "sortable_number" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e653ba0e-e876-44fd-96fc-bfd44b0d705d", "name": "List of request types retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request type name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field to sort results by (This can only be one of name,sortable_number,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "sortable_number" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"sortable_number\": \"\",\n \"meta_data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"compulsory\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"compulsory\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"sortable_number\": \"\",\n \"meta_data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"compulsory\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"compulsory\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52f1c323-3537-43ba-b32d-dd04df1af710", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request type name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field to sort results by (This can only be one of name,sortable_number,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "sortable_number" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e97273d3-896e-4dae-84f1-3b57ba1660cf", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request type name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field to sort results by (This can only be one of name,sortable_number,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "sortable_number" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "a93e0ac1-0b6f-481e-be5a-4d3ea6ad14f5", "name": "Show request type details", "request": { "name": "Show request type details", "description": { "content": "Retrieve detailed configuration, metadata, and dynamic input fields for a specific request type.", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "request_types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique identifier of the request type", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8ebd1ab8-d062-47c3-9b70-e0c3ef4f052e", "name": "Request type details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"sortable_number\": \"\",\n \"meta_data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"compulsory\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"compulsory\": \"\",\n \"placeholder\": \"\",\n \"max_email_limit\": \"\",\n \"value\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "345d23ca-3c52-4669-aff0-e2b7c80e2710", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e259b469-1b9d-4403-b0bd-58093a0606cc", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "order_items", "description": "", "item": [ { "id": "93495185-0675-4840-8c2b-613465a5e059", "name": "List order items for a request type", "request": { "name": "List order items for a request type", "description": { "content": "Retrieve the catalog of order items, parts, or billable services linked to this request type.", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "request_types", ":id", "order_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique identifier of the request type", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c23b891c-ac20-4dad-8ae0-013f6aa047e3", "name": "List of order items retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types", ":id", "order_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"no\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"price_text\": \"\",\n \"image\": \"\",\n \"image_name\": \"\",\n \"order_type_id\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"maximum_quantity\": \"\"\n },\n {\n \"id\": \"\",\n \"no\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"price_text\": \"\",\n \"image\": \"\",\n \"image_name\": \"\",\n \"order_type_id\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"maximum_quantity\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09acefbf-ade0-469e-8efb-246ffa3e223d", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types", ":id", "order_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05dae702-361f-4210-958f-88c76ac12bde", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "request_types", ":id", "order_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the request type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "facility_bookings", "description": "", "item": [ { "id": "fd6e18c7-cd62-40c7-be46-e2194441a736", "name": "Return all facility bookings", "request": { "name": "Return all facility bookings", "description": { "content": "Retrieve a paginated list of completed facility bookings for the authenticated agent/manager. Supports search query and date filtering by booking start time.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "facility_bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching booking details", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter bookings starting on or after this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter bookings ending on or before this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field to sort results by (This can only be one of id,start_time,end_time,check_in_at,name)", "type": "text/plain" }, "key": "data_sort", "value": "start_time" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "81b42e8d-c759-450b-a35b-e878c8ea8f1c", "name": "List of facility bookings retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "facility_bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching booking details", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter bookings starting on or after this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter bookings ending on or before this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field to sort results by (This can only be one of id,start_time,end_time,check_in_at,name)", "type": "text/plain" }, "key": "data_sort", "value": "start_time" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"page\": \"\",\n \"per_page\": \"\",\n \"total_pages\": \"\",\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd42c2e0-2cda-4a37-a20a-b33b66631675", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "facility_bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching booking details", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter bookings starting on or after this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter bookings ending on or before this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field to sort results by (This can only be one of id,start_time,end_time,check_in_at,name)", "type": "text/plain" }, "key": "data_sort", "value": "start_time" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "313b81bf-e0c0-4a61-80a1-5b8e466ecbb6", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "facility_bookings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching booking details", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter bookings starting on or after this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter bookings ending on or before this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field to sort results by (This can only be one of id,start_time,end_time,check_in_at,name)", "type": "text/plain" }, "key": "data_sort", "value": "start_time" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "18ecd950-dedd-487e-930e-5d4a458d726e", "name": "Return details a facility booking", "request": { "name": "Return details a facility booking", "description": { "content": "Retrieve detailed configuration, timing, guest information, and status for a specific facility booking.", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "facility_bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique identifier of the facility booking", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "64314372-574f-417e-9a82-47079d19c446", "name": "Facility booking details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "facility_bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the facility booking", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"facility_setting_id\": \"\",\n \"name\": \"\",\n \"purpose\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"guest_name\": \"\",\n \"image_url\": \"\",\n \"check_in_at\": \"\",\n \"check_out_at\": \"\",\n \"booking_form\": {},\n \"start_time_timestamp\": \"\",\n \"end_time_timestamp\": \"\",\n \"created_at\": \"\",\n \"guest\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"full_name\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eca9c939-bd92-452a-92fd-ddf11ffd8413", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "facility_bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the facility booking", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "502f09b2-b097-4419-b3bd-a8dd0eb3aefb", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "facility_bookings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the facility booking", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "assets", "description": "", "item": [ { "id": "d00f21fd-a586-4a07-b280-a9d39ab8f136", "name": "Return all asset trackings", "request": { "name": "Return all asset trackings", "description": { "content": "Retrieve a paginated list of asset trackings for the authenticated agent. Supports free-text keyword search and customizable sorting.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching asset ID, description, brand, model, serial number, or location", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (e.g. id, created_at, asset_id)", "type": "text/plain" }, "key": "data_sort", "value": "id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "67b9e859-91fc-4ae7-a1ae-10e35afd547a", "name": "List of asset trackings retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching asset ID, description, brand, model, serial number, or location", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (e.g. id, created_at, asset_id)", "type": "text/plain" }, "key": "data_sort", "value": "id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\"\n }\n ],\n \"page\": \"\",\n \"per_page\": \"\",\n \"total_pages\": \"\",\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b22bef70-52b4-4b42-8fdd-26e285b2fcbd", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching asset ID, description, brand, model, serial number, or location", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (e.g. id, created_at, asset_id)", "type": "text/plain" }, "key": "data_sort", "value": "id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "689eb75c-7993-407e-b96f-a67d6968f6ff", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching asset ID, description, brand, model, serial number, or location", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (e.g. id, created_at, asset_id)", "type": "text/plain" }, "key": "data_sort", "value": "id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "7c255c09-fcf8-47dd-a6af-82d79dcfc459", "name": "Details of an asset tracking", "request": { "name": "Details of an asset tracking", "description": { "content": "Retrieve detailed specifications, warranty, purchase information, and custom fields for a specific asset tracking.", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique database identifier of the asset tracking", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4d7a0d14-c4c8-4ee5-95ba-b7cac191f739", "name": "Asset tracking details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the asset tracking", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\",\n \"created_at\": \"\",\n \"warranty_expiry_date\": \"\",\n \"purchase_date\": \"\",\n \"purchase_price\": \"\",\n \"asset_type_id\": \"\",\n \"custom_content\": {\n \"blocks\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"compulsory\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"compulsory\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63e0be88-0153-46cb-8e5c-fd6c0ba028fa", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the asset tracking", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3edaa11-74eb-4046-a2b0-3da60d6733ff", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "assets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the asset tracking", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "checklists", "description": "", "item": [ { "id": "1da27ac4-1a52-4753-8889-16e9d545fc13", "name": "Return all checklists", "request": { "name": "Return all checklists", "description": { "content": "Retrieve a paginated list of routine inspection checklists for the authenticated agent. Supports free-text keyword search, status filtering, date range filtering, and custom sorting.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "checklists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching checklist name or checklist ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter checklists created on or after this date (format YYYY-MM-DD). Must be provided together with end_date.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter checklists created on or before this date (format YYYY-MM-DD). Must be provided together with start_date.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by checklist status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a1d39a5d-0b24-44f2-aaf0-744e15eb9ee2", "name": "List of checklists retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "checklists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching checklist name or checklist ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter checklists created on or after this date (format YYYY-MM-DD). Must be provided together with end_date.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter checklists created on or before this date (format YYYY-MM-DD). Must be provided together with start_date.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by checklist status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"checklist_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"score\": \"\",\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"sign_off_by\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"linked_asset_ids\": [\n {\n \"asset_id\": \"\"\n },\n {\n \"asset_id\": \"\"\n }\n ],\n \"linked_location_tags\": [\n {\n \"id\": \"\",\n \"display_name\": \"\"\n },\n {\n \"id\": \"\",\n \"display_name\": \"\"\n }\n ],\n \"linked_customers\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"linked_labels\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"linked_checklists\": [\n {\n \"id\": \"\",\n \"checklist_id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"checklist_id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ],\n \"due_date\": {\n \"time\": \"\",\n \"label\": \"\"\n },\n \"remarks\": [\n {\n \"process_by\": \"\",\n \"remark\": \"\"\n },\n {\n \"process_by\": \"\",\n \"remark\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"processing_at\": \"\",\n \"complete_at\": \"\"\n },\n {\n \"id\": \"\",\n \"checklist_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"score\": \"\",\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"sign_off_by\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"linked_asset_ids\": [\n {\n \"asset_id\": \"\"\n },\n {\n \"asset_id\": \"\"\n }\n ],\n \"linked_location_tags\": [\n {\n \"id\": \"\",\n \"display_name\": \"\"\n },\n {\n \"id\": \"\",\n \"display_name\": \"\"\n }\n ],\n \"linked_customers\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"linked_labels\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"linked_checklists\": [\n {\n \"id\": \"\",\n \"checklist_id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"checklist_id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ],\n \"due_date\": {\n \"time\": \"\",\n \"label\": \"\"\n },\n \"remarks\": [\n {\n \"process_by\": \"\",\n \"remark\": \"\"\n },\n {\n \"process_by\": \"\",\n \"remark\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"processing_at\": \"\",\n \"complete_at\": \"\"\n }\n ],\n \"page\": \"\",\n \"per_page\": \"\",\n \"total_pages\": \"\",\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "225ceb1c-faf0-41bd-95ec-2ff8ef17897c", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "checklists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching checklist name or checklist ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter checklists created on or after this date (format YYYY-MM-DD). Must be provided together with end_date.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter checklists created on or before this date (format YYYY-MM-DD). Must be provided together with start_date.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by checklist status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "993f11a5-8b73-4d0f-8d68-7d345fa31807", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "checklists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching checklist name or checklist ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter checklists created on or after this date (format YYYY-MM-DD). Must be provided together with end_date.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter checklists created on or before this date (format YYYY-MM-DD). Must be provided together with start_date.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Filter by checklist status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "a24e3bd8-9d4e-45c2-8566-6c1095ccf3f3", "name": "Return a checklist", "request": { "name": "Return a checklist", "description": { "content": "Retrieve detailed checklist information including inspection rows, question blocks, assigned staff, linked assets/locations, and completion remarks by checklist ID.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "checklists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique database identifier of the checklist", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b223784a-3cac-476f-bc8f-0b53ace5fc5f", "name": "Checklist details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "checklists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the checklist", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"checklist_id\": \"\",\n \"complete_at\": \"\",\n \"created_at\": \"\",\n \"due_date\": {\n \"time\": \"\",\n \"label\": \"\"\n },\n \"id\": \"\",\n \"linked_asset_ids\": [\n {\n \"asset_id\": \"\"\n },\n {\n \"asset_id\": \"\"\n }\n ],\n \"linked_checklists\": [\n {\n \"id\": \"\",\n \"checklist_id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"checklist_id\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n }\n ],\n \"linked_customers\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"linked_labels\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"linked_location_tags\": [\n {\n \"id\": \"\",\n \"display_name\": \"\"\n },\n {\n \"id\": \"\",\n \"display_name\": \"\"\n }\n ],\n \"name\": \"\",\n \"processing_at\": \"\",\n \"remarks\": [\n {\n \"process_by\": \"\",\n \"remark\": \"\"\n },\n {\n \"process_by\": \"\",\n \"remark\": \"\"\n }\n ],\n \"rows\": [\n {\n \"id\": \"\",\n \"side_note\": \"\",\n \"description\": \"\",\n \"results\": [\n {\n \"type\": \"\",\n \"title\": \"\",\n \"hidden\": \"\",\n \"content\": \"\"\n },\n {\n \"type\": \"\",\n \"title\": \"\",\n \"hidden\": \"\",\n \"content\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"side_note\": \"\",\n \"description\": \"\",\n \"results\": [\n {\n \"type\": \"\",\n \"title\": \"\",\n \"hidden\": \"\",\n \"content\": \"\"\n },\n {\n \"type\": \"\",\n \"title\": \"\",\n \"hidden\": \"\",\n \"content\": \"\"\n }\n ]\n }\n ],\n \"score\": \"\",\n \"sign_off_by\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"status\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50ae539a-569d-452d-83e6-61be6c66b8f7", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "checklists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the checklist", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "241569e9-3d6c-42b1-8962-abe0d393dbb3", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "checklists", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the checklist", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "fault_types", "description": "", "item": [ { "id": "b3537479-a17b-49eb-8d54-2477ccff9ae7", "name": "Return all fault types", "request": { "name": "Return all fault types", "description": { "content": "Retrieve all fault types configured for the authenticated agent, including their associated sub-types. Supports keyword search and sorting.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "fault_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching fault type name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d4130fd9-5286-4cf3-9106-f7a336164c71", "name": "List of fault types retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "fault_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching fault type name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"fault_sub_type_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"fault_sub_type_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f13f3edb-8783-4dd7-b753-8b19135c363e", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "fault_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching fault type name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c1e2220-ca41-4689-8509-b7bf77e2f064", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "fault_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching fault type name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "asc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "2f704087-df76-46d5-a7e6-023a14d69746", "name": "Details of a fault type", "request": { "name": "Details of a fault type", "description": { "content": "Retrieve detailed information for a specific fault type by ID, including its associated sub-types.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "fault_types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique database identifier of the fault type", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "afe3b53e-a7b6-4a4d-bc1d-41b78dc84e1c", "name": "Fault type details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "fault_types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the fault type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"fault_sub_type_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95545d76-dec6-4bd3-a5c4-ec0712f9d527", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "fault_types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the fault type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa0e396c-6dd4-44ea-ade4-74912effb30c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "fault_types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the fault type", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "location_tags", "description": "", "item": [ { "id": "fa345082-fafa-4d09-90a6-63375691fe3b", "name": "Return all location tags", "request": { "name": "Return all location tags", "description": { "content": "Retrieve a paginated list of top-level location tags for the authenticated agent, including their nested sub-tags. Supports keyword search and sorting.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "location_tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching location name or hierarchy", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2ca7312e-e493-4318-ac39-239d6eef73e1", "name": "List of location tags retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "location_tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching location name or hierarchy", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"synonyms\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"sub_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"parent_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"synonyms\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"sub_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"parent_id\": \"\"\n }\n ],\n \"page\": \"\",\n \"per_page\": \"\",\n \"total_pages\": \"\",\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "544ded04-08a0-4cf9-9ba3-0ecf31383fd9", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "location_tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching location name or hierarchy", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a52eecb-fa59-4fda-9fe2-66a9387059f5", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "location_tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword matching location name or hierarchy", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page", "type": "text/plain" }, "key": "per_page", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "85ac0f00-7302-46d5-adb6-9d08ad453ff1", "name": "Details of a location tag", "request": { "name": "Details of a location tag", "description": { "content": "Retrieve detailed information for a specific location tag by ID, including its nested sub-tags.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "location_tags", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique database identifier of the location tag", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "91692d88-15ce-4cea-943e-7d0623c2be24", "name": "Location tag details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "location_tags", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the location tag", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"synonyms\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"sub_tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"parent_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b35045ae-d550-460a-b089-ccef123ce480", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "location_tags", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the location tag", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7d14130-caf1-4c52-8a06-c3879da2bcf6", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "location_tags", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the location tag", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "requestors", "description": "", "item": [ { "id": "c4408335-a367-41c7-9d34-e33bb8473cb9", "name": "Return all requestors", "request": { "name": "Return all requestors", "description": { "content": "Retrieve a paginated list of requestors (guests) for the authenticated agent. Supports keyword search across name and email, and sorting by creation date, source, or first name.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching requestor first name, last name, full name, or email", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of source,first_name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "819c8a58-04e9-4959-8656-fbbf0904181c", "name": "List of requestors retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching requestor first name, last name, full name, or email", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of source,first_name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"uid\": \"\",\n \"first_name\": \"\",\n \"full_name\": \"\",\n \"created_at\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n },\n {\n \"uid\": \"\",\n \"first_name\": \"\",\n \"full_name\": \"\",\n \"created_at\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n ],\n \"page\": \"\",\n \"per_page\": \"\",\n \"total_pages\": \"\",\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5d17d1f-34d5-4f6e-b340-90cffd1e4d12", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching requestor first name, last name, full name, or email", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of source,first_name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63584cc0-c369-4602-b02e-2a3dcac1cd95", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching requestor first name, last name, full name, or email", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of source,first_name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d314f5b-6710-45fe-a169-f7e658bd3398", "name": "Create a requestor", "request": { "name": "Create a requestor", "description": { "content": "Register a new requestor profile under the authenticated agent. The requestor UID must be unique within the agent.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requestors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uid\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b65466c3-1a8a-47ea-ab38-f038626031c3", "name": "Requestor created successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uid\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"uid\": \"\",\n \"first_name\": \"\",\n \"full_name\": \"\",\n \"created_at\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a05ae5a8-f7a6-4d71-a63e-41197751e43d", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uid\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6acb6946-fd96-407a-86db-a8a21b3707e9", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uid\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{uid}", "description": "", "item": [ { "id": "d4440486-625f-46e3-aea5-3c04da874612", "name": "Return a requestor", "request": { "name": "Return a requestor", "description": { "content": "Retrieve details of a specific requestor by unique identifier (UID).", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uid", "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4cc4c704-8c68-4d75-92e6-bd4629cea949", "name": "Requestor details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"uid\": \"\",\n \"first_name\": \"\",\n \"full_name\": \"\",\n \"created_at\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3364a25e-b3ab-40ae-b743-eed19822b7b8", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa8be1c3-f7e3-4a9e-aedf-ee316b58f366", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f513bd6b-b474-4833-b92c-da8b7e0b03c0", "name": "Update a requestor", "request": { "name": "Update a requestor", "description": { "content": "Update profile information for an existing requestor identified by UID.", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "uid", "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "445bb4d1-e393-4638-a42c-16c10d0a0709", "name": "Requestor updated successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"uid\": \"\",\n \"first_name\": \"\",\n \"full_name\": \"\",\n \"created_at\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d0d4ebe-8676-4409-9de0-920563b58a97", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f6ec0bf-c783-4a54-9549-5f651069da6a", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46c89665-4b8f-4bb1-85f6-afb6ff3efc4c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"\",\n \"last_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "requests", "description": "", "item": [ { "id": "f53228eb-5dff-4560-96b9-7daae1704737", "name": "Return all requests belongs to a requestor", "request": { "name": "Return all requests belongs to a requestor", "description": { "content": "Retrieve a paginated list of requests (fault reports and work orders) submitted by a specific requestor identified by UID. Supports keyword search, status filtering, date range filtering, and custom sorting.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requestors", ":uid", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "type": "any", "value": "", "key": "uid", "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b330ac5c-2050-46ea-afef-a0224393fb7e", "name": "List of requests retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"pending\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"kind\": \"\",\n \"status\": \"canceled\",\n \"priority\": \"low\",\n \"created_at\": \"\",\n \"case_id\": \"\",\n \"request_type\": \"\",\n \"fault_description\": \"\",\n \"custom_status\": \"\",\n \"fault_location\": \"\",\n \"fault_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_sub_type\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"fault_location_tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"fault_images\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"fault_videos\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"processing_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"complete_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ],\n \"requestor\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"source\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"full_name\": \"\",\n \"email\": \"\"\n },\n \"assign_to\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n ],\n \"notes\": [\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_by\": \"\",\n \"remarks\": \"\",\n \"created_at\": \"\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"content_type\": \"\",\n \"created_at\": \"\",\n \"has_virus\": \"\"\n }\n ]\n }\n ],\n \"require_attachment_processing\": \"\",\n \"require_attachment_complete\": \"\",\n \"processing_remarks\": \"\",\n \"completion_remarks\": \"\",\n \"processed_at\": \"\",\n \"closed_at\": \"\",\n \"linked_asset_trackings\": [\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n },\n {\n \"id\": \"\",\n \"asset_id\": \"\",\n \"asset_type\": \"\",\n \"location\": \"\",\n \"location_details\": \"\",\n \"description\": \"\",\n \"brand\": \"\",\n \"model_number\": \"\",\n \"serial_number\": \"\"\n }\n ]\n }\n ],\n \"page\": \"\",\n \"per_page\": \"\",\n \"total_pages\": \"\",\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7df90a75-962c-49df-9b87-bbdcc2dabb77", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51393c7e-c41a-4e5d-a58e-c49e7b5ac3f0", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d764f7ed-2730-4365-a90e-62a9e59b8748", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestors", ":uid", "requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search keyword matching request content or case ID", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter requests by status (This can only be one of pending,processing,canceled,complete)", "type": "text/plain" }, "key": "status", "value": "complete" }, { "disabled": false, "description": { "content": "Filter requests created on or after date (YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter requests created on or before date (YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of status,priority,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Requestor UID", "type": "text/plain" }, "type": "any", "value": "", "key": "uid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "requestor_tags", "description": "", "item": [ { "id": "1f18ad2f-8b4c-4988-9a92-1f6767863c9b", "name": "Return all requestor tags", "request": { "name": "Return all requestor tags", "description": { "content": "Retrieve all requestor tags for the authenticated agent, including the default \"All Requestors\" tag. Supports optional keyword search and ordering.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requestor_tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword to filter requestor tags by name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2cb49324-7f5f-4fa5-ac1a-f6b16511a5f7", "name": "List of requestor tags retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestor_tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword to filter requestor tags by name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a26800c8-aab5-4128-a788-25b28f51bf58", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestor_tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword to filter requestor tags by name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16cf3818-ff6c-489e-b6d0-f1e2f31bf82b", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestor_tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search keyword to filter requestor tags by name", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Field name to sort results by (This can only be one of name,created_at)", "type": "text/plain" }, "key": "data_sort", "value": "created_at" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "order_sort", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "6e645140-9034-4191-bdc9-8373a1e73d84", "name": "Details of a requestor tag", "request": { "name": "Details of a requestor tag", "description": { "content": "Retrieve details for a specific requestor tag by its unique database identifier.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "requestor_tags", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Unique database identifier of the requestor tag", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "768f6145-1cea-46f3-8f7a-add873db1c5d", "name": "Requestor tag details retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestor_tags", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the requestor tag", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faf7ef10-efd5-48d9-acf9-463c4dc82030", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestor_tags", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the requestor tag", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5008734-e0b5-48b5-993b-47b5fa73dd09", "name": "Resource not found", "originalRequest": { "url": { "path": [ "api", "client", "v1", "requestor_tags", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Unique database identifier of the requestor tag", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "toilet_feedbacks", "description": "", "item": [ { "id": "02670d7a-c974-49ce-9241-b30efb968615", "name": "Return list of toilet feedbacks", "request": { "name": "Return list of toilet feedbacks", "description": { "content": "Retrieve a paginated list of toilet feedback ratings for the authenticated agent. Supports filtering by creation date range (`start_date` and `end_date`).\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "toilet_feedbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter feedbacks created on or after this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter feedbacks created on or before this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5dfaf2b0-afe3-435d-b719-f8c542384c3f", "name": "List of toilet feedbacks retrieved successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "toilet_feedbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter feedbacks created on or after this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter feedbacks created on or before this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"score\": \"good\",\n \"location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"score\": \"good\",\n \"location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\"\n }\n ],\n \"page\": \"\",\n \"per_page\": \"\",\n \"total_pages\": \"\",\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99c0df09-c6fb-44cc-9d66-2f253fb8ae5a", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "toilet_feedbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter feedbacks created on or after this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter feedbacks created on or before this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f18e671-eebd-4fac-91d2-e85dd0fc45ac", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "toilet_feedbacks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter feedbacks created on or after this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Filter feedbacks created on or before this date (format YYYY-MM-DD)", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of records per page", "type": "text/plain" }, "key": "per_page", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90a35607-f110-4657-a643-f3200a034707", "name": "Create toilet feedback rating", "request": { "name": "Create toilet feedback rating", "description": { "content": "Submit a new toilet feedback rating for specified location tags. Returns the created feedback record.\n", "type": "text/plain" }, "url": { "path": [ "api", "client", "v1", "toilet_feedbacks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"score\": \"excellent\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Authentication-Token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b2b4fff7-d6a0-4182-83f8-4dccbd00b231", "name": "Toilet feedback created successfully", "originalRequest": { "url": { "path": [ "api", "client", "v1", "toilet_feedbacks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"score\": \"excellent\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"score\": \"poor\",\n \"location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4178cecf-fb8d-4e93-b01e-40abcc33d937", "name": "Bad Request / Invalid parameters", "originalRequest": { "url": { "path": [ "api", "client", "v1", "toilet_feedbacks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"score\": \"excellent\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1e67a2c-6f23-44f3-b310-24fd641e3097", "name": "Unauthorized / Missing or invalid API key", "originalRequest": { "url": { "path": [ "api", "client", "v1", "toilet_feedbacks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Authentication-Token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location_tag_ids\": [\n \"\",\n \"\"\n ],\n \"score\": \"excellent\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://portal.facilitybot.co" } ], "info": { "_postman_id": "b54c878f-c3e3-4d8f-a112-3ee2d00b32c3", "name": "FacilityBot API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# FacilityBot API Documentation\n\nWelcome to the FacilityBot API.\n\n---\n\n## Subscription & Access Requirements\n> [!IMPORTANT]\n> Only subscribers of the **FacilityBot Professional, Plus, and Enterprise plans** have access to the FacilityBot APIs.\n\n---\n\n## Authentication\nAll authenticated endpoints require a unique API key passed in the request headers:\n```http\nX-Authentication-Token: YOUR_API_KEY\n```\n\n### How to Obtain Your API Key\nIf you haven't generated your API key yet, follow the steps below:\n1. Log in to [https://signin.facilitybot.co](https://signin.facilitybot.co).\n2. Click **Integrations** in the bottom-left corner, and navigate to the **API** page.\n3. Click the **New API key** button to generate your unique key.\n4. Copy the generated key and pass it via the `X-Authentication-Token` header in every API request.\n\n---\n\n## Response Object Format\nFacilityBot APIs return standard JSON responses:\n\n### Single Resource Response\n```json\n{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": {\n \"id\": 101\n }\n}\n```\n\n### Paginated List Response\n```json\n{\n \"code\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"id\": 101\n }\n ],\n \"page\": 1,\n \"per_page\": 25,\n \"total_pages\": 1,\n \"count\": 1\n}\n```\n\n---\n\n## Error Handling & Error Codes\nFacilityBot APIs return standard HTTP status codes along with a structured JSON response containing an application-specific error `code` and descriptive `message`.\n\n### Error Response Structure\n```json\n{\n \"code\": 40001,\n \"message\": \"Required field missing\"\n}\n```\n\n### Standard Application Error Codes\n\n| HTTP Status | Error Code | Error Message | Description |\n|:-----------:|:----------:|:--------------|:------------|\n| **401** | `10003` | Unauthorized access | The request is not authorized or the API key is invalid/missing. |\n| **404** | `20001` | Resource not found | The requested resource could not be located. |\n| **400** | `20002` | Resource already exists | An attempt was made to create a resource that already exists. |\n| **400** | `30001` | Invalid operation | The requested operation is not allowed. |\n| **429** | `30002` | Operation limit exceeded | The action exceeds the allowed limit (e.g., rate limit, quota). |\n| **400** | `40001` | Required field missing | A mandatory field in the request is missing. |\n| **400** | `40002` | Invalid field format | The provided field value does not match the required format. |\n| **400** | `40003` | Invalid field value | The field value is not acceptable (e.g., out of range). |\n| **500** | `60001` | Unknown error occurred | An unspecified error occurred. Please try again later. |\n\n\nContact Support:\n Name: FacilityBot Support\n Email: admin@robusttechhouse.com", "type": "text/plain" } } }