POST api/groupsetup?createPlan={createPlan}
Adds a new group, facility, and plan with the minimum requirements
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| createPlan |
Bool value indicating if a Plan should be created |
boolean |
Default value is True |
Body Parameters
The json formatted group setup model object supplied in the request body that is to be added
GroupSetupModel| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupName |
Gets or sets the name of the location representing the new group |
string |
Required |
| GroupNPI |
Gets or sets the NPI of the group |
string |
Required |
| ExistingGroupLogonName |
Gets or sets the exisitng Logon name for the new group, this exising logon will become the admin for the new group |
string |
Required |
| FacilityName |
Gets or sets the name of the location representing the new facility |
string |
Required |
| FacilityNPI |
Gets or sets the npi of the facility |
string |
Required |
| FacilityAdminFirstName |
Gets or sets the first name of the new facility admin |
string |
Required |
| FacilityAdminLastName |
Gets or sets the last name of the new facility admin |
string |
Required |
| FacilityLogonName |
Gets or sets the logon name for the new facility |
string |
Required |
| FacilityLogonPassword |
Gets or sets the logon password for the new facility |
string |
Required |
| GroupPlanName |
Gets or sets the plan name for the new group plan |
string |
None. |
| GroupPlanBin |
Gets or sets the bin for the new group plan |
string |
None. |
| GroupPlanPcn |
Gets or sets the pcn for the new group plan |
string |
None. |
| GroupPlanEffectiveStart |
Gets or sets the effective start date for the new group plan |
date |
None. |
| GroupPlanEffectiveEnd |
Gets or sets the effective end date for the new group plan |
date |
None. |
| DefaultEnforceQtyLimit | boolean |
None. |
|
| DefaultEnforceDaysSupplyLimit | boolean |
None. |
|
| DefaultEnforceRefillTooSoon | boolean |
None. |
|
| DefaultEnforceMaxFillsLimit | boolean |
None. |
|
| DefaultEnforceMaxPriceLimit | boolean |
None. |
|
| DefaultEnforceStepTherapy | boolean |
None. |
|
| DefaultEnforceAgeRestriction | boolean |
None. |
|
| DefaultEnforcePlanFormulary | boolean |
None. |
|
| DefaultEnforcePharmacyFormulary | boolean |
None. |
|
| DefaultEnforceMemberFormulary | boolean |
None. |
|
| DefaultEnforcePrescriberFormulary | boolean |
None. |
|
| DefaultEnforceDAW | boolean |
None. |
|
| DefaultEnforceFinalFormulary | boolean |
None. |
|
| DefaultEnforcePostPricing | boolean |
None. |
|
| DefaultEnforceRestrictedOverride | boolean |
None. |
|
| DefaultEnforceFormularyNotCovered | boolean |
None. |
|
| DefaultEnforceFormularyAgeLimit | boolean |
None. |
|
| DefaultEnforceFormularyGenderLimit | boolean |
None. |
|
| DefaultEnforceFormularyQtyLimit | boolean |
None. |
|
| DefaultEnforceFormularyStepMed | boolean |
None. |
|
| DefaultEnforceFormularyPriorAuth | boolean |
None. |
|
| DefaultEnforceFormularyDiagnosisCodeLimit | boolean |
None. |
|
| GroupID |
Gets the ID of the newly created group |
integer |
None. |
Request Formats
application/json, text/json, application/json-patch+json
{
"groupName": "sample string 1",
"groupNPI": "sample string 2",
"existingGroupLogonName": "sample string 3",
"facilityName": "sample string 4",
"facilityNPI": "sample string 5",
"facilityAdminFirstName": "sample string 6",
"facilityAdminLastName": "sample string 7",
"facilityLogonName": "sample string 8",
"facilityLogonPassword": "sample string 9",
"groupPlanName": "sample string 10",
"groupPlanBin": "sample string 11",
"groupPlanPcn": "sample string 12",
"groupPlanEffectiveStart": "2025-05-30T20:39:18.6364701-05:00",
"groupPlanEffectiveEnd": "2025-05-30T20:39:18.6364701-05:00",
"defaultEnforceQtyLimit": true,
"defaultEnforceDaysSupplyLimit": true,
"defaultEnforceRefillTooSoon": true,
"defaultEnforceMaxFillsLimit": true,
"defaultEnforceMaxPriceLimit": true,
"defaultEnforceStepTherapy": true,
"defaultEnforceAgeRestriction": true,
"defaultEnforcePlanFormulary": true,
"defaultEnforcePharmacyFormulary": true,
"defaultEnforceMemberFormulary": true,
"defaultEnforcePrescriberFormulary": true,
"defaultEnforceDAW": true,
"defaultEnforceFinalFormulary": true,
"defaultEnforcePostPricing": true,
"defaultEnforceRestrictedOverride": true,
"defaultEnforceFormularyNotCovered": true,
"defaultEnforceFormularyAgeLimit": true,
"defaultEnforceFormularyGenderLimit": true,
"defaultEnforceFormularyQtyLimit": true,
"defaultEnforceFormularyStepMed": true,
"defaultEnforceFormularyPriorAuth": true,
"defaultEnforceFormularyDiagnosisCodeLimit": true,
"groupID": 13
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
GroupSetupModel| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupName |
Gets or sets the name of the location representing the new group |
string |
Required |
| GroupNPI |
Gets or sets the NPI of the group |
string |
Required |
| ExistingGroupLogonName |
Gets or sets the exisitng Logon name for the new group, this exising logon will become the admin for the new group |
string |
Required |
| FacilityName |
Gets or sets the name of the location representing the new facility |
string |
Required |
| FacilityNPI |
Gets or sets the npi of the facility |
string |
Required |
| FacilityAdminFirstName |
Gets or sets the first name of the new facility admin |
string |
Required |
| FacilityAdminLastName |
Gets or sets the last name of the new facility admin |
string |
Required |
| FacilityLogonName |
Gets or sets the logon name for the new facility |
string |
Required |
| FacilityLogonPassword |
Gets or sets the logon password for the new facility |
string |
Required |
| GroupPlanName |
Gets or sets the plan name for the new group plan |
string |
None. |
| GroupPlanBin |
Gets or sets the bin for the new group plan |
string |
None. |
| GroupPlanPcn |
Gets or sets the pcn for the new group plan |
string |
None. |
| GroupPlanEffectiveStart |
Gets or sets the effective start date for the new group plan |
date |
None. |
| GroupPlanEffectiveEnd |
Gets or sets the effective end date for the new group plan |
date |
None. |
| DefaultEnforceQtyLimit | boolean |
None. |
|
| DefaultEnforceDaysSupplyLimit | boolean |
None. |
|
| DefaultEnforceRefillTooSoon | boolean |
None. |
|
| DefaultEnforceMaxFillsLimit | boolean |
None. |
|
| DefaultEnforceMaxPriceLimit | boolean |
None. |
|
| DefaultEnforceStepTherapy | boolean |
None. |
|
| DefaultEnforceAgeRestriction | boolean |
None. |
|
| DefaultEnforcePlanFormulary | boolean |
None. |
|
| DefaultEnforcePharmacyFormulary | boolean |
None. |
|
| DefaultEnforceMemberFormulary | boolean |
None. |
|
| DefaultEnforcePrescriberFormulary | boolean |
None. |
|
| DefaultEnforceDAW | boolean |
None. |
|
| DefaultEnforceFinalFormulary | boolean |
None. |
|
| DefaultEnforcePostPricing | boolean |
None. |
|
| DefaultEnforceRestrictedOverride | boolean |
None. |
|
| DefaultEnforceFormularyNotCovered | boolean |
None. |
|
| DefaultEnforceFormularyAgeLimit | boolean |
None. |
|
| DefaultEnforceFormularyGenderLimit | boolean |
None. |
|
| DefaultEnforceFormularyQtyLimit | boolean |
None. |
|
| DefaultEnforceFormularyStepMed | boolean |
None. |
|
| DefaultEnforceFormularyPriorAuth | boolean |
None. |
|
| DefaultEnforceFormularyDiagnosisCodeLimit | boolean |
None. |
|
| GroupID |
Gets the ID of the newly created group |
integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{
"groupName": "sample string 1",
"groupNPI": "sample string 2",
"existingGroupLogonName": "sample string 3",
"facilityName": "sample string 4",
"facilityNPI": "sample string 5",
"facilityAdminFirstName": "sample string 6",
"facilityAdminLastName": "sample string 7",
"facilityLogonName": "sample string 8",
"facilityLogonPassword": "sample string 9",
"groupPlanName": "sample string 10",
"groupPlanBin": "sample string 11",
"groupPlanPcn": "sample string 12",
"groupPlanEffectiveStart": "2025-05-30T20:39:18.6364701-05:00",
"groupPlanEffectiveEnd": "2025-05-30T20:39:18.6364701-05:00",
"defaultEnforceQtyLimit": true,
"defaultEnforceDaysSupplyLimit": true,
"defaultEnforceRefillTooSoon": true,
"defaultEnforceMaxFillsLimit": true,
"defaultEnforceMaxPriceLimit": true,
"defaultEnforceStepTherapy": true,
"defaultEnforceAgeRestriction": true,
"defaultEnforcePlanFormulary": true,
"defaultEnforcePharmacyFormulary": true,
"defaultEnforceMemberFormulary": true,
"defaultEnforcePrescriberFormulary": true,
"defaultEnforceDAW": true,
"defaultEnforceFinalFormulary": true,
"defaultEnforcePostPricing": true,
"defaultEnforceRestrictedOverride": true,
"defaultEnforceFormularyNotCovered": true,
"defaultEnforceFormularyAgeLimit": true,
"defaultEnforceFormularyGenderLimit": true,
"defaultEnforceFormularyQtyLimit": true,
"defaultEnforceFormularyStepMed": true,
"defaultEnforceFormularyPriorAuth": true,
"defaultEnforceFormularyDiagnosisCodeLimit": true,
"groupID": 13
}