Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Group

Add a specialty to a group

Adds a new specialty to an existing group. Optionally can also add the specialty to a specific group location.

post/groups/{id}/specialties

Path parameters

idstring required

Group ID

Headers

tenant-idstring

Request body

tenantSpecialtyIdstring required

ID of the tenant specialty

groupSpecialtyEffectiveDatestring

Effective date for the group specialty (YYYY-MM-DD)

groupSpecialtyIsPrimaryboolean required

Indicates if the specialty is primary

tenantGroupLocationIdstring

ID of the tenant group location (optional)

groupLocationSpecialtyEffectiveDatestring

Effective date for the group location specialty (YYYY-MM-DD)

groupLocationSpecialtyIsPrimaryboolean

Indicates if the location specialty is primary

tenantGroupNetworkIdstring

ID of the tenant group network (optional)

networkSpecialtyEffectiveDatestring

Effective date for the network specialty (YYYY-MM-DD)

networkSpecialtyIsPrimaryboolean

Indicates if the network specialty is primary

Example request

{
  "tenantSpecialtyId": "ts_123456",
  "groupSpecialtyEffectiveDate": "2024-01-01",
  "groupSpecialtyIsPrimary": true,
  "tenantGroupLocationId": "tgl_123456",
  "groupLocationSpecialtyEffectiveDate": "2024-01-01",
  "groupLocationSpecialtyIsPrimary": true,
  "tenantGroupNetworkId": "tgn_123456",
  "networkSpecialtyEffectiveDate": "2024-01-01",
  "networkSpecialtyIsPrimary": true
}

Response

Group specialty successfully created

emptyboolean
valueNodeboolean
containerNodeboolean
missingNodeboolean
arrayboolean
objectboolean
nodeType'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
pojoboolean
numberboolean
integralNumberboolean
floatingPointNumberboolean
shortboolean
intboolean
longboolean
floatboolean
doubleboolean
bigDecimalboolean
bigIntegerboolean
textualboolean
booleanboolean
nullboolean
binaryboolean