Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Group

Add new location to group

Adds a new location to a group following the roster ingestion pattern. Creates CoreLocation, GroupLocation, TenantGroupLocation, and optionally CoreEntityAddress and LocationEntityAddress entities.

post/groups/{groupId}/locations

Path parameters

groupIdstring required

Group ID (certifyGroupId)

Headers

tenant-idstring

Request body

tagsstring[]

List of tags for categorization

includePractitionersboolean

If true, enrolls all location practitioners to the networks with their respective specialties

Response

Successfully added location to group

tenantIdstring

ID of the tenant

tenantGroupIdstring

ID of the tenant group

coreLocationIdstring

ID of the created core location

groupLocationIdstring

ID of the created group location

tenantGroupLocationIdstring

ID of the created tenant group location

coreAddressIdsstring[]

List of created core address IDs

locationAddressRelationshipIdsstring[]

List of created location-entity address relationship IDs

groupSpecialtyRelationshipIdsstring[]

List of created group specialty relationship IDs

specialtyRelationshipIdsstring[]

List of created location specialty relationship IDs

tenantGroupNetworkIdsstring[]

List of created tenant group network relationship IDs

tenantGroupLocationNetworkIdsstring[]

List of created tenant group location network relationship IDs

tenantGroupNetworkSpecialtyIdsstring[]

List of created tenant group network specialty relationship IDs

statusstring

Status of the operation

Example response

{
  "tenantId": "tenant-123",
  "tenantGroupId": "tg-456",
  "coreLocationId": "loc-123",
  "groupLocationId": "gl-456",
  "tenantGroupLocationId": "tgl-789",
  "coreAddressIds": [
    "addr-101",
    "addr-102"
  ],
  "locationAddressRelationshipIds": [
    "lea-201",
    "lea-202"
  ],
  "groupSpecialtyRelationshipIds": [
    "group-spec-rel-1",
    "group-spec-rel-2"
  ],
  "specialtyRelationshipIds": [
    "loc-spec-rel-1",
    "loc-spec-rel-2"
  ],
  "tenantGroupNetworkIds": [
    "tgn-301",
    "tgn-302"
  ],
  "tenantGroupLocationNetworkIds": [
    "tgln-401",
    "tgln-402"
  ],
  "tenantGroupNetworkSpecialtyIds": [
    "tgns-501",
    "tgns-502"
  ],
  "status": "created"
}