The activityByID query is used to get details on an HCP activity.
Schema |
|
type Query { activityByID( id: ID!, locale: String, ): Activity }
|
|
Field |
Type |
Description |
id |
ID! |
ID of activity. |
locale |
String |
Optional. Specifies the language in which translatable fields are translated. If not specified, then the default locale "en" is used. |
|
|
|
Activity
A JSON response with an object of the Activity type (Activity API 1.0) or Activity type (Activity API 2.0) as a result.
ActivityException
If a server error occurs or an incorrect input is specified.
404 error is thrown if GraphQL app does not have valid subscription API key.
Criteria in this query is from a "details request" made by your app for an HCP activity with an HCO, such as an activity selected (as a result of an activities query) in a list/map on the prebuilt Results screen. To get data without implementing a UI, HealthCare Locator SDK provides the following calls:
● getDetailActivity (SDK for Android)
● fetchActivityWith (SDK for iOS)
● hclAPI.activityByID (SDK for JavaScript)
This query is sent to the Activities endpoint of the Activity API.
HealthCare Locator SDK 1.0 and higher
GraphQL Activity API 1.0 and Activity API 2.0