ResellerService

SOAP Sevice for provision, add, update or remove direct accounts for reseller. This page includes description abount service actions and data types.

WSDL XSD

Functions

Function Name Return Type Parameters Description
SubmitDirectForm ResellerAPIResponse String  username
String  password
DirectForm  DirectForm 		Create organization with initial users.
AddUsersToVerifiedOrganization AddUsersResponse String  username
String  password
String  organizationFqdn
DirectUser[]  users 		Add users to a verified and provisioned organization. New users will be auto-provisioned.
SetUsersPasswords ResellerAPIResponse String  username
String  password
String  organizationFqdn
UserPassword[]  userpasswrods 		Set passwords for users in a verified and provisioned organization
GetOrganizations GetOrganizationsResponse String  username
String  password
Get all organizations. use this function to check organizations' status.
GetOrganizationAndUsers GetOrganizationsResponse String  username
String  password
String  organizationFqdn 		Get organization and all users in the organization. Use this function to check organization and users' status
GetSharingRelation ShareResponse String  username
String  password
String  organizationFqdn 		Get Mailbox Sharing information
SetSharingRelation ShareResponse String  username
String  password
String  organizationFqdn
ShareMailboxRelation[]  sharingRelations 		Create Mailbox sharing relations. Each user can share multiple group account. Each group can be shared by multiple users. Group can not share another group. New relations will be return.
DeleteSharingRelation ShareResponse String  username
String  password
String  organizationFqdn
ShareMailboxRelation[]  relationsToBeDeleted 		Delete Mailbox sharing relations. New relations will be return.
GetMonthlyDirectMessageReport GetMessageStatusReportResponse String  username
String  password
String  organizationFqdn
Date  date Any date in the report month. For example, date == 2015-02-15, the Feb 2015 Month report will be generated
boolean   getReportAsCsv Get report as a list of DirectMessageLog object or csv formated data 		Get Monthly Message Status report.
GetWeeklyDirectMessageReport GetMessageStatusReportResponse String  username
String  password
String  organizationFqdn
Date  date Any date in the report week. For example, date == 2015-02-15, the 2015-02-09 to 2015-02-15 Week report will be generated
boolean   getReportAsCsv Get report as a list of DirectMessageLog object or csv formated data 		Get Weekly Message Status report. A week is from Monday to Sunday (ISO-8601).

Data types

ResellerAPIResponse

Parameter Description
String code Response code:
000 - success
002 - invalid user when provisioning new Direct mdEmail account
003 - registrar offer error
010 - invalid api argument or argument missing
011 - authentication failed
012 - organization missing
013 - organization permission denied
014 - direct user account error
021 - debit account authorize failed
022 - debit account capture failed
099 - other error
Required
Boolean success Required
String errorMessage Error message
Top

AddUsersResponse ( extends ResellerAPIResponse )

Parameter Description
DirectUserDetail[] users The details of the new added users
Top

DirectUserDetail ( extends DirectUser )

Parameter Description
UserStateType UserStateType User's state:
init - Initial created
provisioned - user provisioned
activated - User activated (password setup completed) 		Required
Top

UserPassword

Parameter Description
String username Username Required
String password Password Required
Top

DirectForm

Parameter Description
AdminUseradministrator Organization administrator Required
OrganizationOrganization Organization information Required
DirectUser[] DirectUser An array of direct user objects Required
String provisionNotificationEmail The Organization provisioned notification email receiver Required
boolean autoSendActivationEmail User activation options flag:
true - MaxMD send activation email to each direct user's regular email address in order to set password and activate the account
false - Reseller call API SetUsersPasswords function to set password and activate the account 		Required
Top

Organization

Parameter Description
String name Organization name Required
String department Department
String fqdn Direct domain for organization (Ex: direct.myorg.com) Required
String taxId Federal Tax ID (Format: 99-9999999) Required
String npi Organization NPI number Required
String address Organization street address Required
String city Organization City Required
String state Organization state (full state name) Required
String country Organization Country code(Ex: US) Required
String zipcode Organization zipcode Required
Top

BaseUser

Parameter Description
String firstName First name Required
String lastName Last name Required
String email Regular email address Required
String dea DEA Number
String npi NPI Number
Boolean sameAsOrganizationAddress Use Organization address as user's address
String address Street of user
String city City
String state Full state name
String country Two letters Country code (Ex: US)
String zipcode zipcode information
Top

AdminUser ( extends BaseUser )

Parameter Description
Top

DirectUser ( extends BaseUser )

Parameter Description
String username Direct username.
For example, organization domain(FQDN) is direct.myorg.com, username is user1, direct address will be: user1@direct.myorg.com 		Required
DirectUserType userType Direct user type:
XD - XDR endpoint user
SMTP - MaxMD Hosted SMTP user
FTP - FTP endpoint user
FTPS - FTP endpoint user over FTPS connection
SFTP - FTP endpoint user over SFTP connection 		Required
String endpoint Endpoint URL for XD, FTP* users
String endpointDirectory Endpoint directory of FTP* users
String endpointUsername Endpoint username of FTP* users
String endpointPassword Endpoint password of FTP* users
Top

GetOrganizationsResponse ( extends ResellerAPIResponse )

Parameter Description
OrganizationDetail[] organizations Organizations' details Required
Top

OrganizationDetail ( extends Organization )

Parameter Description
AdminUseradministrator Administrator of the organization Required
OrganizationStateType organizationState Organization state:
init - Initial state
verified - organization verified by MaxMD administrator
signed - organization provisioned. Certificate signed. 		Required
DirectUserDetail[] users All users in the organization Required
Top

ShareResponse ( extends ResellerAPIResponse )

Parameter Description
ShareMailboxRelation[] shareRelations All Mailbox sharing relations
Top

ShareMailboxRelation

Parameter Description
String groupUsername username of group account
String username username of the user who need to share a group
Top

GetMessageStatusReportResponse ( extends ResellerAPIResponse )

Parameter Description
boolean hasCvData true: csvData is responsed, messageLogs is empty
false: messageLogs is responsed, csvData is empty
byte[] csvData csv formatted message status report data with below columns:
  1. From Sender direct address
  2. To Recipient direct address
  3. Message ID SMTP Message ID of the message
  4. Message Size Size of the message
  5. Status Status of the message
    • Delivered* Delivered to receiver
    • Waiting* Waiting confirmation from receiver HISP
    • Locally Failed* Rejected or failed when sending it out.
    • Remotely Failed* Rejected or failed by receiver HISP
    • NO MDN Received* Timed out. No confirmation received from receiver HISP within one hour
  6. Sent Time Sent time of the message
  7. XDR Message ID XDR Message ID
  8. XDR Source ID XDR Source ID
  9. XDR Unique ID XDR Unique ID
  10. XDR Patient ID XDR Patient ID

This variable is empty if hasCvData==false or no message was found in the certain date range.
DirectMessageLog[] messageLogs And list of message log object. This variable is empty if hasCvData==true or no message was found in the certain date range.
Top

DirectMessageLog

Parameter Description
String from Sender direct address of the message
String to Recipient direct address of the message
String messageId SMTP Message ID of the message
long messageSize size of the message
String status Status of the message:
  • Delivered Delivered to receiver
  • Waiting Waiting confirmation from receiver HISP
  • Locally Failed Rejected or failed when sending it out.
  • Remotely Failed Rejected or failed by receiver HISP
  • NO MDN Received Timed out. No confirmation received from receiver HISP within one hour
Date ts Sent time
String xdrId XDR Message ID
String uniqueId XDR Unique ID
String sourceId XDR Source ID
String patientId XDR Patient ID
Top