Troubleshooting integration efforts with the HealthBus REST API

Phillip Odam

Modified on: Thu, 4 Oct, 2018 at 5:01 PM

Options for examining and troubleshooting integration efforts with the API

Command line tools (cURL)
- we recommend this approach over all others as it makes it clear what is going on and in the case something does not immediately work, it is more obvious what needs to be done to over come the issue.
If you are able to interact with the service using cURL but your code is failing
- and you are using the Java version of the unirest library, as it is depends on Apache's HTTP Client, you can enable logging in Apache HTTP Client and determine the issue without further assistance.
We offer several other services for easing your integration effort, feel free to lodge a support ticket to request assistance
- as we need to manage access to the troubleshooting services we don't detail them here.

cURL is typically available in *NIX (UNIX, GNU Linux, BSD etc) and OSX by default, if not then install using the appropriate package manager. For Microsoft Windows you will need a port, we suggest http://www.confusedbycode.com/curl/.

For details on how to use cURL please refer to their documentation.

Please note double quotes have been used in the following examples for compatibility with Microsoft operating systems, if you are using cURL on *NIX you may want to use hard / single quotes to avoid the shell evaluating the string literals.

# Retrieve a HealthBus message
#
# Change to appropriate values
# - healthbus username
# - healthbus password
# - message-id
# - from-address

curl -G -s -u "healthbus username:healthbus password" -H "accept: application/json" -d "messageID=message-id" -d "from=from-address" https://direct.sandbox.rosettahealth.net/MailManagement/ws/v3/retrieve/message

# Retrieve a raw HealthBus message
#
# Change to appropriate values
# - healthbus username
# - healthbus password
# - message-id
# - from-address

curl -G -s -u "healthbus username:healthbus password" -d "messageID=message-id" -d "from=from-address" https://direct.sandbox.rosettahealth.net/MailManagement/ws/v3/retrieve/message/raw

# Retrieve an attachment
#
# Change to appropriate values
# - healthbus username
# - healthbus password
# - message-id
# - from-address
# - attachment-id

curl -G -s -u "healthbus username:healthbus password" -d "messageID=message-id" -d "from=from-address" -d "attachmentID=attachment-id" https://direct.sandbox.rosettahealth.net/MailManagement/ws/v3/retrieve/message/attachment

# Retrieve a HealthBus message listing
#
# Change to appropriate values
# - healthbus username
# - healthbus password

curl -G -s -u "healthbus username:healthbus password" -H "accept: application/json" -d "offset=0" -d "length=10" https://direct.sandbox.rosettahealth.net/MailManagement/ws/v3/retrieve/message/list

# Send a HealthBus message
#
# Change to appropriate values
# - healthbus username
# - healthbus password
# - to-address
# - subject-text
# - body-text

curl -s -u "healthbus username:healthbus password" -H "accept: application/json" -d "to=to-address" -d "subject=subject-text" -d "body=body-text" -X PUT https://direct.sandbox.rosettahealth.net/MailManagement/ws/v3/send/message

# Upload an attachment
#
# Change to appropriate values
# - healthbus username
# - healthbus password
# - path-to-file

curl -s -u "healthbus username:healthbus password" -H "accept: application/json" -F "attachment=@path-to-file" -X PUT https://direct.sandbox.rosettahealth.net/MailManagement/ws/v3/send/message/attachment

# Remove a HealthBus message
#
# Change to appropriate values
# - healthbus username
# - healthbus password
# - message-id
# - from

curl -s -u "healthbus username:healthbus password" -d "messageID=message-id" -d "from=from-address" -X DELETE -G https://direct.sandbox.rosettahealth.net/MailManagement/ws/v3/remove/message

# Create a HealthBus address
#
# Change to appropriate values
# - admin username
# - admin password
# - direct-address
# - direct-password

curl -s -u "admin username:admin password" -H "accept: application/json" -d "new_password=direct-password" -X PUT https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/mail/direct-address

# Update a HealthBus address
#
# Change to appropriate values
# - admin username
# - admin password
# - direct-address
# - direct-password

curl -s -u "admin username:admin password" -H "accept: application/json" -d "new_password=direct-password" -X POST https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/mail/direct-address

# Check existence of a HealthBus address
#
# Change to appropriate values
# - admin username
# - admin password
# - healthbus-address

curl -s -u "admin username:admin password" -H "accept: application/json" https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/mail/healthbus-address

# Remove a HealthBus address
#
# Change to appropriate values
# - admin username
# - admin password
# - healthbus-address

curl -s -u "admin username:admin password" -H "accept: application/json" -X DELETE https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/mail/healthbus-address

# Alter notifications for individual HealthBus address
#
# Change to appropriate values
# - admin username
# - admin password
# - email-address
# - healthbus-address

curl -s -u "admin username:admin password" -H "accept: application/json" -d "add_email_notification=email-address" -X POST https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/notify/individual/healthbus-address

# Check on notifications for individual HealthBus address
#
# Change to appropriate values
# - admin username
# - admin password
# - healthbus-address

curl -s -u "admin username:admin password" -H "accept: application/json" https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/notify/individual/healthbus-address

# Create an admin account
#
# Change to appropriate values
# - admin username
# - admin password
# - admin-name
# - admin-password

curl -s -u "admin username:admin password" -H "accept: application/json" -d "password=admin-password" -X PUT https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/domain/admin/admin-name/FACILITY

# Update an admin account
#
# Change to appropriate values
# - admin username
# - admin password
# - admin-name
# - admin-password

curl -s -u "admin username:admin password" -H "accept: application/json" -d "password=admin-password" -X POST https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/domain/admin/admin-name/FACILITY

# Check an admin account
#
# Change to appropriate values
# - admin username
# - admin password
# - admin-name

curl -s -u "admin username:admin password" -H "accept: application/json" https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/domain/admin/admin-name/FACILITY

# Remove an admin account
#
# Change to appropriate values
# - admin username
# - admin password
# - admin-name

curl -s -u "admin username:admin password" -H "accept: application/json" -X DELETE https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/domain/admin/admin-name/FACILITY

# Get account listing as Domain Admin
#
# Change to appropriate values
# - domain admin username
# - domain admin password

curl -s -u "domain admin username:domain admin password" -H "accept: application/json" https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/domain/list/admin

# Get account listing as Facility Admin
#
# Change to appropriate values
# - facility admin username
# - facility admin password

curl -s -u "facility admin username:facility admin password" -H "accept: application/json" https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/list/mail

# Poll for new message notifications across an entire domain
#
# Change to appropriate values
# - admin username
# - admin password
# - domain-name

curl -G -s -u "admin username:admin password" -H "accept: application/json" -d "domain=domain-name" https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/notify/organization

# Poll for new message notifications for a particular address
#
# Change to appropriate values
# - admin username
# - admin password
# - healthbus-address

curl -G -s -u "admin username:admin password" -H "accept: application/json" -d "email=healthbus-address" https://direct.sandbox.rosettahealth.net/AccountManagement/ws/v2/notify/organization

Related Articles