GET api/enlistedfeature/getvalidforrole/{roleId}

Get All Valid Enlisted Features For Role. Processes this enlisted feature API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
roleId

The unique identifier of the role resource.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

Collection of EnlistedFeatureDataContract
NameDescriptionTypeAdditional information
Name

The name value.

string

None.

Status

The status value.

string

None.

HasInstance

Indicates whether this item has instance.

boolean

None.

Steps

The collection of steps.

Collection of EnlistedFeatureStepDataContract

None.

ExternalProviders

The collection of external providers.

Collection of RoleDataContract

None.

ChosenExternalProvider

The chosen external provider value.

RoleDataContract

None.

Id

The unique identifier of this resource.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Status": "sample string 2",
    "HasInstance": true,
    "Steps": [
      {
        "Name": "sample string 1",
        "Status": "sample string 2",
        "HasInstance": true,
        "CanBeExecuted": true,
        "Id": 5
      },
      {
        "Name": "sample string 1",
        "Status": "sample string 2",
        "HasInstance": true,
        "CanBeExecuted": true,
        "Id": 5
      }
    ],
    "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": "2026-08-04T22:11:45.7313935Z",
        "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": "2026-08-04T22:11:45.7313935Z",
        "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
      }
    ],
    "ChosenExternalProvider": {
      "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": "2026-08-04T22:11:45.7313935Z",
      "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
    },
    "Id": 4
  },
  {
    "Name": "sample string 1",
    "Status": "sample string 2",
    "HasInstance": true,
    "Steps": [
      {
        "Name": "sample string 1",
        "Status": "sample string 2",
        "HasInstance": true,
        "CanBeExecuted": true,
        "Id": 5
      },
      {
        "Name": "sample string 1",
        "Status": "sample string 2",
        "HasInstance": true,
        "CanBeExecuted": true,
        "Id": 5
      }
    ],
    "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": "2026-08-04T22:11:45.7313935Z",
        "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": "2026-08-04T22:11:45.7313935Z",
        "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
      }
    ],
    "ChosenExternalProvider": {
      "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": "2026-08-04T22:11:45.7313935Z",
      "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
    },
    "Id": 4
  }
]