The activities query is used to get records collected on HCP activities matching input filters.
Schema |
|
type Query { activities( first: Int = 10, offset: Int = 10, locale: String, professionalType: String, specialties: [String!], location: GeopointQuery, county: String, criteria: String, country: String ): [ActivityResult] }
|
Field |
Type |
Description |
first |
Int |
Optional for pagination. Specifies ... 10 (default) ... to limit the number of results to get for the first page. The same number to limit results can be specified again to limit results for each of the following pages. |
offset |
Int |
Optional for pagination. Specifies ... 0 (default) ... to not offset the first number of results for the first page. However, offset is required for a following page to skip <total number results already retrieved on previous pages> to the next number to get from remaining results. For example: ● "offset: Int = 0" and "first: Int = 10" gets first 10 results for page 1 ● "offset: Int = 10" and "first: Int = 10" skips first 10 results to get next 10 results for page 2 ● "offset: Int = 20" and "first: Int = 10" skips first 20 results to get next 10 results for page 3 |
locale |
String |
Optional. Specifies the language in which translatable fields are translated. If not specified, then the default locale "en" is used. |
professionalType |
String |
Optional. Specifies a type of HCP as criteria to limit search to records collected on activities of that type. |
specialties |
[String!] |
Specifies one or more specialities as criteria to limit search to records collected on activities with those HCP specialties. The expected values are specialty or international specialty codes. Review the specialties that come with your subscription. |
location |
Optional. Specifies a geolocation as criteria to limit search to records collected on activities around that location. |
|
county |
String |
Optional. Specifies a county as criteria to limit search to records collected on activities within that county. |
criteria |
String |
Optional. Specifies free text as criteria to limit search to records collected on activities matching that text. For example: criteria:
"John doe" |
country |
String |
Optional. Specifies a country as criteria to limit search to records collected on activities within that country. |
|
|
|
ActivityResult
A JSON response with a list of one or more objects of the ActivityResult type as results.
ActivityException
If a server error occurs or an incorrect input is specified.
Input validation is done by GraphQL.
Criteria in this query is from a "search request" made by your app for a search on HCP activities, such as a search inputted (with the help of autocomplete suggestions) on the prebuilt Search block. To get data without implementing a UI, HealthCare Locator SDK provides the following calls:
● getActivities (SDK for Android)
● fetchActivitiesWith (SDK for iOS)
● hclAPI.activities (SDK for JavaScript)
Results are narrowed down to a country, specialties (local or international), and/or professional type when specified. If the requesting app's subscription API key is associated with additional countries, specialties, and/or professional types, then results can be maximized by not limiting/specifying the country, specialties, and/or professional type.
This query is sent to the Autocomplete endpoint of the Activity API.
HealthCare Locator SDK 1.0 (and versions earlier than 1.2.15)
GraphQL Activity API 1.0