The workplaceById query is used to get details on a workplace/HCO.
Schema |
|
type Query { workplaceById( userId: String, id: ID!, locale: String ): Workplace }
|
|
Field |
Type |
Description |
String |
Optional. ID of app carrying out the operation with the Activity API. |
|
id |
ID! |
ID of HCO. |
locale |
String |
Optional. Specifies the language of users in a country/region. For example: locale: "en" (default) If not specified, then the default locale of the space is used. |
|
|
|
Workplace
A JSON response with an object of the Workplace type (Activity API 1.0) or Workplace type (Activity API 2.0) as a result.
ActivityException
If a server error occurs or an incorrect input is specified.
Criteria in this query is from a "details request" made by your app for an HCO, such as an HCO selected (as a result of an activities query) in a list/map on the prebuilt Results screen.
This query is sent to the Activities endpoint of the Activity API.
HealthCare Locator SDK 1.0 (and versions earlier than 1.2.15)
GraphQL Activity API 1.0