{ "swagger": "2.0", "info": { "version": "4.0.1", "title": "Alerting", "description": "Alerting Module API Specification" }, "host": "admin.alertsense.com", "basePath": "/api", "schemes": [ "http", "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v2/alerts": { "post": { "operationId": "createAlerts", "tags": [ "alerts" ], "summary": "Creates and queues an alert for sending", "description": "", "parameters": [ { "in": "body", "name": "body", "description": "required parameters for sending an alert", "required": true, "schema": { "$ref": "#/definitions/SendAlertRequest" } } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/SendAlertResponse" }, "examples": { "application/json": { "AlertId": 0, "SentStatus": { "AlertId": 1116, "AlertType": 0, "AlertStatus": "Queued", "DateSent": "/Date(1461270312040-0000)/", "DateCompleted": "/Date(-62135596800000-0000)/", "TimeZone": "MT ", "SenderName": "Development Administrator", "SenderEmail": "dev@alertsense.com", "Subject": "AlertSense Dev Environment", "Message": "This is a test message. Lets send from a template!", "Cancelled": false, "Scheduled": false, "Sent": false, "Groups": [], "Statuses": [], "Errors": [] }, "HasErrors": false, "IsValid": true } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{alertId}/results/channels/aggregatedSummary": { "get": { "operationId": "getAggregatedChannelSummaryResponse", "description": "Returns the summary results for the email, voice, and sms channels.", "tags": [ "alerts" ], "parameters": [ { "name": "alertId", "in": "path", "description": "the alert id of the channel to return", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AggregatedChannelSummaryResponse" }, "examples": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{alertId}/results/channels/email": { "get": { "operationId": "getAlertChannelResultsEmail", "description": "Return the results for the email channel.", "tags": [ "alerts" ], "parameters": [ { "name": "alertId", "in": "path", "description": "the alert id of the channel to return", "required": true, "type": "integer", "format": "int32" }, { "name": "page", "in": "query", "description": "the page number of contacts to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "the desired number of contacts per page. (25 by default)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EmailResultsSummaryResponse" }, "examples": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{alertId}/results/channels/etn": { "get": { "operationId": "getAlertChannelResultsEtn", "description": "Return the results for the ETN channel.", "tags": [ "alerts" ], "parameters": [ { "name": "alertId", "in": "path", "description": "the alert id of the channel to return", "required": true, "type": "integer", "format": "int32" }, { "name": "page", "in": "query", "description": "the page number of contacts to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "the desired number of contacts per page. (25 by default)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EtnResultsSummaryResponse" }, "examples": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{alertId}/results/channels/social/nextdoor": { "get": { "operationId": "getNextdoorChannelStatus", "description": "Gets the Nextdoor channel status for a given alertId.", "tags": [ "alerts" ], "parameters": [ { "name": "alertId", "in": "path", "description": "The AlertId.", "required": true, "type": "integer", "format": "int32" }, { "name": "page", "in": "query", "description": "The page number of status records to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "The desired number of status records per page. (25 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "sort", "in": "query", "description": "A comma seperated list of properties to order by. Property names are case insensitive. Default is AccountName.", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/PagedNextdoorChannelStatusResponse" } }, "400": { "description": "Invalid request.", "schema": { "$ref": "#/definitions/ApiResponse" } }, "401": { "description": "Unauthorized.", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{alertId}/results/channels/text": { "get": { "operationId": "getAlertChannelResultsText", "description": "Return the results for the Text channel.", "tags": [ "alerts" ], "parameters": [ { "name": "alertId", "in": "path", "description": "the alert id of the channel to return", "required": true, "type": "integer", "format": "int32" }, { "name": "page", "in": "query", "description": "the page number of contacts to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "the desired number of contacts per page. (25 by default)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SmsResultsSummaryResponse" }, "examples": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{alertId}/results/channels/voice": { "get": { "operationId": "getAlertChannelResultsVoice", "description": "Return the results for the Voice channel.", "tags": [ "alerts" ], "parameters": [ { "name": "alertId", "in": "path", "description": "the alert id of the channel to return", "required": true, "type": "integer", "format": "int32" }, { "name": "page", "in": "query", "description": "the page number of contacts to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "the desired number of contacts per page. (25 by default)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VoiceResultsSummaryResponse" }, "examples": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{alertId}/results/recipients/{recipientId}": { "get": { "operationId": "getAlertsByIdSingleRecipient", "description": "Results for the specified recipient who has received this specific alert.", "tags": [ "alerts", "contacts" ], "parameters": [ { "name": "alertId", "in": "path", "description": "Id of the alert", "required": true, "type": "integer", "format": "int32" }, { "name": "recipientId", "in": "path", "description": "Id of the recipient", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "A single Recipient", "schema": { "$ref": "#/definitions/SingleRecipientResponse" }, "examples": { "application/json": { "item": { "firstName": "Jeff", "lastName": "Miller", "channels": { "email": [ { "status": "Sent" } ], "mobile": [ { "status": "Sent" } ], "sms": [ { "status": "Sent" } ] } }, "hasErrors": false, "isValid": true } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{id}": { "get": { "operationId": "getAlertsById", "description": "Returns the alert details for the ID specified", "tags": [ "alerts" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of the alert", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "replaceMessageVariables", "description": "Replace message variables with values from a contact. Defaults to true", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Alert being retrieved", "schema": { "$ref": "#/definitions/SingleAlertSettingsResponse" }, "examples": { "application/json": { "item": { "alertType": "Poll", "capXml": "", "channels": { "email": { "requestConfirmation": false, "send": true }, "fax": { "send": false }, "push": { "send": false }, "textMessage": { "primary": true, "secondary": false, "deliveryMethod": "Sms", "send": true }, "voice": { "cellPhone": true, "businessPhone": true, "homePhone": true, "useOptOut": false, "send": true }, "facebook": { "accountIds": [], "pageIds": [], "send": false }, "twitter": { "accountIds": [], "send": false }, "nextdoor": { "accounts": [], "send": false }, "mobileBroadcast": { "send": false, "message": "" }, "myAlertsApp": { "send": false }, "microsoftTeams": { "sendWithHighImportance": false, "send": false } }, "clientContext": { "isResend": false }, "formType": "Quick", "id": 1118, "facilities": { "facilities": [], "areas": [] }, "message": { "priority": "NonEmergency", "basic": { "subject": "Exercise - Team Activation - Exercise", "message": "

Please respond to the following question by clicking on an answer below:

The team has been activated due to yesterday's incident. Please give your availability to report to the site. This is only an exercise.

" }, "poll": { "questionId": 1000, "question": "The team has been activated due to yesterday's incident. Please give your availability to report to the site. This is only an exercise.", "options": [ { "optionId": 1000, "selectionChoice": 1, "value": "I can be at the site in 2 hours", "description": "I can be at the site in 2 hours", "criticality": "None" }, { "optionId": 1001, "selectionChoice": 2, "value": "I can be at the site in 3 hours", "description": "I can be at the site in 3 hours", "criticality": "None" }, { "optionId": 1002, "selectionChoice": 3, "value": "I can report to the site tomorrow at 9:00 AM", "description": "I can report to the site tomorrow at 9:00 AM", "criticality": "None" }, { "optionId": 1003, "selectionChoice": 4, "value": "I am unable to report to the site today or tomorrow. ", "description": "I am unable to report to the site today or tomorrow. ", "criticality": "None" } ] }, "files": [ { "uri": "https://storage-dev.dev.aws.alertsense.net/hilton-worldwide-attachments/52730cc4-566b-434e-82c0-dea36d4f47f6/Image1.png", "fileName": "Image1.png", "contentType": "image/png", "length": 575765, "ownerId": 1000 } ], "language": "en-us", "incident": { "id": "e03472cc9a3843d182986e01e1f02307", "name": "Infrastructure Failure/Damage", "priority": "Emergency", "type": "Generic" }, "incidentId": "e03472cc9a3843d182986e01e1f02307" }, "recipients": { "uniqueMyAlertsAppCount": 10, "uniqueEtnCount": 5, "uniqueGroupCount": 0, "uniqueContactCount": 45, "selectedContactCount": 0, "selectedGroupCount": 1, "groupIds": [ 8846 ], "mandatoryGroupIds": [], "contactIds": [], "groups": [ { "id": 8846, "externalId": "8846" } ], "contacts": [], "directories": [], "searchFilters": [] }, "related": [ { "relatedAlertId": 1100, "alertRelationType": "Related" } ], "schedule": { "scheduled": false, "expireDateTimeUtc": "/Date(1463052600000)/", "type": "Hickory" }, "security": { "requireAuthentication": false, "voicePin": "" }, "sender": { "id": 1234, "asset": { "id": "539569f532ce46b293a0d4190f10ba3d", "name": "Tokyo Hilton" }, "displayName": "Tina Tester", "email": "tina.tester@alertsense.dev", "callerId": "2085551234", "externalId": "1234" }, "timeSent": "/Date(1463049000000)/", "workflow": { "name": "RollingRetry", "key": "poll4duration", "version": "1.0", "triggers": [ "Initialize", "Gather", "Hangup" ], "settings": { "retryDelay": "5", "maxAttempts": "1000", "duration": "15" } }, "hidden": false, "weatherAlert": false, "requestConfirmation": false, "relatedAlertActions": { "disableReplyAll": false } }, "status": { "__type": "AlertSense.Hickory.Interfaces.ResponseStatus, AlertSense.Hickory.ServiceModel", "isSuccess": true, "errorCode": "None", "validationFailures": [], "messages": [] }, "hasErrors": false, "isValid": true } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{id}/results": { "get": { "operationId": "getAlertsByIdResults", "description": "Result summary for the specified alert.", "tags": [ "alerts" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of the alert", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Result summary for the specified alert.", "schema": { "$ref": "#/definitions/SingleDeliverySummaryResponse" }, "examples": { "application/json": { "item": { "id": 1118, "totalRecipients": 55, "delivery": { "Answered - Key Pressed": 45, "Answered - No Key Pressed": 5, "Failed": 5 }, "poll": { "questionId": 1000, "question": "What's your favorite color?", "optionResults": [ { "optionId": 1000, "name": "Red", "value": 1, "count": 3 }, { "optionId": 1001, "name": "Blue", "value": 2, "count": 5 } ], "totalResponded": 8 }, "hasErrors": false, "isValid": true } } } }, "404": { "description": "NotFound" } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{id}/results/recipients": { "get": { "operationId": "getAlertsByIdRecipients", "description": "Results for all the recipients who have received this specific alert.", "tags": [ "alerts", "contacts" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of the alert", "required": true, "type": "integer", "format": "int32" }, { "name": "recipientIds", "in": "query", "description": "Filters recipeints by IDs.", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "isMandatory", "in": "query", "description": "Filters by recipeints that were mandatory when the alert was sent.", "required": false, "type": "boolean" }, { "name": "pollOptionId", "in": "query", "description": "Filters recipeints by the poll option they selected.", "required": false, "type": "integer", "format": "int32" }, { "name": "name", "in": "query", "description": "Filters recipeints by name.", "required": false, "type": "string" }, { "name": "email", "in": "query", "description": "Filters recipeints by email.", "required": false, "type": "string" }, { "$ref": "#/parameters/page" }, { "$ref": "#/parameters/pageSize" }, { "$ref": "#/parameters/sort" } ], "responses": { "200": { "description": "Paged Recipients.", "schema": { "$ref": "#/definitions/PagedRecipientResponse" }, "examples": { "application/json": { "items": [ { "id": 123, "firstName": "Jeff", "lastName": "Miller", "channels": { "email": [ { "status": "Sent", "excluded": false } ], "mobile": [ { "status": "Sent", "excluded": false } ], "sms": [ { "status": "Sent", "excluded": false } ] }, "response": { "channel": "Email", "value": 1, "responseMethod": "j.m@nagdom.com" }, "isMandatory": false, "asset": { "id": "51bcb90c74174e60a0fdc87eeb8bac99", "name": "AlertSense" }, "responseTime": "/Date(1463052600000)/", "responseChannel": "Email", "confirm": false }, { "id": 456, "firstName": "Josiah", "lastName": "Peters", "channels": { "email": [ { "status": "Sent", "excluded": false }, { "status": "Sent", "excluded": false } ], "mobile": [ { "status": "Sent", "excluded": false } ] }, "isMandatory": false, "asset": { "id": "51bcb90c74174e60a0fdc87eeb8bac99", "name": "AlertSense" }, "responseTime": "/Date(1463052600000)/", "responseChannel": "mobile", "confirm": false } ], "totalItemCount": 55, "pageCount": 3, "page": 1, "pageSize": 25 } } }, "404": { "description": "NotFound" } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/{id}/status": { "get": { "operationId": "getAlertsByIdStatus", "description": "Current status for the specified alert.", "tags": [ "alerts" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of the alert", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Current status for the specified alert.", "schema": { "$ref": "#/definitions/SingleAlertStatusResponse" }, "examples": { "application/json": { "item": { "id": 1004, "status": "Sent" }, "hasErrors": false, "isValid": true } } }, "404": { "description": "NotFound" } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/defaults": { "post": { "operationId": "getAlertsDefault", "description": "Add new Alert Default Form", "tags": [ "alerts" ], "parameters": [ { "name": "singleAlertDefaultsRequest", "in": "body", "schema": { "$ref": "#/definitions/SingleAlertDefaultsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleAlertDefaultsResponse" }, "examples": { "application/json": { "item": { "fields": [ { "name": "incident", "required": true, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false }, { "name": "severityAssessment", "required": true, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false }, { "name": "recipients", "required": true, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false }, { "name": "subject", "required": true, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false }, { "name": "message", "required": true, "invisible": false, "readonly": false, "systemRequired": false, "autofill": false } ], "alertType": "Poll", "channels": { "email": { "requestConfirmation": false, "send": true }, "fax": { "send": false }, "push": { "send": true }, "textMessage": { "primary": true, "secondary": false, "deliveryMethod": "Sms", "send": true }, "voice": { "cellPhone": false, "businessPhone": false, "homePhone": false, "useOptOut": false, "send": false }, "facebook": { "accountIds": [], "pageIds": [], "send": false }, "twitter": { "accountIds": [], "send": false }, "nextdoor": { "accounts": [], "send": false }, "mobileBroadcast": { "send": false, "message": "" }, "myAlertsApp": { "send": false }, "microsoftTeams": { "sendWithHighImportance": false, "send": false } }, "clientContext": { "isResend": false }, "formType": "Quick", "facilities": { "facilities": [], "areas": [] }, "message": { "priority": "Emergency", "basic": { "subject": "AlertSense Dev Environment", "message": "" }, "files": [], "language": "en-us", "incident": { "id": "e03472cc9a3843d182986e01e1f02307", "name": "Infrastructure Failure/Damage", "priority": "Emergency", "type": "Generic" } }, "recipients": { "uniqueMyAlertsAppCount": 0, "uniqueEtnCount": 0, "uniqueGroupCount": 0, "uniqueContactCount": 0, "selectedContactCount": 0, "selectedGroupCount": 0, "groupIds": [], "mandatoryGroupIds": [], "contactIds": [], "groups": [], "contacts": [], "directories": [], "searchFilters": [] }, "related": [ { "relatedAlertId": 1100, "alertRelationType": "Reply" } ], "security": { "requireAuthentication": false, "voicePin": "" }, "sender": { "id": 1234, "asset": { "id": "539569f532ce46b293a0d4190f10ba3d", "name": "Tokyo Hilton" }, "displayName": "Tina Tester", "email": "tina.tester@alertsense.dev", "callerId": "2085551234", "externalId": "1234" }, "hidden": false, "weatherAlert": false, "requestConfirmation": false, "relatedAlertActions": { "disableReplyAll": false } }, "status": { "__type": "AlertSense.Hickory.Interfaces.ResponseStatus, AlertSense.Hickory.ServiceModel", "isSuccess": true, "errorCode": "None", "validationFailures": [], "messages": [] }, "hasErrors": false, "isValid": true } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/find": { "post": { "operationId": "findAlerts", "description": "List a summary of all alerts sent", "tags": [ "alerts" ], "parameters": [ { "in": "body", "name": "body", "description": "Filters for alert search", "schema": { "$ref": "#/definitions/FindAlertRequest" } } ], "responses": { "200": { "description": "Success. List a summary of all alerts sent", "schema": { "$ref": "#/definitions/PagedAlertSettingsResponse" }, "examples": { "application/json": { "totalItemCount": 1, "pageCount": 1, "page": 1, "pageSize": 5, "items": [ { "id": 1118, "regionName": "AlertSense Admin Region", "timeSent": "/Date(1463049000000)/", "sender": { "asset": { "id": "539569f532ce46b293a0d4190f10ba3d", "name": "Tokyo Hilton" }, "id": 1234, "displayName": "Development Administrator", "email": "dev@alertsense.com" }, "facilities": { "facilities": [], "areas": [] }, "message": { "priority": "NonEmergency", "incident": { "id": "e03472cc9a3843d182986e01e1f02307", "name": "Infrastructure Failure/Damage", "priority": "Emergency", "type": "Generic" }, "incidentId": "e03472cc9a3843d182986e01e1f02307", "basic": { "subject": "AlertSense Dev Environment", "message": "This is a test message. Lets send an alert!" }, "files": [], "language": "en-us", "severityAssessment": { "responses": [ { "questionId": "id.hilton.assessment.question.seriousillness", "optionId": "id.hilton.assessment.responses.yesno.yes" }, { "questionId": "id.hilton.assessment.question.propertydamage", "optionId": "id.hilton.assessment.responses.yesno.yes" } ], "comment": "Send help now." } }, "channels": { "email": { "send": true }, "fax": { "send": false }, "push": { "send": false }, "textMessage": { "primary": true, "secondary": false, "deliveryMethod": "Sms", "send": true }, "voice": { "cellPhone": false, "businessPhone": false, "homePhone": false, "useOptOut": false, "send": false }, "mobileBroadcast": { "send": false, "message": "" } }, "recipients": { "uniqueMyAlertsAppCount": 10, "uniqueEtnCount": 5, "uniqueContactCount": 45, "groupIds": [ 1003 ], "mandatoryGroupIds": [], "contactIds": [] }, "related": [ { "relatedAlertId": 1100, "alertRelationType": "Reply" } ], "alertType": "Default", "formType": "Quick", "hidden": false } ] } } }, "401": { "description": "Unauthorized.", "schema": { "$ref": "#/definitions/ErrorResponse" }, "examples": { "application/json": { "error": "Unauthorized." } } }, "500": { "description": "Invalid User.", "schema": { "$ref": "#/definitions/ErrorResponse" }, "examples": { "application/json": { "error": "Invalid User." } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alerts/preview": { "post": { "operationId": "createAlertsPreview", "description": "Validates an alert and returns a preview", "tags": [ "alerts" ], "parameters": [ { "in": "body", "name": "PreviewAlertRequest", "description": "Required parameters for previewing an alert", "required": true, "schema": { "$ref": "#/definitions/PreviewAlertRequest" } } ], "responses": { "200": { "description": "A preview of the Alert to send", "schema": { "$ref": "#/definitions/SingleAlertSettingsResponse" }, "examples": { "application/json": { "item": { "id": 1118, "timeSent": "/Date(1463070600000-0000)/", "alertType": "Default", "formType": "Quick", "sender": { "id": 1234, "asset": { "id": "539569f532ce46b293a0d4190f10ba3d", "name": "Tokyo Hilton" }, "displayName": "Development Administrator", "email": "dev@alertsense.com" }, "facilities": { "facilities": [], "areas": [] }, "message": { "priority": "NonEmergency", "incident": { "id": "e03472cc9a3843d182986e01e1f02307", "name": "Infrastructure Failure/Damage" }, "incidentId": "e03472cc9a3843d182986e01e1f02307", "basic": { "subject": "AlertSense Dev Environment", "message": "This is a test message. Lets send from a template!" }, "files": [], "language": "en-us" }, "channels": { "email": { "recipientCount": 10, "send": true }, "fax": { "recipientCount": 0, "send": false }, "push": { "recipientCount": 0, "send": false }, "textMessage": { "recipientCount": 3, "send": true }, "voice": { "recipientCount": 5, "send": true } }, "recipients": { "totalSelected": 18, "totalRecipients": 14, "groupIds": [ 1003, 1004, 1005 ], "mandatoryGroupIds": [], "contactIds": [] } }, "hasErrors": false, "isValid": true } } }, "400": { "description": "Bad request, likely due to validation errors.", "schema": { "$ref": "#/definitions/ApiResponse" }, "examples": { "application/json": { "status": { "isSuccess": false, "errorCode": "ValidationError", "errorMessage": "Subject is required to send this message." }, "hasErrors": true, "isValid": true } } }, "401": { "description": "Unauthorized.", "schema": { "$ref": "#/definitions/ErrorResponse" }, "examples": { "application/json": { "error": "Unauthorized." } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/public/shortenedUrl": { "post": { "operationId": "createShortenedUrl", "description": "Create a shortened URL", "tags": [ "public", "alerts" ], "parameters": [ { "in": "body", "name": "CreateShortenedUrlRequest", "description": "Required parameters", "required": true, "schema": { "$ref": "#/definitions/CreateShortenedUrlRequest" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ShortenedUrlResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/distributionLists/createFromFile": { "post": { "operationId": "createFromFile", "description": "Creates a distribution list from a CSV file structured after /v2/contacts/export", "tags": [ "distributionLists", "contacts" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "createDistributionListFromFileRequest", "required": true, "description": "The file to create the list from.", "schema": { "$ref": "#/definitions/CreateDistributionListFromFileRequest" } } ], "responses": { "200": { "description": "Success. Returns a paged list of the contacts from the distribution list.", "schema": { "$ref": "#/definitions/CreateDistributionListFromFileResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/alertsWithAttachments": { "post": { "operationId": "createAlertWithAttachment", "tags": [ "alerts" ], "summary": "Creates and queues an alert for sending with attachments", "description": "", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "attachment", "in": "formData", "description": "File to upload", "type": "file" }, { "name": "alert", "in": "formData", "description": "required parameters for sending an alert", "required": true, "type": "string" }, { "name": "jobId", "in": "formData", "description": "Send Alert Job Id", "required": false, "type": "string" }, { "name": "async", "in": "formData", "description": "deprecated. Specifies whether an asynchronous notification is sent to the sender on alert transition to final state", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/SendAlertResponse" }, "examples": { "application/json": { "AlertId": 0, "SentStatus": { "AlertId": 1116, "AlertType": 0, "AlertStatus": "Queued", "DateSent": "/Date(1461270312040-0000)/", "DateCompleted": "/Date(-62135596800000-0000)/", "TimeZone": "MT ", "SenderName": "Development Administrator", "SenderEmail": "dev@alertsense.com", "Subject": "AlertSense Dev Environment", "Message": "This is a test message. Lets send from a template!", "Cancelled": false, "Scheduled": false, "Sent": false, "Groups": [], "Statuses": [], "Errors": [] }, "HasErrors": false, "IsValid": true } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/alerts/bulkSend": { "post": { "operationId": "sendBulkAlerts", "description": "Sends multiple alerts in a single request. (tenant based)", "tags": [ "alerts" ], "responses": { "200": { "description": "Success. The alerts were sent.", "schema": { "$ref": "#/definitions/BulkSendAlertResponse" } }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" } }, "parameters": [ { "name": "tenantId", "in": "path", "description": "The tenantId to use for the request", "required": true, "type": "integer", "format": "int32" }, { "name": "bulkSendAlertRequest", "in": "body", "description": "The request details for sending multiple alerts.", "required": true, "schema": { "$ref": "#/definitions/BulkSendAlertRequest" } } ], "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/contacts/find": { "post": { "operationId": "findContacts", "description": "Returns a paged list of the contacts.", "tags": [ "contacts" ], "parameters": [ { "in": "body", "name": "body", "description": "Filters for contact search", "schema": { "$ref": "#/definitions/FindContactRequest" } } ], "responses": { "200": { "description": "Success. Returns a paged list of the contacts.", "schema": { "$ref": "#/definitions/PagedContactResponse" }, "examples": { "application/json": { "totalItemCount": 2, "pageCount": 2, "page": 1, "pageSize": 5, "items": [ { "id": 0, "credentialId": 10, "firstName": "Princess", "lastName": "Jasmine", "emails": [ "magic.carpet1337@gmail.com", "magic.carpet1338@gmail.com", "magic.carpet1339@gmail.com" ], "phones": [ "+12025554444", "+12025554445" ], "chatUser": { "id": "test.1000.0.a1576c14-6f72-4a5c-acf3-c33444cd75a7", "displayName": "Jasmine, Princess", "firstName": "Princess", "lastName": "Jasmine", "emailAddress": "magic.carpet1337@gmail.com", "metadata": "{\"ContactId\":0,\"UserId\":0,\"TenantId\":1000}" } }, { "id": 1, "credentialId": 11, "firstName": "Captain", "lastName": "Gerrit", "emails": [ "git.review@gmail.com" ], "phones": [ "+12025554446" ], "chatUser": { "id": "test.1000.1.C22F1D0E-9E59-4A11-A918-181F3A407F0E", "displayName": "Gerrit, Captain", "firstName": "Captain", "lastName": "Gerrit", "emailAddress": "git.review@gmail.com", "metadata": "{\"ContactId\":1,\"UserId\":1,\"TenantId\":1000}" } } ] } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/features/count": { "post": { "operationId": "postFeaturesCount", "tags": [ "map", "alerts" ], "parameters": [ { "name": "geoJson", "in": "body", "description": "geoJson by which to constrain results via geographic intersection", "required": false, "schema": { "$ref": "#/definitions/FeatureCollectionRequest" } }, { "name": "keys", "in": "query", "type": "string", "description": "Ordered comma-separated search parameter keys", "required": false }, { "name": "values", "in": "query", "type": "string", "description": "Ordered comma-separated search parameter values to match", "required": false }, { "name": "featuresSource", "in": "query", "description": "The type of object you want to search for in the given feature collection.", "required": false, "type": "string", "enum": [ "Assets", "Groups", "Users", "PublicUsers", "InternalUsers" ] } ], "responses": { "200": { "description": "Success. Returns feature count for given layerId; filtered by geoJson", "schema": { "$ref": "#/definitions/CountResponse" }, "examples": { "application/json": { "count": 1 } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2.1/groups/tree": { "get": { "operationId": "getGroupTreeNodes", "description": "Returns a paged set of `GroupTreeNode` objects.", "tags": [ "groups", "v2.1" ], "parameters": [ { "name": "groupId", "in": "query", "description": "Id of the group to look up", "type": "integer", "format": "int32" }, { "name": "classification", "in": "query", "description": "the classification of the groups to return. (Internal vs. Public)", "type": "string", "enum": [ "Internal", "Public" ] }, { "$ref": "#/parameters/page" }, { "$ref": "#/parameters/pageSize" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PagedGroupTreeNodeResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/jobs": { "get": { "operationId": "getJobStatuses", "description": "Get the statuses of the jobs for the tenant.", "tags": [ "jobs" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "query", "description": "the job ids to return", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "state", "in": "query", "description": "the state of job to return", "required": false, "type": "string", "enum": [ "Queued", "Running", "Success", "Failure" ] }, { "name": "type", "in": "query", "description": "the type of job to return", "required": false, "type": "string", "enum": [ "Geocoding", "Sftp", "TaskListReminder", "AlertPreview", "SendAlert", "ExtractUsageData", "Installer", "TeamsDiscovery", "LargeScaleIncident", "BulkAlert", "BulkTaskListActivation", "ContactUploadPreview", "ContactUploadImport" ] }, { "name": "limitJobHistoryDays", "in": "query", "description": "Limit of Job history days. Defaults to previous 30 days", "required": false, "type": "integer", "format": "int32" }, { "name": "page", "in": "query", "description": "the page number of jobs to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "the desired number of jobs per page. (25 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "sort", "in": "query", "description": "the field to sort by", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success. Returns a paged list of the jobs for the tenant.", "schema": { "$ref": "#/definitions/PagedJobStatusResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ApiResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/jobs/{jobId}": { "get": { "operationId": "getJobById", "description": "Get a job by ID for the tenant.", "tags": [ "jobs" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "name": "jobId", "in": "path", "description": "Id of the job", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success. Returns the job for the tenant.", "schema": { "$ref": "#/definitions/SingleJobStatusResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ApiResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/jobs/{jobId}/stages/{stageId}": { "get": { "operationId": "getJobStageById", "description": "Get a stage by ID for a specified job.", "tags": [ "jobs" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "name": "jobId", "in": "path", "description": "Id of the job", "required": true, "type": "string" }, { "name": "stageId", "in": "path", "description": "Id of the job stage", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success. Returns the job for the tenant.", "schema": { "$ref": "#/definitions/SingleJobStageStatusResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ApiResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/jobs/{jobId}/progress": { "put": { "operationId": "updateJobProgress", "description": "Update the progress of a specified job.", "tags": [ "jobs" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "name": "jobId", "in": "path", "description": "Id of the job", "required": true, "type": "string" }, { "in": "body", "name": "updateJobProgressRequest", "required": true, "description": "Required parameters for updating a job progress.", "schema": { "$ref": "#/definitions/UpdateJobProgressRequest" } } ], "responses": { "204": { "$ref": "#/responses/204" }, "400": { "$ref": "#/responses/400" } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/jobs/{jobId}/status": { "put": { "operationId": "updateJobStatus", "description": "Update the status of a specified job.", "tags": [ "jobs" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "name": "jobId", "in": "path", "description": "Id of the job", "required": true, "type": "string" }, { "in": "body", "name": "updateJobStatusRequest", "required": true, "description": "Required parameters for updating a job status.", "schema": { "$ref": "#/definitions/UpdateJobStatusRequest" } } ], "responses": { "204": { "$ref": "#/responses/204" }, "400": { "$ref": "#/responses/400" } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/jobs/{jobId}/stages": { "get": { "operationId": "getJobStages", "description": "Get the stages for a specified job.", "tags": [ "jobs" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "name": "jobId", "in": "path", "description": "Id of the job", "required": true, "type": "string" }, { "name": "parentId", "in": "query", "description": "Parent stage to get child stage ids for", "required": false, "type": "string" }, { "name": "ids", "in": "query", "description": "the stage ids to return", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "the page number of jobs to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "the desired number of jobs per page. (25 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "sort", "in": "query", "description": "the field to sort by", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success. Returns a paged list of the jobs for the tenant.", "schema": { "$ref": "#/definitions/PagedJobStagesResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ApiResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/jobs/{jobId}/stages/{stageId}/events": { "get": { "operationId": "getJobStageEvents", "description": "Get the events for a specified job stage.", "tags": [ "jobs" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "name": "jobId", "in": "path", "description": "Id of the job", "required": true, "type": "string" }, { "name": "stageId", "in": "path", "description": "Job stage to get the events for", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "the page number of jobs to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "the desired number of jobs per page. (25 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "sort", "in": "query", "description": "the field to sort by", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success. Returns a paged list of the jobs for the tenant.", "schema": { "$ref": "#/definitions/PagedJobEventsResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ApiResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v4/{tenantId}/jobs/{jobId}/events": { "get": { "operationId": "getJobEvents", "description": "Get the events for a specified job.", "tags": [ "jobs" ], "parameters": [ { "name": "tenantId", "in": "path", "description": "Id of the tenant", "required": true, "type": "integer", "format": "int32" }, { "name": "jobId", "in": "path", "description": "Id of the job", "required": true, "type": "string" }, { "name": "stageId", "in": "query", "description": "Job stage to get the events for", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "the page number of jobs to return. (1 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "the desired number of jobs per page. (25 by default)", "required": false, "type": "integer", "format": "int32" }, { "name": "sort", "in": "query", "description": "the field to sort by", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success. Returns a paged list of the jobs for the tenant.", "schema": { "$ref": "#/definitions/PagedJobEventsResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ApiResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ApiResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ApiResponse" } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } }, "/v2/user": { "get": { "operationId": "getUser", "description": "Returns information about the current user.", "tags": [ "user" ], "responses": { "200": { "description": "Success. Returns information about the current user.", "schema": { "$ref": "#/definitions/SingleUserResponse" }, "examples": { "application/json": { "item": { "id": 1001, "name": { "familyName": "Gerrit", "givenName": "Captain" }, "agency": "The High Seas", "permissions": [ "alert.create", "group.read", "contact.read" ], "featureSet": { "disclaimer": { "accepted": false, "name": "Franchise Disclaimer" } }, "identity": { "id": 1000, "username": "Bravo", "isAuthenticated": true }, "bundle": { "android": { "uri": "https://admin.alertsense.com/api/v2/attachments/793dcdb8-26a7-42f7-8358-d38d6140545c/AndroidBundle.png?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjcmVkZW50aWFscy5pZCI6Ii0xIiwidXJpUGF0aFBhcnRpYWwiOiI3OTNkY2RiOC0yNmE3LTQyZjctODM1OC1kMzhkNjE0MDU0NWMvSW1hZ2UxLnBuG1pbi5hbGVydHNlbnNlLmNvbSIsImV4cCI6MTQ3NTI3MjU5NSwibmJmIjoxNDc1MjcxNjk1fQ.OwXYneKeq4VSn0eOIiREELBpAnToHc", "version": "201609301545061111" }, "ios": { "uri": "https://admin.alertsense.com/api/v2/attachments/793dcdb8-26a7-42f7-8358-d38d6140545c/iOSBundle.png?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjcmVkZW50aWFscy5pZCI6Ii0xIiwidXJpUGF0aFBhcnRpYWwiOiI3OTNkYi5hbGVydHNlbnNlLmNvbSIsImF1ZCI6Imh0dHA6Ly9hZG1pbi5hbGVydHNlbnNlLmNvbSIsImV4cCI6MTQ3NTI3MjU5NSwibmJmIjoxNDc1MjcxNjk1fQ.OwXYneKeq4VSn0eOIiREELBpAnToHCaWk-l4f", "version": "201609301545061525" } }, "bcp": { "android": { "uri": "https://admin.alertsense.com/api/v2/attachments/793dcdb8-26a7-42f7-8358-d38d6140545c/AndroidBundle.png?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjcmVkZW50aWFscy5pZCI6Ii0xIiwidXJpUGF0aFBhcnRpYWwiOiI3OTNkY2RiOC0yNmE3LTQyZjctODM1OC1kMzhkNjE0MDU0NWMvSW1hZ2UxLnBuG1pbi5hbGVydHNlbnNlLmNvbSIsImV4cCI6MTQ3NTI3MjU5NSwibmJmIjoxNDc1MjcxNjk1fQ.OwXYneKeq4VSn0eOIiREELBpAnToHc", "version": "201609301545061111" }, "ios": { "uri": "https://admin.alertsense.com/api/v2/attachments/793dcdb8-26a7-42f7-8358-d38d6140545c/iOSBundle.png?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjcmVkZW50aWFscy5pZCI6Ii0xIiwidXJpUGF0aFBhcnRpYWwiOiI3OTNkYi5hbGVydHNlbnNlLmNvbSIsImF1ZCI6Imh0dHA6Ly9hZG1pbi5hbGVydHNlbnNlLmNvbSIsImV4cCI6MTQ3NTI3MjU5NSwibmJmIjoxNDc1MjcxNjk1fQ.OwXYneKeq4VSn0eOIiREELBpAnToHCaWk-l4f", "version": "201609301545061525" } }, "chatApplicationId": "layer:///apps/staging/46049191-bf10-42c1-a7e1-2c5b366e389e", "sendBirdApplicationId": "521882d2-bbb7-5d77-8549-2bc4e1f3d2fc", "contact": { "id": 1337, "credentialId": 10, "firstName": "Princess", "lastName": "Jasmine", "emails": [ "magic.carpet1337@gmail.com", "magic.carpet1338@gmail.com", "magic.carpet1339@gmail.com" ], "phones": [ "+12025554444", "+12025554445" ], "chatIdentity": { "id": "test.1000.0.a1576c14-6f72-4a5c-acf3-c33444cd75a7", "displayName": "Jasmine, Princess", "firstName": "Princess", "lastName": "Jasmine", "emailAddress": "magic.carpet1337@gmail.com", "metadata": "{\"ContactId\":0,\"UserId\":0,\"TenantId\":1000}" } }, "unreadCounts": { "alerts": 32 } }, "hasErrors": false, "isValid": true } } } }, "security": [ { "JwtBearerTokenScheme": [], "Oauth2Scheme": [] } ] } } }, "parameters": { "endDate": { "name": "endDate", "in": "query", "description": "The ending date for the date range.", "required": false, "type": "string", "format": "date-time" }, "integrationsCategory": { "name": "category", "in": "query", "description": "The category of integration history items.", "required": false, "type": "string", "enum": [ "None", "Event", "Trigger", "Action", "Status" ] }, "level": { "name": "level", "in": "query", "description": "The level of history items.", "required": false, "type": "string", "enum": [ "Debug", "Information", "Warning", "Error" ] }, "page": { "name": "page", "in": "query", "description": "The page number of items to return. (1 by default)", "required": false, "default": 1, "type": "integer", "format": "int32" }, "pageSize": { "name": "pageSize", "in": "query", "description": "The desired number of items per page. (25 by default)", "default": 25, "required": false, "type": "integer", "format": "int32" }, "search": { "name": "search", "in": "query", "description": "A value matched against one or more resource properties.", "required": false, "type": "string" }, "sort": { "name": "sort", "in": "query", "description": "A comma seperated list of properties to order by. Properties preceded by a '-' will be ordered descending. (e.g. ?sort=lastName,firstName,-responseTime). Property names are case insensitive.", "required": false, "type": "string" }, "startDate": { "name": "startDate", "in": "query", "description": "The starting date for the date range.", "required": false, "type": "string", "format": "date-time" } }, "responses": { "204": { "description": "Success. No Content." }, "400": { "description": "Bad request.", "schema": { "$ref": "#/definitions/ErrorResponse" }, "examples": { "application/json": { "error": "Bad request." } } }, "401": { "description": "Unauthorized.", "schema": { "$ref": "#/definitions/ErrorResponse" }, "examples": { "application/json": { "error": "Unauthorized." } } }, "403": { "description": "Forbidden.", "schema": { "$ref": "#/definitions/ErrorResponse" }, "examples": { "application/json": { "error": "Forbidden." } } }, "404": { "description": "Not Found.", "schema": { "$ref": "#/definitions/ErrorResponse" }, "examples": { "application/json": { "error": "Not Found." } } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/ErrorResponse" }, "examples": { "application/json": { "error": "Unexpected server error." } } } }, "definitions": { "AccessFilter": { "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string" } }, "domainTypes": { "type": "array", "items": { "type": "string" } }, "requireMembership": { "type": "boolean" }, "mandatoryAlerting": { "type": "boolean" }, "conditions": { "type": "array", "items": { "$ref": "#/definitions/AccessFilterCondition" } } } }, "AccessFilterCondition": { "type": "object", "properties": { "field": { "type": "string" }, "expression": { "type": "string" }, "mapping": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "AccessRecipe": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/AccessFilter" }, "displayName": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "group": { "$ref": "#/definitions/DisplayGroup" }, "role": { "$ref": "#/definitions/DisplayRole" } } }, "AggregatedChannelResult": { "type": "object", "properties": { "ChannelName": { "type": "string" }, "StatusTypes": { "type": "object", "additionalProperties": { "type": "string" } }, "TotalChannelRecipients": { "type": "integer" } } }, "AggregatedChannelResults": { "type": "object", "properties": { "Sms": { "$ref": "#/definitions/AggregatedChannelResult" }, "Smtp": { "$ref": "#/definitions/AggregatedChannelResult" }, "Voice": { "$ref": "#/definitions/AggregatedChannelResult" }, "Email": { "$ref": "#/definitions/AggregatedChannelResult" }, "Etn": { "$ref": "#/definitions/AggregatedChannelResult" }, "MobilePush": { "$ref": "#/definitions/AggregatedChannelResult" }, "Fax": { "$ref": "#/definitions/AggregatedChannelResult" }, "MicrosoftTeams": { "$ref": "#/definitions/AggregatedChannelResult" } } }, "AggregatedChannelSummaryResponse": { "type": "object", "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "Item": { "$ref": "#/definitions/AggregatedChannelResults" } }, "type": "object" } ] }, "AlertDefaults": { "allOf": [ { "$ref": "#/definitions/AlertSettings" }, { "properties": { "fields": { "items": { "$ref": "#/definitions/Field" }, "type": "array" }, "severityAssessmentId": { "type": "string", "format": "guid" } } } ] }, "AlertSentStatus": { "properties": { "AlertId": { "format": "int32", "type": "integer" }, "Message": { "type": "string" }, "SenderEmail": { "type": "string" }, "SenderName": { "type": "string" }, "Subject": { "type": "string" } }, "type": "object" }, "AlertSettings": { "discriminator": "type", "properties": { "alertType": { "$ref": "#/definitions/AlertType" }, "weatherAlert": { "type": "boolean" }, "capKey": { "type": "string" }, "capXml": { "type": "string" }, "channels": { "$ref": "#/definitions/ChannelSettings" }, "formType": { "$ref": "#/definitions/FormType" }, "id": { "format": "int32", "type": "integer" }, "facilities": { "$ref": "#/definitions/FacilitySettings" }, "location": { "$ref": "#/definitions/LocationSettings" }, "message": { "$ref": "#/definitions/MessageSettings" }, "recipients": { "$ref": "#/definitions/RecipientSettings" }, "mobileBroadcast": { "$ref": "#/definitions/MobileBroadcastSettings" }, "regionId": { "format": "int32", "type": "integer" }, "regionName": { "type": "string" }, "related": { "items": { "$ref": "#/definitions/RelatedAlert" }, "type": "array" }, "schedule": { "$ref": "#/definitions/ScheduleSettings" }, "security": { "$ref": "#/definitions/SecuritySettings" }, "sender": { "$ref": "#/definitions/SenderSettings" }, "timeSent": { "format": "date-time", "type": "string" }, "userId": { "format": "int32", "type": "integer" }, "workflow": { "$ref": "#/definitions/WorkflowSettings" }, "prioritySettings": { "$ref": "#/definitions/PrioritySettings" }, "hidden": { "type": "boolean" }, "completionStatus": { "$ref": "#/definitions/AlertStatus" }, "brandId": { "format": "int32", "type": "integer" }, "relatedAlertActions": { "$ref": "#/definitions/RelatedAlertActions" }, "pipelineSettings": { "$ref": "#/definitions/PipelineSettings" }, "publicAlert": { "type": "boolean" }, "requestConfirmation": { "type": "boolean" }, "clientContext": { "$ref": "#/definitions/ClientRequestContext" } }, "type": "object" }, "AlertSettingsValue": { "description": "Variable current value", "properties": { "friendlyName": { "description": "Friendly name for this variable", "type": "string" }, "placeHolder": { "description": "Placeholder for this variable", "type": "string" }, "source": { "$ref": "#/definitions/AlertSettingsVariableSource" }, "maxLength": { "description": "MaxLength for this variable. This will be used when validating a message length", "type": "integer", "format": "int32" }, "sampleValue": { "description": "Sample value for this variable", "type": "string" }, "template": { "description": "Template for this variable", "type": "string" }, "value": { "description": "Value for this variable", "type": "string" }, "isError": { "description": "Indicates if there are any validation failures in this response", "type": "boolean" }, "validationFailures": { "items": { "$ref": "#/definitions/ValidationFailure" }, "type": "array", "description": "Validation failures of this request object" }, "usedMessageVariables": { "type": "object", "description": "Used variables by Message Variable Source", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, "AlertSettingsVariableSource": { "type": "string", "enum": [ "Alert", "Contact", "CSV", "Survey" ] }, "AlertStatus": { "properties": { "id": { "format": "int32", "type": "integer" }, "status": { "type": "string" }, "alertCompletion": { "enum": [ "Sent", "Processing", "Failed" ], "type": "string" }, "pollResults": { "$ref": "#/definitions/PollResults" } }, "type": "object" }, "AlertType": { "type": "string", "enum": [ "Unused", "Default", "Poll", "Conference" ] }, "ApiResponse": { "discriminator": "type", "properties": { "status": { "$ref": "#/definitions/ResponseStatus" }, "hasErrors": { "description": "Set true when status.isSuccess is false.", "type": "boolean" }, "isValid": { "description": "Set false on API parameter validation failures.", "type": "boolean" } }, "type": "object" }, "ApplicationFeature": { "discriminator": "discriminator", "properties": { "featureType": { "enum": [ "Disclaimer" ], "type": "string" } }, "type": "object" }, "ApplicationFeatureSet": { "properties": { "disclaimer": { "$ref": "#/definitions/DisclaimerFeature" } }, "type": "object" }, "AssetInformation": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "externalId": { "type": "string" } }, "type": "object" }, "Association": { "description": "Defines associations between the domain models and other entities. Supported domain models include Disclaimers and Incidents. Supported key values include Asset.ExternalId, Area, Subarea.", "properties": { "key": { "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "BasicMessage": { "properties": { "message": { "type": "string" }, "subject": { "type": "string" }, "messageRichContent": { "type": "string" }, "messageBody": { "type": "string" }, "externalLink": { "type": "string" } }, "type": "object" }, "BulkSendAlertRequest": { "properties": { "tenantId": { "format": "int32", "type": "integer" }, "alerts": { "type": "array", "items": { "$ref": "#/definitions/SendAlertRequest" } }, "jobId": { "type": "string" } }, "type": "object" }, "BulkSendAlertResponse": { "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "jobId": { "type": "string" }, "alertResults": { "type": "array", "items": { "$ref": "#/definitions/SendAlertResult" } } } } ], "type": "object" }, "ChannelDeliveries": { "properties": { "email": { "items": { "$ref": "#/definitions/ChannelDelivery" }, "type": "array" }, "fax": { "items": { "$ref": "#/definitions/ChannelDelivery" }, "type": "array" }, "microsoftTeams": { "items": { "$ref": "#/definitions/ChannelDelivery" }, "type": "array" }, "mobile": { "items": { "$ref": "#/definitions/ChannelDelivery" }, "type": "array" }, "pager": { "items": { "$ref": "#/definitions/ChannelDelivery" }, "type": "array" }, "sms": { "items": { "$ref": "#/definitions/ChannelDelivery" }, "type": "array" }, "text": { "items": { "$ref": "#/definitions/ChannelDelivery" }, "type": "array" }, "voice": { "items": { "$ref": "#/definitions/ChannelDelivery" }, "type": "array" } }, "type": "object" }, "ChannelDelivery": { "properties": { "status": { "type": "string" }, "excluded": { "type": "boolean" } }, "type": "object" }, "ChannelSettings": { "properties": { "eas": { "$ref": "#/definitions/EasChannel" }, "email": { "$ref": "#/definitions/EmailChannel" }, "etn": { "$ref": "#/definitions/EtnChannel" }, "facebook": { "$ref": "#/definitions/FacebookChannel" }, "fax": { "$ref": "#/definitions/FaxChannel" }, "push": { "$ref": "#/definitions/PushChannel" }, "textMessage": { "$ref": "#/definitions/TextMessageChannel" }, "twitter": { "$ref": "#/definitions/TwitterChannel" }, "nextdoor": { "$ref": "#/definitions/NextdoorChannel" }, "voice": { "$ref": "#/definitions/VoiceChannel" }, "mobileBroadcast": { "$ref": "#/definitions/MobileBroadcastChannel" }, "myAlertsApp": { "$ref": "#/definitions/MyAlertsAppChannel" }, "microsoftTeams": { "$ref": "#/definitions/MicrosoftTeamsChannel" } }, "type": "object" }, "ChatUser": { "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "emailAddress": { "type": "string" }, "publicKey": { "type": "string" }, "avatarUrl": { "type": "string" }, "metadata": { "type": "string" } }, "type": "object" }, "ClientRequestContext": { "properties": { "templateId": { "format": "int32", "type": "integer", "x-nullable": true }, "isResend": { "type": "boolean" }, "platform": { "type": "string" }, "clientId": { "type": "string" }, "clientName": { "type": "string" }, "clientVersion": { "type": "string" }, "deviceId": { "type": "string" } }, "type": "object" }, "ConferenceInvitation": { "properties": { "keyword": { "type": "string" }, "keywordId": { "type": "string" }, "question": { "type": "string" } }, "type": "object" }, "Contact": { "properties": { "id": { "format": "int32", "type": "integer" }, "credentialId": { "format": "int32", "type": "integer" }, "externalId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "emails": { "items": { "$ref": "#/definitions/EmailAddress" }, "type": "array" }, "phones": { "items": { "$ref": "#/definitions/PhoneNumber" }, "type": "array" }, "chatUser": { "$ref": "#/definitions/ChatUser" }, "asset": { "$ref": "#/definitions/AssetInformation" }, "type": { "type": "string" }, "notes": { "type": "string" }, "mobileAppUser": { "type": "boolean" }, "agency": { "type": "string" }, "status": { "type": "string" }, "businessAddress": { "type": "string" } }, "type": "object" }, "ContactInformation": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "$ref": "#/definitions/ContactInformationEmailAddress" } }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/definitions/ContactInformationPhone" } }, "devices": { "type": "array", "items": { "$ref": "#/definitions/ContactInformationDevice" } } } }, "ContactInformationDevice": { "type": "object", "properties": { "token": { "type": "string" } } }, "ContactInformationEmailAddress": { "type": "object", "properties": { "email": { "type": "string" }, "status": { "type": "string", "enum": [ "Unsubscribed", "Active" ] } } }, "ContactInformationPhone": { "type": "object", "properties": { "number": { "type": "string" }, "phoneType": { "type": "string", "enum": [ "Cell", "Business", "Home", "Government", "Fax", "Pager", "Blackberry", "None" ] }, "country": { "type": "string" }, "priority": { "type": "number" }, "providerDomain": { "type": "string" }, "provider": { "type": "string" }, "snppServer": { "type": "string" }, "localOnly": { "type": "boolean" } } }, "ContactSummary": { "properties": { "id": { "format": "int32", "type": "integer" }, "externalId": { "type": "string" }, "credentialId": { "format": "int32", "type": "integer" } }, "type": "object" }, "ContentSettings": { "properties": { "publicContentId": { "format": "int32", "type": "integer" }, "publicContentPageRequested": { "description": "Indicates that the alert sender wants a public alert page with an external link", "type": "boolean" } }, "type": "object" }, "CountResponse": { "properties": { "count": { "format": "int32", "type": "integer" } }, "type": "object" }, "CreateDistributionListFromFileRequest": { "type": "object", "properties": { "fileUrl": { "type": "string", "format": "uri" }, "pageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "default": 25 }, "returnFirstPage": { "type": "boolean", "default": true } } }, "CreateDistributionListFromFileResponse": { "type": "object", "allOf": [ { "$ref": "#/definitions/GetDistributionListRecipientsResponse" }, { "properties": { "id": { "type": "string" }, "tenantId": { "format": "int32", "type": "integer" }, "sources": { "type": "array", "items": { "$ref": "#/definitions/Reference" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/DistributionListError" } } } } ] }, "CreateShortenedUrlRequest": { "properties": { "originalUrl": { "description": "The original URL to be shortened", "type": "string" }, "createPlaceHolder": { "description": "Create placeholder", "type": "boolean" } }, "type": "object" }, "CustomMessageVariables": { "properties": { "useMessageVariables": { "type": "boolean" }, "csvDistributionListId": { "type": "string" }, "validMessages": { "type": "boolean" }, "resolvedMessages": { "type": "object", "additionalProperties": { "$ref": "#/definitions/AlertSettingsValue" } } }, "type": "object" }, "DeliverySummary": { "properties": { "delivery": { "type": "object", "additionalProperties": { "type": "integer" } }, "id": { "format": "int32", "type": "integer" }, "poll": { "$ref": "#/definitions/PollQuestionResults" }, "mobileBroadcast": { "items": { "$ref": "#/definitions/MobileBroadcastResultSummary" }, "type": "array" }, "totalRecipients": { "format": "int32", "type": "integer" } }, "type": "object" }, "DirectorySettings": { "properties": { "directoryId": { "type": "string" }, "contactIds": { "items": { "type": "string" }, "type": "array" }, "groupIds": { "items": { "type": "string" }, "type": "array" }, "mandatoryGroupIds": { "items": { "type": "string" }, "type": "array" }, "uniqueContactCount": { "format": "int32", "type": "integer" }, "geoTargetUsers": { "type": "boolean" } }, "type": "object" }, "DisclaimerFeature": { "type": "object", "description": "Describes the disclaimer feature", "properties": { "accepted": { "type": "boolean" }, "name": { "type": "string" } } }, "DisclaimerFeatureItem": { "allOf": [ { "$ref": "#/definitions/ApplicationFeature" }, { "type": "object", "properties": { "accepted": { "type": "boolean" }, "name": { "type": "string" } } } ] }, "DisplayGroup": { "type": "object", "properties": { "id": { "type": "string" }, "parentId": { "type": "string" }, "path": { "type": "string" }, "name": { "type": "string" } } }, "DisplayRole": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "hasFullCommAccess": { "type": "boolean" }, "ignoreMandatoryAlertGroupPolicies": { "type": "boolean" }, "order": { "format": "int32", "type": "integer" } } }, "DistributionListError": { "type": "object", "properties": { "error": { "type": "string" }, "reference": { "$ref": "#/definitions/Reference" } } }, "DistributionProfile": { "type": "object", "properties": { "tenantId": { "type": "string" }, "userId": { "type": "string" }, "externalId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "contactInformation": { "$ref": "#/definitions/ContactInformation" }, "notificationPreferences": { "$ref": "#/definitions/NotificationPreferences" }, "mandatory": { "type": "boolean" }, "customMessageVariables": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EasChannel": { "properties": { "easDetailsUrl": { "type": "string" }, "easId": { "format": "int32", "type": "integer" }, "recipientCount": { "format": "int32", "type": "integer" }, "send": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "EmailAddress": { "properties": { "address": { "type": "string" } } }, "EmailChannel": { "properties": { "recipientCount": { "format": "int32", "type": "integer" }, "send": { "type": "boolean" }, "requestConfirmation": { "description": "When true, it instructs the backend to add a prompt for the recipient to confirm receipt of the email.", "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "EmailResultSummary": { "properties": { "UserId": { "format": "int32", "type": "integer" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "SentToEmail": { "type": "boolean" }, "Email": { "type": "string" }, "SendToCell": { "type": "boolean" }, "CellSent": { "type": "boolean" }, "CellPhone": { "type": "string" }, "CellPhoneProvider": { "type": "string" }, "SendToFax": { "type": "boolean" }, "Fax": { "type": "string" }, "Enabled": { "type": "boolean" }, "Private": { "type": "boolean" }, "ConfirmEmail": { "type": "boolean" }, "DeliveryStatus": { "type": "string" } } }, "EmailResultsSummaryResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiPascalResponse" }, { "properties": { "Items": { "items": { "$ref": "#/definitions/EmailResultSummary" }, "type": "array" } } } ], "type": "object" }, "ErrorResponse": { "properties": { "error": { "type": "string" } }, "type": "object" }, "EtnChannel": { "properties": { "send": { "type": "boolean" }, "publicUsers": { "type": "boolean" }, "importUsers": { "type": "boolean" }, "directoryUsers": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "EtnResultSummary": { "properties": { "Phone": { "type": "string" }, "Status": { "type": "string" }, "KeyPress": { "type": "string" }, "Duration": { "format": "int32", "type": "integer" }, "LastMessage": { "type": "string" }, "Sent": { "format": "date-time", "type": "string" } } }, "EtnResultsSummaryResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiPascalResponse" }, { "properties": { "Items": { "items": { "$ref": "#/definitions/EtnResultSummary" }, "type": "array" }, "EtnStatus": { "type": "string", "enum": [ "Processing", "Completed", "HasErrors", "Cancelled" ] }, "DateCancelledUtc": { "format": "date-time", "type": "string" } } } ], "type": "object" }, "FacebookChannel": { "properties": { "recipientCount": { "format": "int32", "type": "integer" }, "send": { "type": "boolean" }, "message": { "type": "string" }, "pageIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "type": "object" }, "Facility": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "location": { "$ref": "#/definitions/GeoLocation" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "area": { "type": "string" }, "region": { "type": "string" }, "phoneNumber": { "type": "string" } }, "type": "object" }, "FacilityReference": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "location": { "$ref": "#/definitions/GeoLocation" } }, "type": "object" }, "FacilitySettings": { "properties": { "facilities": { "type": "array", "items": { "$ref": "#/definitions/FacilityReference" } }, "areas": { "type": "array", "items": { "$ref": "#/definitions/SelectedAreaReference" } } }, "type": "object" }, "FaxChannel": { "properties": { "recipientCount": { "format": "int32", "type": "integer" }, "send": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "Feature": { "type": "object", "properties": { "geometry": { "$ref": "#/definitions/IGeometryObject" }, "id": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "type": "object" } }, "bbox": { "type": "array", "items": { "format": "double", "type": "number" } }, "crs": { "$ref": "#/definitions/IcrsObject" }, "type": { "enum": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ], "type": "string" } } }, "FeatureCollection": { "type": "object", "properties": { "features": { "type": "array", "items": { "$ref": "#/definitions/Feature" } }, "spatialReference": { "$ref": "#/definitions/SpatialReference" }, "bbox": { "type": "array", "items": { "format": "double", "type": "number" } }, "crs": { "$ref": "#/definitions/IcrsObject" }, "type": { "enum": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ], "type": "string" } } }, "FeatureCollectionRequest": { "properties": { "geoJson": { "$ref": "#/definitions/FeatureCollection" }, "countsOnly": { "type": "boolean" }, "groupIds": { "items": { "type": "string" }, "type": "array" }, "legacyGroupIds": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "FeatureLayerSettings": { "properties": { "DirectoryId": { "type": "string" }, "Name": { "type": "string" }, "Count": { "format": "int32", "type": "integer" }, "FeaturesSource": { "enum": [ "Default", "Assets", "Users", "Groups", "MobileUsers", "PublicUsers", "InternalUsers", "InfoCode", "E911", "MyAlertsAppUsers", "MultiDirectoryUsers", "Facilities" ], "type": "string" }, "FilterGroupIds": { "items": { "type": "string" }, "type": "array" }, "FilterLegacyGroupIds": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "Field": { "properties": { "name": { "type": "string" }, "required": { "type": "boolean" }, "systemRequired": { "type": "boolean" }, "invisible": { "type": "boolean" }, "readonly": { "type": "boolean" }, "autofill": { "type": "boolean" } } }, "FileDetails": { "properties": { "contentType": { "type": "string" }, "fileName": { "type": "string" }, "length": { "format": "double", "type": "number" }, "uri": { "format": "uri", "type": "string" }, "fileAttachmentType": { "enum": [ "None", "Private", "Public", "VoiceMessage", "SocialMediaImage" ], "type": "string" }, "description": { "type": "string" }, "fileMetadata": { "type": "object", "additionalProperties": { "type": "string" } }, "ownerId": { "type": "integer", "format": "int32" } }, "type": "object" }, "FileModel": { "properties": { "Id": { "type": "string", "format": "guid" }, "FileName": { "type": "string" }, "ContentType": { "type": "string" }, "Extension": { "type": "string" }, "Length": { "format": "double", "type": "number" }, "FileSize": { "type": "string" }, "Folder": { "type": "string" }, "Path": { "type": "string" }, "PublicUrl": { "type": "string" }, "IsPrivate": { "type": "boolean" }, "FileAttachmentType": { "enum": [ "None", "Private", "Public", "VoiceMessage", "SocialMediaImage" ], "type": "string" }, "VoiceAudioUrl": { "type": "string" }, "EasAudioUrl": { "type": "string" }, "IsAudio": { "type": "boolean" }, "IsImage": { "type": "boolean" }, "DateCreated": { "type": "string", "format": "date-time" }, "Description": { "type": "string" }, "Metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "OwnerId": { "type": "integer", "format": "int32" } } }, "FindAlertRequest": { "type": "object", "properties": { "hidden": { "description": "Filter alerts by visibility.", "type": "boolean" }, "hiddenReceived": { "description": "Filter alerts by received and whether to return hidden or visible.", "type": "boolean" }, "unreadReceived": { "description": "Filter alerts by received and whether to return read or unread.", "type": "boolean" }, "alertType": { "description": "Filter alerts by type.", "$ref": "#/definitions/AlertType" }, "messagepriority": { "description": "Filter alerts by priority.", "$ref": "#/definitions/PriorityType" }, "subject": { "description": "Filter alerts by subject.", "type": "string" }, "from": { "description": "Filter alerts by sender.", "type": "string" }, "senderIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "recipientIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "after": { "description": "Filter alerts by date sent.", "type": "string", "format": "date-time" }, "before": { "description": "Filter alerts by date sent.", "type": "string", "format": "date-time" }, "facilityName": { "description": "Filter alerts by facility name.", "type": "string" }, "incident": { "description": "Filter alerts by incident name.", "type": "string" }, "isDefault": { "type": "boolean" }, "loadPollResults": { "type": "boolean" }, "associations": { "description": "Associations describing which users sent the alert(s).", "items": { "$ref": "#/definitions/Association" }, "type": "array" }, "page": { "description": "The page number of items to return. (1 by default)", "default": 1, "type": "integer", "format": "int32" }, "pageSize": { "description": "The desired number of items per page. (25 by default)", "default": 25, "type": "integer", "format": "int32" }, "sort": { "description": "A comma seperated list of properties to order by. Properties preceded by a '-' will be ordered descending. (e.g. ?sort=lastName,firstName,-responseTime). Property names are case insensitive.", "type": "string" }, "alertStatuses": { "description": "Filter alerts by status.", "type": "array", "items": { "type": "string", "enum": [ "Unknown", "New", "Queued", "Processing", "Sent", "Canceled", "Scheduled", "Unscheduled" ] } } } }, "FindContactRequest": { "type": "object", "properties": { "contactIds": { "description": "the contact ids of the contacts to return, respecting AGs", "type": "array", "items": { "type": "integer", "format": "int32" } }, "forcedContactIds": { "description": "the contact ids of the contacts to return, ignoring AGs", "type": "array", "items": { "type": "integer", "format": "int32" } }, "externalIds": { "description": "the externalIds of the contacts to return, respecting AGs", "type": "array", "items": { "type": "string" } }, "groupId": { "description": "the group id of the contacts to return", "type": "integer", "format": "int32" }, "groupIds": { "description": "A set of Group Ids that contacts belong to", "type": "array", "items": { "type": "integer", "format": "int32" } }, "adminIds": { "description": "A set of Admin Ids to resolve into contacts", "type": "array", "items": { "type": "integer", "format": "int32" } }, "credentialIds": { "description": "A set of Credential Ids to resolve into contacts", "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeNestedGroups": { "description": "When used in conjunction with groupId or groupIds asks the system to return all contacts in the groups specified and all of the nested groups underneath the groups specified.", "type": "boolean" }, "chatEnabledOnly": { "description": "search for contacts, returning only those who have a chat user id", "type": "boolean" }, "includeAsset": { "description": "include Asset information along with each contact (true by default)", "type": "boolean" }, "search": { "description": "A value matched against one or more resource properties.", "type": "string" }, "lastNameSearch": { "description": "A value match the first letter of the Contact Last Name", "type": "string" }, "emailSearch": { "description": "A value match against characters in the contact emails", "type": "string" }, "emailPrefixMatching": { "description": "If an email is passed in, indicates that the email must start with the provided value.", "type": "boolean" }, "phoneNumberSearch": { "description": "A value match against characters in the contact Cell Phone, Home Phone, or Business Phone", "type": "string" }, "agencySearch": { "description": "A value match against characters in the contact Agency", "type": "string" }, "titleSearch": { "description": "A value match against characters in the contact Title", "type": "string" }, "NotesSearch": { "description": "A value match against characters in the contact Notes", "type": "string" }, "AddressSearch": { "description": "A value match against characters in the contact Address", "type": "string" }, "includeIsMobileUser": { "description": "Include whether login is a Mobile user (false by default)", "type": "boolean" }, "findUngroupedMembers": { "description": "Find Ungrouped Members (false by default)", "type": "boolean" }, "associations": { "description": "Associations describing which users sent the alert(s).", "items": { "$ref": "#/definitions/Association" }, "type": "array" }, "page": { "description": "The page number of items to return. (1 by default)", "default": 1, "type": "integer", "format": "int32" }, "pageSize": { "description": "The desired number of items per page. (25 by default)", "default": 25, "type": "integer", "format": "int32" }, "sort": { "description": "A comma seperated list of properties to order by. Properties preceded by a '-' will be ordered descending. (e.g. ?sort=lastName,firstName,-responseTime). Property names are case insensitive.", "type": "string" }, "userType": { "type": "string", "enum": [ "Internal", "Public" ] }, "includePhoneStatus": { "description": "Include whether to return opt-out status for phones (false by default)", "type": "boolean" }, "zipSearch": { "description": "A value match against characters in the contact Zip Code", "type": "string" } } }, "FormType": { "type": "string", "enum": [ "Unused", "Eas", "Quick", "Public", "Balsa", "Unknown" ] }, "GeoLocation": { "properties": { "latitude": { "format": "double", "type": "number" }, "longitude": { "format": "double", "type": "number" } } }, "GetDistributionListRecipientsResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "items": { "$ref": "#/definitions/DistributionProfile" }, "type": "array" } } } ], "type": "object" }, "GroupSummary": { "properties": { "id": { "format": "int32", "type": "integer" }, "externalId": { "type": "string" }, "isLink": { "type": "boolean" }, "name": { "type": "string" }, "classification": { "type": "string" }, "parentId": { "format": "int32", "type": "integer" }, "path": { "type": "string" } }, "type": "object" }, "GroupTreeNode": { "properties": { "id": { "format": "int32", "type": "integer" }, "parentId": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "isLink": { "type": "boolean" }, "externalId": { "type": "string" }, "classification": { "type": "string" }, "childGroupCount": { "format": "int32", "type": "integer" }, "memberCount": { "format": "int32", "type": "integer" }, "showOnPublicSignUp": { "type": "boolean" }, "defaultPublicGroup": { "type": "boolean" }, "description": { "type": "string" }, "addedOn": { "type": "string", "format": "date-time" }, "path": { "type": "string" } }, "type": "object" }, "IGeometryObject": { "type": "object", "description": "GeoJSon geometry", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ] }, "bbox": { "type": "array", "items": { "format": "double", "type": "number" } }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "maxItems": 2, "minItems": 2, "items": { "format": "double", "type": "number" } } } } } }, "IcrsObject": { "type": "object", "properties": { "type": { "enum": [ "Unspecified", "Name", "Link" ], "type": "string", "readOnly": true } } }, "Identity": { "properties": { "id": { "format": "int32", "type": "integer" }, "username": { "type": "string" }, "isAuthenticated": { "type": "boolean" } }, "type": "object" }, "IncidentCategory": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "IncidentEvent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "incidentCategory": { "$ref": "#/definitions/IncidentCategory" }, "incidentType": { "$ref": "#/definitions/IncidentType" }, "largeScaleEventId": { "type": "string" } } }, "IncidentSettings": { "properties": { "id": { "type": "string", "description": "Type: Guid. Identifier for this incident." }, "name": { "type": "string" }, "type": { "enum": [ "Generic", "Named", "NotSpecified" ], "type": "string" }, "priority": { "$ref": "#/definitions/PriorityType" }, "externalId": { "type": "string" } }, "type": "object" }, "IncidentType": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "showAssessment": { "type": "boolean" }, "classification": { "description": "Incident type classification.", "enum": [ "Emergency", "Operations" ], "type": "string" }, "loudToneSettings": { "$ref": "#/definitions/LoudToneSettings" } } }, "JobEvent": { "type": "object", "properties": { "id": { "type": "string" }, "jobId": { "type": "string" }, "stage": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } } }, "messages": { "type": "array", "items": { "$ref": "#/definitions/JobMessage" } }, "metadata": { "description": "Additional metadata about the job event", "$ref": "#/definitions/Metadata" }, "timestamp": { "type": "string", "format": "date-time" } } }, "JobMessage": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } }, "JobStage": { "type": "object", "properties": { "id": { "type": "string" }, "jobId": { "type": "string" }, "parentId": { "type": "string" }, "name": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } }, "JobState": { "type": "string", "enum": [ "Queued", "Running", "Success", "Failure" ] }, "JobStatus": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/definitions/JobType" }, "state": { "$ref": "#/definitions/JobState" }, "isSuccess": { "type": "boolean" }, "metadata": { "description": "Additional metadata about the job", "$ref": "#/definitions/Metadata" } } }, "JobType": { "type": "string", "enum": [ "Geocoding", "Sftp", "TaskListReminder", "AlertPreview", "SendAlert", "ExtractUsageData", "Installer", "TeamsDiscovery", "LargeScaleIncident", "BulkAlert", "BulkTaskListActivation", "ContactUploadPreview", "ContactUploadImport" ] }, "LatLng": { "properties": { "lat": { "format": "double", "type": "number" }, "lng": { "format": "double", "type": "number" } }, "type": "object" }, "LocationSettings": { "properties": { "point": { "$ref": "#/definitions/LatLng" }, "facilities": { "items": { "$ref": "#/definitions/Facility" }, "type": "array" }, "areas": { "items": { "$ref": "#/definitions/SelectedArea" }, "type": "array" } }, "type": "object" }, "LoudToneSettings": { "type": "object", "properties": { "onInitialIncidentReport": { "type": "boolean" }, "onReply": { "type": "boolean" }, "onForward": { "type": "boolean" }, "onAssociatedEventCommunication": { "type": "boolean" } } }, "MessageSettings": { "properties": { "basic": { "$ref": "#/definitions/BasicMessage" }, "conference": { "$ref": "#/definitions/ConferenceInvitation" }, "files": { "items": { "$ref": "#/definitions/FileDetails" }, "type": "array" }, "language": { "type": "string" }, "translate": { "type": "boolean", "x-nullable": true }, "poll": { "$ref": "#/definitions/PollQuestionModel" }, "priority": { "$ref": "#/definitions/PriorityType" }, "incidentId": { "type": "string" }, "incidentEvent": { "$ref": "#/definitions/IncidentEvent" }, "incident": { "$ref": "#/definitions/IncidentSettings" }, "severityAssessment": { "$ref": "#/definitions/SeverityAssessment" }, "survey": { "$ref": "#/definitions/SurveySettings" }, "socialMedia": { "$ref": "#/definitions/SocialMediaSettings" }, "content": { "$ref": "#/definitions/ContentSettings" }, "expireDateTimeUtc": { "format": "date-time", "type": "string" }, "customMessageVariables": { "$ref": "#/definitions/CustomMessageVariables" } }, "type": "object" }, "Metadata": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "statistics": { "type": "object", "additionalProperties": { "type": "number", "format": "float" } }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "tenantId": { "type": "string" }, "ownerId": { "type": "string" }, "featuresInUse": { "type": "array", "items": { "type": "string" } } } }, "MicrosoftTeamsChannel": { "properties": { "send": { "type": "boolean" }, "message": { "type": "string" }, "sendWithHighImportance": { "type": "boolean" } }, "type": "object" }, "MobileBroadcastChannel": { "properties": { "send": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "MobileBroadcastResultSummary": { "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "timestamp": { "type": "string" } }, "type": "object" }, "MobileBroadcastSettings": { "type": "object", "properties": { "areaDesc": { "type": "string" }, "selectedLocations": { "items": { "$ref": "#/definitions/NamedLocation" }, "type": "array" } } }, "MunicipalArea": { "properties": { "stateName": { "type": "string" }, "countyName": { "type": "string" }, "cityName": { "type": "string" }, "stateCode": { "type": "string" }, "fipsCode": { "type": "string" }, "type": { "enum": [ "None", "State", "County", "City" ], "type": "string" } }, "type": "object" }, "MunicipalCity": { "properties": { "cityName": { "type": "string" }, "stateCode": { "type": "string" } }, "type": "object" }, "MunicipalSettings": { "properties": { "cities": { "items": { "$ref": "#/definitions/MunicipalCity" }, "type": "array" }, "sendTo": { "items": { "$ref": "#/definitions/FeatureLayerSettings" }, "type": "array" }, "zipCodes": { "items": { "type": "string" }, "type": "array" }, "selections": { "items": { "$ref": "#/definitions/MunicipalArea" }, "type": "array" } }, "type": "object" }, "MyAlertsAppChannel": { "properties": { "send": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "NamedLocation": { "properties": { "name": { "type": "string" }, "geocodeId": { "type": "string" } }, "type": "object" }, "NextdoorAccount": { "properties": { "id": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "groups": { "items": { "$ref": "#/definitions/NextdoorGroup" }, "type": "array" } } }, "NextdoorChannel": { "properties": { "send": { "type": "boolean" }, "message": { "type": "string" }, "hashTag": { "type": "string" }, "accounts": { "items": { "$ref": "#/definitions/NextdoorAccount" }, "type": "array" } }, "type": "object" }, "NextdoorChannelStatus": { "properties": { "id": { "format": "int32", "type": "integer" }, "regionId": { "format": "int32", "type": "integer" }, "alertId": { "format": "int32", "type": "integer" }, "userId": { "format": "int32", "type": "integer" }, "accountId": { "format": "int32", "type": "integer" }, "accountName": { "type": "string" }, "postUrl": { "type": "string" }, "statusCode": { "type": "string" }, "isError": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "string" } }, "createdDateUtc": { "format": "date-time", "type": "string" }, "createdBy": { "type": "string" } } }, "NextdoorGroup": { "properties": { "id": { "format": "int32", "type": "integer" }, "name": { "type": "string" } } }, "NotificationPreferences": { "type": "object", "properties": { "plainTextEmailMode": { "type": "boolean" }, "onVacationEmailOnly": { "type": "boolean" }, "confirmationEmailHash": { "type": "string" }, "writtenLanguageCode": { "type": "string" }, "spokenLanguageCode": { "type": "string" } } }, "ObjectReference": { "type": "object", "properties": { "id": { "type": "string" }, "uri": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "PagedAlertSettingsResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "items": { "$ref": "#/definitions/AlertSettings" }, "type": "array" } } } ], "type": "object" }, "PagedApiPascalResponse": { "discriminator": "type", "properties": { "Page": { "format": "int32", "type": "integer" }, "PageCount": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "type": "integer" }, "TotalItemCount": { "format": "int32", "type": "integer" }, "Status": { "$ref": "#/definitions/ResponseStatus" }, "HasErrors": { "description": "Set true when status.isSuccess is false.", "type": "boolean" }, "IsValid": { "description": "Set false on API parameter validation failures.", "type": "boolean" } }, "type": "object" }, "PagedApiResponse": { "discriminator": "type", "properties": { "page": { "format": "int32", "type": "integer" }, "pageCount": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "totalItemCount": { "format": "int32", "type": "integer" }, "status": { "$ref": "#/definitions/ResponseStatus" }, "hasErrors": { "description": "Set true when status.isSuccess is false.", "type": "boolean" }, "isValid": { "description": "Set false on API parameter validation failures.", "type": "boolean" } }, "type": "object" }, "PagedContactResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "items": { "$ref": "#/definitions/Contact" }, "type": "array" } } } ], "type": "object" }, "PagedGroupTreeNodeResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "items": { "$ref": "#/definitions/GroupTreeNode" }, "type": "array" } } } ], "type": "object" }, "PagedJobEventsResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/JobEvent" } } } } ] }, "PagedJobStagesResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/JobStage" } } } } ] }, "PagedJobStatusResponse": { "type": "object", "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/JobStatus" } } } } ] }, "PagedNextdoorChannelStatusResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "items": { "$ref": "#/definitions/NextdoorChannelStatus" }, "type": "array" } }, "type": "object" } ], "type": "object" }, "PagedRecipientResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiResponse" }, { "properties": { "items": { "items": { "$ref": "#/definitions/Recipient" }, "type": "array" } }, "type": "object" } ], "type": "object" }, "PersonName": { "properties": { "givenName": { "type": "string" }, "familyName": { "type": "string" } }, "type": "object" }, "PhoneNumber": { "properties": { "number": { "type": "string" }, "priority": { "format": "int32", "type": "integer" }, "phoneType": { "enum": [ "Cell", "Business", "Home", "Government", "Fax", "Pager", "Blackberry", "None" ], "type": "string" }, "smsStatus": { "type": "string", "enum": [ "Inactive", "Unsubscribed", "Active", "Unsupported", "UnreachablePhoneNumber" ] }, "smsOptOutDate": { "format": "date-time", "type": "string" }, "voiceStatus": { "type": "string", "enum": [ "Inactive", "Unsubscribed", "Active", "Unsupported", "UnreachablePhoneNumber" ] }, "voiceOptOutDate": { "format": "date-time", "type": "string" } } }, "PipelineSettings": { "properties": { "useEmailModuleV3": { "type": "boolean" } } }, "PlatformBundle": { "type": "object", "properties": { "uri": { "type": "string" }, "version": { "type": "string" } } }, "PollOptionModel": { "properties": { "optionId": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "selectionChoice": { "format": "int32", "type": "integer" }, "value": { "type": "string" }, "criticality": { "type": "string", "description": "The criticality level of this option", "enum": [ "None", "Critical" ] } }, "type": "object" }, "PollOptionResult": { "properties": { "optionId": { "format": "int32", "type": "integer" }, "count": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "selectionChoice": { "format": "int32", "type": "integer" }, "value": { "format": "int32", "type": "integer" }, "criticality": { "type": "string", "description": "The criticality level of this option", "enum": [ "None", "Critical" ] } }, "type": "object" }, "PollOptionResults": { "properties": { "count": { "type": "integer", "format": "int32", "description": "Number of recipients that have responded with this option" }, "description": { "type": "string", "description": "The text for this option." }, "optionId": { "type": "integer", "format": "int32", "description": "Id of this option" }, "selectionChoice": { "type": "integer", "format": "int32", "description": "Ordinal number of this option" }, "value": { "type": "integer", "format": "int32", "description": "The value for this option" }, "criticality": { "type": "string", "description": "The criticality level of this option", "enum": [ "None", "Critical" ] } }, "type": "object" }, "PollQuestionModel": { "properties": { "keyword": { "type": "string" }, "keywordId": { "type": "string" }, "options": { "items": { "$ref": "#/definitions/PollOptionModel" }, "type": "array" }, "question": { "type": "string" }, "questionId": { "format": "int32", "type": "integer" } }, "type": "object" }, "PollQuestionResults": { "properties": { "optionResults": { "items": { "$ref": "#/definitions/PollOptionResult" }, "type": "array" }, "question": { "type": "string" }, "totalResponded": { "format": "int32", "type": "integer" } }, "type": "object" }, "PollResults": { "properties": { "totalResponded": { "type": "integer", "format": "int32", "description": "Number of recipients that have responded" }, "question": { "type": "string", "description": "The question for the poll." }, "optionResults": { "items": { "$ref": "#/definitions/PollOptionResults" }, "type": "array" } }, "type": "object" }, "PreviewAlertRequest": { "description": "The templatedId parameter is deprecated. Clients should send alert settings via the settings parameter.", "properties": { "templateId": { "description": "Deprecated. Clients should send alert settings via the settings parameter.", "format": "int32", "type": "integer" }, "settings": { "$ref": "#/definitions/AlertSettings" }, "jobId": { "type": "string" } }, "type": "object" }, "PriorityOption": { "enum": [ "None", "Override", "UserPreference" ], "type": "string" }, "PriorityOrder": { "enum": [ "Cell", "Business", "Home" ], "type": "string" }, "PrioritySettings": { "properties": { "priorityOption": { "$ref": "#/definitions/PriorityOption" }, "priorityOrder": { "type": "array", "items": { "$ref": "#/definitions/PriorityOrder" } } }, "type": "object" }, "PriorityType": { "type": "string", "enum": [ "Emergency", "NonEmergency", "NotSpecified" ] }, "PushChannel": { "properties": { "recipientCount": { "format": "int32", "type": "integer" }, "send": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "Recipient": { "properties": { "channels": { "$ref": "#/definitions/ChannelDeliveries" }, "response": { "$ref": "#/definitions/RecipientResponse" }, "asset": { "$ref": "#/definitions/AssetInformation" }, "firstName": { "type": "string" }, "id": { "format": "int32", "type": "integer" }, "lastName": { "type": "string" }, "isMandatory": { "type": "boolean" }, "responseTime": { "type": "string", "format": "date-time" }, "responseChannel": { "type": "string" }, "directoryId": { "type": "string" }, "directoryUserId": { "type": "string" }, "confirm": { "type": "boolean" }, "confirmHash": { "type": "string" } }, "type": "object" }, "RecipientResponse": { "properties": { "channel": { "enum": [ "Sms", "Voice", "Text", "Email", "Fax", "Mobile", "MicrosoftTeams" ], "type": "string" }, "value": { "type": "integer", "format": "int32" }, "responseMethod": { "type": "string" } }, "type": "object" }, "RecipientSettings": { "properties": { "contactIds": { "items": { "format": "int32", "type": "integer" }, "type": "array" }, "groupIds": { "items": { "format": "int32", "type": "integer" }, "type": "array" }, "individualNumber": { "type": "string" }, "searchIds": { "items": { "type": "string" }, "type": "array" }, "mandatoryGroupIds": { "items": { "format": "int32", "type": "integer" }, "type": "array" }, "uniqueContactCount": { "format": "int32", "type": "integer" }, "uniqueEtnCount": { "format": "int32", "type": "integer" }, "uniqueMyAlertsAppCount": { "format": "int32", "type": "integer" }, "contacts": { "items": { "$ref": "#/definitions/ContactSummary" }, "type": "array" }, "groups": { "items": { "$ref": "#/definitions/GroupSummary" }, "type": "array" }, "searches": { "items": { "$ref": "#/definitions/SearchSummary" }, "type": "array" }, "geofences": { "$ref": "#/definitions/FeatureCollection" }, "featureLayers": { "items": { "$ref": "#/definitions/FeatureLayerSettings" }, "type": "array" }, "directories": { "items": { "$ref": "#/definitions/DirectorySettings" }, "type": "array" }, "municipals": { "$ref": "#/definitions/MunicipalSettings" }, "selectedGroupCount": { "format": "int32", "type": "integer" }, "selectedContactCount": { "format": "int32", "type": "integer" }, "uniqueGroupCount": { "format": "int32", "type": "integer" }, "distributionListId": { "type": "string" }, "adHocFileUrl": { "type": "string" }, "searchFilters": { "items": { "$ref": "#/definitions/AccessRecipe" }, "type": "array" } }, "type": "object" }, "Reference": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "uri": { "type": "string" } } }, "RelatedAlert": { "properties": { "relatedAlertId": { "format": "int32", "type": "integer" }, "alertRelationType": { "enum": [ "Related", "Forward", "Reply", "ReplyAll" ], "type": "string" }, "senderContacts": { "items": { "$ref": "#/definitions/Contact" }, "type": "array" } }, "type": "object" }, "RelatedAlertActions": { "type": "object", "properties": { "disableReplyAll": { "type": "boolean" } } }, "ResponseMessage": { "type": "object", "properties": { "severity": { "type": "string" }, "message": { "type": "string" }, "resourceKey": { "type": "string" } }, "example": { "severity": "Warning", "message": "My custom message", "resourceKey": "warnings.customMessage" } }, "ResponseStatus": { "type": "object", "properties": { "resourceKey": { "type": "string" }, "isSuccess": { "description": "False when errorCode is not None or there is an errorMessage or validationFailures.", "type": "boolean" }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string" }, "validationFailures": { "description": "API parameter validation failures.", "type": "array", "items": { "$ref": "#/definitions/ValidationFailure" } }, "messages": { "type": "array", "items": { "$ref": "#/definitions/ResponseMessage" } } }, "example": { "resourceKey": "error.notFound", "isSuccess": false, "errorCode": "NotFound", "errorMessage": "The item cannot be found.", "validationFailures": [ { "propertyName": "email", "errorMessage": "Value is required", "errorCode": "Required", "attemptedValue": "chester.tester@mailinator.com" } ], "messages": [ { "severity": "Warning", "message": "My custom message" } ] } }, "ScheduleSettings": { "properties": { "duration": { "format": "int32", "type": "integer" }, "expireDateTimeUtc": { "format": "date-time", "type": "string" }, "recurringDay": { "format": "int32", "type": "integer" }, "recurringEnd": { "format": "date-time", "type": "string" }, "scheduled": { "type": "boolean" }, "scheduledDateTime": { "format": "date-time", "type": "string" }, "icalData": { "type": "string" }, "scheduledAlertSettingsId": { "format": "int32", "type": "integer" }, "lastOccurrenceError": { "type": "boolean" }, "type": { "$ref": "#/definitions/ScheduleType" } }, "type": "object" }, "ScheduleType": { "type": "string", "enum": [ "Hickory", "Balsa" ] }, "SearchSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "SecuritySettings": { "properties": { "requireAuthentication": { "type": "boolean" }, "voicePin": { "type": "string" } }, "type": "object" }, "SelectedArea": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "geofences": { "$ref": "#/definitions/FeatureCollection" } }, "type": "object" }, "SelectedAreaReference": { "properties": { "id": { "type": "string" }, "filters": { "type": "array", "items": { "$ref": "#/definitions/AccessRecipe" } } }, "type": "object" }, "SendAlertRequest": { "properties": { "settings": { "$ref": "#/definitions/AlertDefaults" }, "templateId": { "format": "int32", "type": "integer" }, "jobId": { "description": "optional. A job identifier specified by the client to correlate this alert with a job. Maximum length is 100 characters.", "type": "string" }, "correlationKey": { "description": "optional. A key specified by the client to correlate this alert with other actions. Maximum length is 100 characters.", "type": "string" }, "async": { "description": "optional. Specifies whether an asynchrounous notification is sent to the sender on alert transition to final state", "type": "boolean" } }, "type": "object" }, "SendAlertResponse": { "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "AlertId": { "format": "int32", "type": "integer" }, "SentStatus": { "$ref": "#/definitions/AlertSentStatus" } } } ], "type": "object" }, "SendAlertResult": { "properties": { "correlationKey": { "type": "string" }, "isSuccess": { "type": "boolean" }, "message": { "type": "string" } } }, "SenderSettings": { "properties": { "id": { "format": "int32", "type": "integer" }, "asset": { "$ref": "#/definitions/AssetInformation" }, "callerId": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "externalId": { "type": "string" }, "name": { "$ref": "#/definitions/PersonName" } }, "type": "object" }, "SeverityAssessment": { "type": "object", "properties": { "responses": { "type": "array", "items": { "type": "object", "required": [ "questionId", "optionId" ], "properties": { "questionId": { "type": "string" }, "question": { "type": "string", "description": "Clients need not set this value. If missing, it will be set on the server." }, "optionId": { "type": "string" }, "option": { "type": "string", "description": "Clients need not set this value. If missing, it will be set on the server." } } } }, "comment": { "type": "string" } } }, "ShortenedUrl": { "properties": { "id": { "description": "ID of the shortened URL", "format": "int32", "type": "integer" }, "shortenedUrl": { "description": "Shortened URL of the shortened URL", "type": "string" }, "originalUrl": { "description": "Original URL of the shortened URL", "type": "string" }, "dateCreated": { "description": "Date created of the shortened URL", "format": "date-time", "type": "string" }, "dateUpdated": { "description": "Date updated of the shortened URL", "format": "date-time", "type": "string" }, "views": { "description": "Number of views of the shortened URL", "format": "int32", "type": "integer" }, "disabled": { "description": "Enabled state of the shortened URL", "type": "boolean" } }, "type": "object" }, "ShortenedUrlResponse": { "type": "object", "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/ShortenedUrl" } } } ] }, "SingleAlertDefaultsRequest": { "type": "object", "properties": { "alertType": { "description": "Filter default template for a specific alert type.", "$ref": "#/definitions/AlertType" }, "incidentId": { "description": "Filter default template for a specific incidentId.", "type": "string" }, "priority": { "description": "Filter default template for a specific priority.", "$ref": "#/definitions/PriorityType" }, "relatedAlertId": { "description": "The integer Id that you are relating the new alert to.", "format": "int32", "type": "integer" }, "relatedType": { "description": "The integer Id that you are relating the new alert to.", "enum": [ "Related", "Forward", "Reply", "ReplyAll" ], "type": "string" }, "pollQuestionId": { "description": "The integer Id of the poll question that you are relating the alert to.", "format": "int32", "type": "integer" }, "pollOptionId": { "description": "The integer Id of the poll option that you are relating the alert to.", "format": "int32", "type": "integer" }, "incidentEvent": { "$ref": "#/definitions/IncidentEvent" }, "templateId": { "description": "The Id of the template to base defaults on", "format": "int32", "type": "integer" }, "alertId": { "description": "The Id of a prior alert to base defaults on (resend or reschedule)", "format": "int32", "type": "integer" } } }, "SingleAlertDefaultsResponse": { "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/AlertDefaults" } } } ], "type": "object" }, "SingleAlertSettingsResponse": { "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/AlertSettings" } } } ], "type": "object" }, "SingleAlertStatusResponse": { "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/AlertStatus" } } } ], "type": "object" }, "SingleDeliverySummaryResponse": { "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/DeliverySummary" } } } ], "type": "object" }, "SingleJobStageStatusResponse": { "type": "object", "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/JobStage" } } } ] }, "SingleJobStatusResponse": { "type": "object", "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/JobStatus" } } } ] }, "SingleRecipientResponse": { "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/Recipient" } }, "type": "object" } ], "type": "object" }, "SingleUserResponse": { "allOf": [ { "$ref": "#/definitions/ApiResponse" }, { "properties": { "item": { "$ref": "#/definitions/User" } }, "type": "object" } ], "type": "object" }, "SmsResultSummary": { "properties": { "UserId": { "format": "int32", "type": "integer" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "PhoneNumber": { "type": "string" }, "PhoneType": { "type": "string" }, "Status": { "type": "string" }, "Sent": { "format": "date-time", "type": "string" } } }, "SmsResultsSummaryResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiPascalResponse" }, { "properties": { "Items": { "items": { "$ref": "#/definitions/SmsResultSummary" }, "type": "array" } } } ], "type": "object" }, "SocialMediaSettings": { "properties": { "image": { "$ref": "#/definitions/FileModel" } }, "type": "object" }, "SpatialReference": { "type": "object", "properties": { "wkid": { "format": "int32", "type": "integer" } } }, "SurveySettings": { "type": "object", "properties": { "sender": { "$ref": "#/definitions/SurveySummary" }, "recipient": { "$ref": "#/definitions/SurveySummary" } } }, "SurveySummary": { "type": "object", "properties": { "survey": { "$ref": "#/definitions/ObjectReference" }, "response": { "$ref": "#/definitions/ObjectReference" }, "allowMultipleResponses": { "type": "boolean" } } }, "TextMessageChannel": { "properties": { "recipientCount": { "format": "int32", "type": "integer" }, "send": { "type": "boolean" }, "primary": { "type": "boolean" }, "secondary": { "type": "boolean" }, "deliveryMethod": { "enum": [ "Sms", "Smtp" ], "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "TwitterChannel": { "properties": { "recipientCount": { "format": "int32", "type": "integer" }, "send": { "type": "boolean" }, "message": { "type": "string" }, "accountIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "type": "object" }, "UnreadCounts": { "properties": { "alerts": { "format": "int32", "type": "integer" }, "chats": { "format": "int32", "type": "integer" } }, "type": "object" }, "UpdateJobProgressRequest": { "type": "object", "properties": { "totalProgress": { "type": "integer", "format": "int32" }, "incrementProgress": { "type": "integer", "format": "int32" } } }, "UpdateJobStatusRequest": { "type": "object", "properties": { "jobState": { "$ref": "#/definitions/JobState" }, "metadata": { "$ref": "#/definitions/Metadata" } } }, "User": { "properties": { "agency": { "type": "string" }, "tenantId": { "format": "int32", "type": "integer" }, "id": { "format": "int32", "type": "integer" }, "name": { "$ref": "#/definitions/UserName" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "identity": { "$ref": "#/definitions/Identity" }, "features": { "description": "DEPRECATED: Use user.featureSet instead.", "items": { "$ref": "#/definitions/DisclaimerFeatureItem" }, "type": "array" }, "featureSet": { "$ref": "#/definitions/ApplicationFeatureSet" }, "bundle": { "$ref": "#/definitions/UserBundle" }, "bcp": { "$ref": "#/definitions/UserBundle" }, "chatApplicationId": { "type": "string" }, "sendBirdApplicationId": { "type": "string" }, "contact": { "$ref": "#/definitions/Contact" }, "unreadCounts": { "$ref": "#/definitions/UnreadCounts" } }, "type": "object" }, "UserBundle": { "type": "object", "properties": { "android": { "$ref": "#/definitions/PlatformBundle" }, "ios": { "$ref": "#/definitions/PlatformBundle" } } }, "UserName": { "type": "object", "properties": { "familyName": { "type": "string" }, "givenName": { "type": "string" } } }, "ValidationFailure": { "type": "object", "properties": { "propertyName": { "type": "string" }, "errorMessage": { "type": "string" }, "errorCode": { "type": "string" }, "attemptedValue": { "type": "object" }, "resourceKey": { "type": "string" } }, "example": { "propertyName": "email", "errorMessage": "Value is required", "errorCode": "Required", "attemptedValue": "chester.tester@mailinator.com", "resourceKey": "validation.required" } }, "VoiceChannel": { "properties": { "recipientCount": { "format": "int32", "type": "integer" }, "send": { "type": "boolean" }, "homePhone": { "type": "boolean" }, "cellPhone": { "type": "boolean" }, "businessPhone": { "type": "boolean" }, "landLine": { "type": "boolean" }, "message": { "type": "string" }, "audioFile": { "$ref": "#/definitions/FileModel" }, "channelMessage": { "type": "string" } }, "type": "object" }, "VoiceResultSummary": { "properties": { "UserId": { "format": "int32", "type": "integer" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Agency": { "type": "string" }, "PhoneNumber": { "type": "string" }, "PhoneType": { "type": "string" }, "Status": { "type": "string" }, "KeyPress": { "type": "string" }, "Duration": { "format": "int32", "type": "integer" }, "LastMessage": { "type": "string" }, "Sent": { "format": "date-time", "type": "string" } } }, "VoiceResultsSummaryResponse": { "allOf": [ { "$ref": "#/definitions/PagedApiPascalResponse" }, { "properties": { "Items": { "items": { "$ref": "#/definitions/VoiceResultSummary" }, "type": "array" } } } ], "type": "object" }, "WorkflowSettings": { "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "settings": { "type": "object", "additionalProperties": { "type": "string" } }, "triggers": { "items": { "type": "string" }, "type": "array" }, "version": { "type": "string" } }, "type": "object" } }, "securityDefinitions": { "Oauth2Scheme": { "type": "oauth2", "flow": "accessCode", "tokenUrl": "https://auth.alertsense.com/connect/token", "authorizationUrl": "https://auth.alertsense.com/account/login", "scopes": { "tamarack": "Hickory", "content": "ExternalID", "elm": "GIS" } }, "JwtBearerTokenScheme": { "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme. \r\n\r\n Enter 'Bearer' [space] and then your token in the text input below.\r\n\r\nExample: \"Bearer 12345abcdef\"", "name": "Authorization", "in": "header" } } }