POST api/clients/supply/candidates?clientId={clientId}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId		string	None.

Body Parameters

ClientSupplyCandidatesRequest

Name	Description	Type	Additional information
SupplyType		SupplyType	None.
Filter		SupplyRequestFilter	None.

Request Formats

application/json, text/json

Sample:

{
  "SupplyType": 1,
  "Filter": {
    "RoleGroup": 1,
    "IncludeRecommended": true,
    "AvailabilityFrom": "2025-06-17T18:12:43.2133912Z",
    "AvailabilityTo": "2025-06-17T18:12:43.2133912Z",
    "SelectedTags": [
      "sample string 1",
      "sample string 2"
    ],
    "OrderBy": 1,
    "Page": 4,
    "PageLength": 5
  }
}

Response Information

Resource Description

ClientSupplyCandidatesResponse

Name	Type	Additional information
ClientHasFavourites	boolean	None.
RoleGroupSets	Collection of RoleGroupResult	None.
Candidates	Collection of SupplyCandidate	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Error getting value from 'RoleGroups' on 'DNA.Managers.Clients.Responses.SupplyCandidate'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Error getting value from 'RoleGroups' on 'DNA.Managers.Clients.Responses.SupplyCandidate'.