DH Persons-Events-Subscription Status Rest API

DH Persons-Events-Subscription Status Rest API

Description

API allows importing of person and event data immediately to the Dialog Health platform as well as the ability to manage subscription status. Please note: API use is restricted to 250 requests per hour.
​
Access
  • HTTP Basic Authentication basic
Endpoints
https://[dialoghealth-server]/dialoghealth-importdata-api/
ApiController
update
PUT /api/{consoleCode}
Parameters
Path Parameters
Name
Description
Required
Pattern
consoleCode
A unique set of letters and numbers automatically assigned to each console upon creating
X
SIDJUL8079
Body Parameter
Name
Description
Required
Pattern
ImportRequest
ImportRequest
X
-
Return Type
ApiResponse
Content Type
  • application/json
Responses
Code
Message
Datatype
200
-
ApiResponse
400
-
ErrorResponse
Samples
Sample curl command to send request
$ curl --location --request PUT 'https://[dialoghealth-server]/dialoghealth-importdata-api/api/WEBMAG6745' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {credentials}' \
--data-raw '{request-body-json}'
Sample request body (json)
{
   "groupKeyword": null,
   "person": {
       "id": "recipient-id",
       "firstName": "fist-name",
       "lastName": "last-name",
       "dob": "03/22/1990",
       "email": "test@test.com",
       "msisdn": null,
       "additionalPhone": null,
       "misc1": "misc-1",
       "misc2": "misc-2",
       "misc3": "misc-3",
       "misc4": "misc-4",
       "misc5": "misc-5"
   },
   "address": {
       "city": "city",
       "state": "state",
       "zip": "zip",
       "street": "street"
   },
   "events": [
       {
           "id": "apptId",
           "name": "appt-name",
           "date": "08/21/1999 12:30 PM",
           "arrivalTime": "08:00 AM",
           "location": "appt location",
           "eventStatus": "SCHEDULED",
           "associate": "associate",
           "misc1": "misc-1",
           "misc2": "misc-2",
           "misc3": "misc-3",
           "misc4": "misc-4",
           "misc5": "misc-5"
       }
   ]
}
Sample response body (json)
{
   "requestId": "bb5d577b-ff92-48c2-8dd1-c80cac2a661f",
   "response": {
       "action": "CREATED"
   }
}
https://[dialoghealth-server]/dialoghealth-importdata-api/
ApiController
optOut
DELETE /api/{consoleCode}/{personId}
Parameters
Path Parameters
Name
Description
Required
Pattern
consoleCode
A unique set of letters and numbers automatically assigned to each console upon creating
X
SIDJUL8079
personId
Unique identifier of the person to be opted out
X
-
Body Parameter
None
Return Type
ApiResponse
Content Type
  • application/json
Responses
Code
Message
Datatype
200
-
ApiResponse
400
-
ErrorResponse
Samples
Sample curl command to send request
$ curl --location --request DELETE 'https://[dialoghealth-server]/dialoghealth-importdata-api/api/WEBMAG6745/347b8fc6487b4c3690944dc3e676b433' \
--header 'Authorization: Basic {credentials}' \
--data ''
Sample request body (json)
{
   "requestId": "f8d4c793-76c2-43f7-b9bf-7cb6734ee8ac",
   "response": {
       "action": "OPTOUT_SENT"
   }
}
Models
Address
Field Name
Required
Type
Description
city
-
String
City
state
-
String
State
zip
-
String
ZIP
street
-
String
Street
ApiResponse
Field Name
Type
Description
Format
requestId
String
Unique identifier of the request
-
response
Response
Response body
-
ErrorResponse
Field Name
Type
Description
Format
message
String
Error response message
-
Event
Field Name
Required
Type
Description
Format
id
-
String
Unique identifier of the event
-
name
X
String
Event name
-
date
X
String
Event date
MM/dd/yyyy hh:mm AM/PM
arrivalTime
-
String
Event arrival time
hh:mm AM/PM
location
-
String
Event location
-
eventStatus
X
String
Event status
Enum: CANCELED, COMPLETED, RESCHEDULED, DISCHARGED, SCHEDULED, NO_SHOW
associate
-
String
Event associate
-
misc1
-
String
Miscellaneous field for an event
-
misc2
-
String
Miscellaneous field for an event
-
misc3
-
String
Miscellaneous field for an event
-
misc4
-
String
Miscellaneous field for an event
-
misc5
-
String
Miscellaneous field for an event
-
ImportRequest
Field Name
Required
Type
Description
Format
groupKeyword
-
String
Group Keyword for optin
-
person
X
Person
Person information
-
address
X
Address
Address information
-
events
-
List of Events
Events information
-
Person
Field Name
Required
Type
Description
Format
Field Name
Required
Type
Description
Format
id
-
String
Unique identifier of the person
-
firstName
-
String
First name
-
lastName
-
String
Last name
-
dob
-
String
Date of birth
mm/dd/yyyy
email
-
String
Email
msisdn
-
String
Mobile phone number
10 digits without additional signs: 1234567890
additionalPhone
-
String
Additional mobile phone number
10 digits without additional signs: 1234567890
misc1
-
String
Miscellaneous field for a person
-
misc2
-
String
Miscellaneous field for a person
-
misc3
-
String
Miscellaneous field for a person
-
misc4
-
String
Miscellaneous field for a person
-
misc5
-
String
Miscellaneous field for a person
-
Response
Field Name
Type
Description
Format
action
String
Action performed by the request
Enum: CREATED, UPDATED

    • Related Articles

    • DH Patient and Appointment REST XML API

      Access HTTP Basic Authentication basic Endpoints https://[dialoghealth-server]/dh-integration/rest/ Import Patients' data POST /import/protocall/authbase/{CONSOLE-CODE} Content Type application/xml; charset=utf-8 Parameters Request Body - XML ...

    • DH Patient & Visit SOAP API Specifications

      Endpoints http://[dialoghealth-server]/dialoghealth-source-api/soap/DataShare http://[dialoghealth-server]/dh-integration/soap/DataShare Target namespace: https://www.dialoghealth.com/ DataShareSoapBinding getReturnCodeStr POST /GetReturnCodeStr ...

    • DH Trigger SMS API

      Introduction Trigger is a message to one particular person which can be set up for a client and sent on demand as API call. The trigger works only for known patients/employees, who are already registered in Dialog Health database. Triggers can be ...

    • DH Message Results Writeback API

      DH Message Results Writeback API Introduction The Dialog Health Message Results Writeback API allows external systems to retrieve detailed information about outbound and inbound SMS communications sent through Dialog Health. This API is designed to ...

    • DH Send SMS API

      Access HTTP Basic Authentication basic Endpoints https://[dialoghealth-server]/dialoghealth-simplepay-api/ Silent opt-in and message delivery submit POST /submit/{console-code} Parameters Path Parameter Name Description Required Pattern ...