GET api/clients/vacancies/roles?includeTopRoles={includeTopRoles}&clientId={clientId}

Available roles for creating the vacancy

Request Information

URI Parameters

NameDescriptionTypeAdditional information
includeTopRoles

boolean

Default value is False

clientId

string

None.

Body Parameters

None.

Response Information

Resource Description

List of roles

Collection of JobRoleDTO
NameDescriptionTypeAdditional information
Id

string

None.

RoleId

string

None.

Name

string

None.

JobRoles

Collection of JobRoleDTO

None.

ClientRate

decimal number

None.

JobRoleCompliances

Collection of JobRoleComplianceDTO

None.

IsQuickSelect

boolean

None.

ComplianceCategoryId

integer

None.

ClubType

ClubTypeEnum

None.

IsClubRole

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "sample string 1",
    "RoleId": "sample string 2",
    "Name": "sample string 3",
    "JobRoles": [],
    "ClientRate": 5.0,
    "JobRoleCompliances": [
      {
        "JobRoleTypeId": "sample string 1",
        "ComplianceTypeId": 2,
        "Required": true,
        "CompliantPercentage": 4,
        "ApprovedPercentage": 5,
        "Approved": true,
        "ComplianceType": {
          "Id": 1,
          "Name": "sample string 2",
          "Title": "sample string 3"
        }
      },
      {
        "JobRoleTypeId": "sample string 1",
        "ComplianceTypeId": 2,
        "Required": true,
        "CompliantPercentage": 4,
        "ApprovedPercentage": 5,
        "Approved": true,
        "ComplianceType": {
          "Id": 1,
          "Name": "sample string 2",
          "Title": "sample string 3"
        }
      }
    ],
    "IsQuickSelect": true,
    "ComplianceCategoryId": 1,
    "ClubType": 1,
    "IsClubRole": true
  },
  {
    "Id": "sample string 1",
    "RoleId": "sample string 2",
    "Name": "sample string 3",
    "JobRoles": [],
    "ClientRate": 5.0,
    "JobRoleCompliances": [
      {
        "JobRoleTypeId": "sample string 1",
        "ComplianceTypeId": 2,
        "Required": true,
        "CompliantPercentage": 4,
        "ApprovedPercentage": 5,
        "Approved": true,
        "ComplianceType": {
          "Id": 1,
          "Name": "sample string 2",
          "Title": "sample string 3"
        }
      },
      {
        "JobRoleTypeId": "sample string 1",
        "ComplianceTypeId": 2,
        "Required": true,
        "CompliantPercentage": 4,
        "ApprovedPercentage": 5,
        "Approved": true,
        "ComplianceType": {
          "Id": 1,
          "Name": "sample string 2",
          "Title": "sample string 3"
        }
      }
    ],
    "IsQuickSelect": true,
    "ComplianceCategoryId": 1,
    "ClubType": 1,
    "IsClubRole": true
  }
]