{ "openapi": "3.0.1", "info": { "title": "TX Board of Nursing License Status Delta", "description": "Watches named Texas nursing (RN/VN) licenses in the official TX Board of Nursing registry, alerting only on a genuine change: license status (Revoked, Suspended, Vol.Surrender, Renewal Denied) or a board action flag. For hospitals, staffing agencies, HR, insurers, compliance. Free when unchanged.", "version": "0.1", "x-build-id": "gU4qx6dBe6VA5LWbx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/titan_coder~tx-nursing-board-license-status-delta/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-titan_coder-tx-nursing-board-license-status-delta", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/titan_coder~tx-nursing-board-license-status-delta/runs": { "post": { "operationId": "runs-sync-titan_coder-tx-nursing-board-license-status-delta", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/titan_coder~tx-nursing-board-license-status-delta/run-sync": { "post": { "operationId": "run-sync-titan_coder-tx-nursing-board-license-status-delta", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "monitorId", "watches" ], "properties": { "monitorId": { "title": "Monitor ID", "pattern": "^[a-z0-9-]{1,40}$", "type": "string", "description": "Name of this monitor's durable history (a-z, 0-9, dash; up to 40 chars)." }, "watches": { "title": "Licenses to watch", "minItems": 1, "maxItems": 30, "type": "array", "description": "1-30 objects: {\"watchId\": \"new-hire-jones\", \"licenseType\": \"RN\", \"licenseNumber\": \"621981\"}. licenseType is RN (Registered Nurse) or VN (Vocational/Licensed Vocational Nurse) — the same numeric licenseNumber exists independently in BOTH pools (different people), so licenseType picks the correct one. licenseNumber is the plain numeric TX Board of Nursing license number as published in the registry — look it up at https://www.bon.texas.gov/licensure_verification.asp if you only have a name. One watch = one license holder. New licenses can be added later under the same monitorId.", "items": { "type": "object", "required": [ "watchId", "licenseType", "licenseNumber" ], "properties": { "watchId": { "title": "Watch ID", "type": "string", "description": "Your own stable label for this watch: lowercase letters, digits and hyphens, up to 60 characters.", "pattern": "^[a-z0-9-]{1,60}$" }, "licenseType": { "title": "License type", "type": "string", "description": "RN (Registered Nurse) or VN (Vocational/Licensed Vocational Nurse) — picks which registry pool licenseNumber is looked up in.", "enum": [ "RN", "VN" ] }, "licenseNumber": { "title": "License number", "type": "string", "description": "Plain numeric TX Board of Nursing license number, no leading zeros, 1-9 digits.", "pattern": "^[1-9][0-9]{0,8}$" } } }, "default": [ { "watchId": "example-rn", "licenseType": "RN", "licenseNumber": "621981" } ] }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional. data.texas.gov does not require a key for this dataset, but a free Socrata app token (from your own data.texas.gov account) raises the anonymous request-rate ceiling if you run many watches across many monitors. Leave empty for normal use — a handful of watches per run works fine without one." }, "notifyOn": { "title": "Send webhook", "enum": [ "new_alerts", "always", "never" ], "type": "string", "description": "new_alerts — post the webhook only when new/changed paid status changes were delivered; always — post it every run; never — do not call webhookUrl at all.", "default": "new_alerts" }, "webhookUrl": { "title": "Webhook URL (HTTPS)", "type": "string", "description": "Optional. Receives a digest of delivered (paid) status changes as JSON. HTTPS only." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }