Directory Restful API v3.0

Restful API for retrieving DirectTrust Directory. This page provides the description of the service, the parameters in the URL and how to use it.

Java Sample Code PHP Sample Code Sample Output

Authentication

Authentication is done via HTTP Basic authentication
Authorization: Basic {credentials} where credentials is the base64 encoding of TUser username and password joined by a single colon (:).

Directory Restful API: Get All Records

https://api.directmdemail.com/Directory/rest/getDirectory/FindAll


Directory Restful API: Get Records By HISPs

https://api.directmdemail.com/Directory/rest/getDirectory/ByHisp/{hispOperator}


Directory Restful API: Get Records By Firstname and Lastname

https://api.directmdemail.com/Directory/rest/getDirectory/ByName/{firstName}/{lastName}


Directory Restful API: Get Records By Provider NPI

https://api.directmdemail.com/Directory/rest/getDirectory/ByProviderNPI/{providerNpi}


Directory Restful API: Get Records By Organization NPI

https://api.directmdemail.com/Directory/rest/getDirectory/ByOrganizationNPI/{organizationNpi}


Directory Restful API: Get Records By Organization Name

https://api.directmdemail.com/Directory/rest/getDirectory/ByOrganizationName/{organizationName}


Directory Restful API: Get Records By Zipcode Range

https://api.directmdemail.com/Directory/rest/getDirectory/ByZipcodeRange/{startZipCode}/{endZipCode}


Directory Restful API: Customized Parameters

https://api.directmdemail.com/Directory/rest/getDirectory/CustomizedQuery?hispOperator=ALL&directAddress=ALL&stateList=ALL&startdate=undefined&enddate=undefined&status=ALL


Parameters

Parameter Name Parameter Type Description Example
hispOperator String the filter of hisp operator. If request for MaxMD directory records, for example, you can input MaxMD into this field. If request for ALL hisp operator, please input ALL into this field. https://api.directmdemail.com/Directory/rest/getDirectory/CustomizedQuery?hispOperator=MaxMD & directAddress=ALL & stateList=ALL & startdate=undefined & enddate=undefined & status=ALL
directAddress String the filter of direct address. If request for all @eval.md directory records, for example, you can input @eval.md into this field. If request for ALL direct addresses, please input ALL into this field. https://api.directmdemail.com/Directory/rest/getDirectory/CustomizedQuery?hispOperator=ALL & directAddress=@eval.md & stateList=ALL & startdate=undefined & enddate=undefined & status=ALL
stateList String the filter of states. This field can accept multiple states. You need to use comma(,) between states. If request for all records in NEW JERSEY and NEW YORK, for example, you can input NEW JERSEY,NEW YORK into this field. If request for ALL states, please input ALL into this field. https://api.directmdemail.com/Directory/rest/getDirectory/CustomizedQuery?hispOperator=ALL & directAddress=ALL & stateList=New Jersey,New York & startdate=undefined & enddate=undefined & status=ALL
startdate Date the filter of created date. This field will get the data created on or after the start date. If request for the data created on or after 2015-04-01, you can input 2015-04-01 into this field. If request for ALL data, please input undefined into this field. https://api.directmdemail.com/Directory/rest/getDirectory/CustomizedQuery?hispOperator=ALL & directAddress=ALL & stateList=ALL & startdate=2015-04-01 & enddate=undefined & status=ALL
enddate Date the filter of created date. This field will get the data created on or before the end date. If request for the data created on or before 2015-04-10, you can input 2015-04-10 into this field. If request for ALL data, please input undefined into this field. This field usually works with start date field to get records in a date range. https://api.directmdemail.com/Directory/rest/getDirectory/CustomizedQuery?hispOperator=ALL & directAddress=ALL & stateList=ALL & startdate=2015-04-01 & enddate=2015-04-10 & status=ALL
status String the filter of status. This field can accept three values: ALL, ACTIVE and DELETED. You will get the data with the matched status. https://api.directmdemail.com/Directory/rest/getDirectory/CustomizedQuery?hispOperator=ALL & directAddress=ALL & stateList=ALL & startdate=undefined & enddate=undefined & status=ACTIVE