workplaceByID

The workplaceByID query is used to get details on a workplace/HCO.

Schema

 

 

type Query {

    workpaceByID(

        id: ID!,

        locale: String,

    ): Workplace

}

 

 

Field

Type

Description

id

ID!

ID of HCO.

locale

String

Optional. Specifies the language in which translatable fields are translated.

If not specified, then the default locale "en" is used.

 

 

 

Response

Workplace

A JSON response with an object of the Workplace type as a result.

Fault

ActivityException

If a server error occurs or an incorrect input is specified.

Discussion

Criteria in this query is from a "details/profile request" made by your app for an HCO, such as an HCO selected (such as a result of a workplaces query) in a list/map on the prebuilt Results screen.

This query is sent to the Activities endpoint of the Activity API.

Availability

HealthCare Locator SDK 1.0 and higher

GraphQL Activity API 1.0 and Activity API 2.0