POST api/featureprovisioning/enrollagency?featureSystemName={featureSystemName}
Enrolls an agency into a feature
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| featureSystemName |
The SystemName of the feature |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
EnlistedFeatureConfigurationDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| FeatureId | integer |
None. |
|
| AppliesToRoles | Collection of EnumDataContract |
None. |
|
| ExternalProviders | Collection of RoleDataContract |
None. |
|
| Steps | Collection of EnlistedFeatureConfigurationStepDataContract |
None. |
|
| SystemStatus | EnumDataContract |
None. |
|
| Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"FeatureId": 2,
"AppliesToRoles": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"ExternalProviders": [
{
"OwningTeamId": 1,
"BranchId": 2,
"Name": "sample string 3",
"TeamAccessType": "sample string 4",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CustomFields": [
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
},
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
}
],
"CreatedDate": "2021-08-04T13:01:02.2954674Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 6
},
{
"OwningTeamId": 1,
"BranchId": 2,
"Name": "sample string 3",
"TeamAccessType": "sample string 4",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CustomFields": [
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
},
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
}
],
"CreatedDate": "2021-08-04T13:01:02.2954674Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 6
}
],
"Steps": [
{
"Name": "sample string 1",
"ValidRoleStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"RequiredSteps": [
{
"FeatureStepConfiguration": {
"Name": "sample string 1",
"Id": 2
},
"ValidStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"Id": 1
},
{
"FeatureStepConfiguration": {
"Name": "sample string 1",
"Id": 2
},
"ValidStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"Id": 1
}
],
"IsFinalStep": true,
"Id": 3
},
{
"Name": "sample string 1",
"ValidRoleStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"RequiredSteps": [
{
"FeatureStepConfiguration": {
"Name": "sample string 1",
"Id": 2
},
"ValidStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"Id": 1
},
{
"FeatureStepConfiguration": {
"Name": "sample string 1",
"Id": 2
},
"ValidStatuses": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"Id": 1
}
],
"IsFinalStep": true,
"Id": 3
}
],
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
}