GET api/candidate/summary?from={from}&days={days}

Request Information

URI Parameters

Name	Description	Type	Additional information
from		date	None.
days		integer	Default value is 120
Body Parameters

None.
Response Information

Resource Description

CandidateSummaryDTO
Name	Type	Additional information
Id	string	None.
FirstName	string	None.
LastName	string	None.
OtherNames	string	None.
GoesBy	string	None.
AssignedConsultant	ConsultantDTO	None.
Permissions	Collection of integer	None.
ProfileImageUrl	string	None.
PhoneNumber	string	None.
Email	string	None.
EmailConfirmed	boolean	None.
CandidateCards	Collection of CandidateCardDTO	None.
Position	DNAJobType	None.
LongTermAvailableFrom	date	None.
Location	LocationDTO	None.
DailySupplyAvailability	Collection of CandidateAvailabilityValueDTO	None.
UserDevices	Collection of UserDeviceDTO	None.
IsApproved	boolean	None.
IsActive	boolean	None.
AmbassadorSummary	AmbassadorSummaryDTO	None.
Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "OtherNames": "sample string 4",
  "GoesBy": "sample string 5",
  "AssignedConsultant": {
    "Id": "sample string 1",
    "AspNetUserId": "sample string 3",
    "Email": "sample string 4",
    "Forename": "sample string 5",
    "Surname": "sample string 6",
    "JobTitle": "sample string 7",
    "Mobile": "sample string 8",
    "OtherNames": "sample string 9",
    "ProfileImageUrl": "sample string 12",
    "ConsultantName": "sample string 18",
    "PhoneNumber": "sample string 19",
    "FullName": "sample string 5 sample string 6"
  },
  "Permissions": [
    1,
    2
  ],
  "ProfileImageUrl": "sample string 6",
  "PhoneNumber": "sample string 7",
  "Email": "sample string 8",
  "EmailConfirmed": true,
  "CandidateCards": [
    {
      "Id": 1,
      "ComplianceStatus": "sample string 2",
      "ProfileComplianceStatus": null,
      "CandidateId": "sample string 3",
      "RoleId": "sample string 4",
      "Type": 5,
      "CandidateCardTags": [
        {
          "Id": "sample string 1",
          "MemberId": "sample string 2",
          "Name": "sample string 3",
          "TagCategoryId": "sample string 4",
          "TagCategoryName": "sample string 5"
        },
        {
          "Id": "sample string 1",
          "MemberId": "sample string 2",
          "Name": "sample string 3",
          "TagCategoryId": "sample string 4",
          "TagCategoryName": "sample string 5"
        }
      ],
      "ClubType": 1,
      "DailySupplyJobs": true,
      "LongTermJobs": true,
      "PermanentJobs": true,
      "RoleName": "sample string 3",
      "Rate": 12.0,
      "DailySupplyDayRate": 1.0,
      "DailySupplyHalfDayRate": 1.0,
      "LongTermDailyRate": 1.0,
      "HourlyRate": 1.0,
      "DailySupplyOvertimeHourlyRate": 1.0,
      "CompliantPercentage": 14.1,
      "ApprovedPercentage": 15.1,
      "ApprovedOn": "2025-05-06T13:14:28.512495Z",
      "Summary": "sample string 16",
      "CandidateAssetId": 1,
      "JourneyTime": 1,
      "DrivingOpt": true,
      "PublicTransportOpt": true,
      "PublicTransportBus": true,
      "PublicTransportTrain": true,
      "PublicTransportUnderground": true,
      "Cycling": true,
      "Walking": true,
      "CVName": "sample string 23",
      "RegisteredBy": "sample string 24",
      "ApprovedBy": "sample string 25",
      "FountainStage": {
        "CandidateId": "sample string 1",
        "OpeningId": "sample string 2",
        "StageId": "sample string 3",
        "ApplicationId": "sample string 4",
        "Title": "sample string 5",
        "JobRoleId": "sample string 6",
        "LocationId": "sample string 7"
      },
      "CandidateCardStatusHistories": [
        {
          "Id": 1,
          "CandidateId": "sample string 2",
          "CandidateCardId": 3,
          "ComplianceStatusRank": {
            "ComplianceStatusRankId": 1,
            "ComplianceStatusName": "sample string 2",
            "ComplianceStatusRank": 3
          },
          "Transition": {
            "TransitionedOn": "2025-05-06T13:14:28.512495Z",
            "TransitionedById": "sample string 2",
            "TransitionedByFirstName": "sample string 3",
            "TransitionedByLastName": "sample string 4",
            "SelfTransitioned": true
          }
        },
        {
          "Id": 1,
          "CandidateId": "sample string 2",
          "CandidateCardId": 3,
          "ComplianceStatusRank": {
            "ComplianceStatusRankId": 1,
            "ComplianceStatusName": "sample string 2",
            "ComplianceStatusRank": 3
          },
          "Transition": {
            "TransitionedOn": "2025-05-06T13:14:28.512495Z",
            "TransitionedById": "sample string 2",
            "TransitionedByFirstName": "sample string 3",
            "TransitionedByLastName": "sample string 4",
            "SelfTransitioned": true
          }
        }
      ]
    },
    {
      "Id": 1,
      "ComplianceStatus": "sample string 2",
      "ProfileComplianceStatus": null,
      "CandidateId": "sample string 3",
      "RoleId": "sample string 4",
      "Type": 5,
      "CandidateCardTags": [
        {
          "Id": "sample string 1",
          "MemberId": "sample string 2",
          "Name": "sample string 3",
          "TagCategoryId": "sample string 4",
          "TagCategoryName": "sample string 5"
        },
        {
          "Id": "sample string 1",
          "MemberId": "sample string 2",
          "Name": "sample string 3",
          "TagCategoryId": "sample string 4",
          "TagCategoryName": "sample string 5"
        }
      ],
      "ClubType": 1,
      "DailySupplyJobs": true,
      "LongTermJobs": true,
      "PermanentJobs": true,
      "RoleName": "sample string 3",
      "Rate": 12.0,
      "DailySupplyDayRate": 1.0,
      "DailySupplyHalfDayRate": 1.0,
      "LongTermDailyRate": 1.0,
      "HourlyRate": 1.0,
      "DailySupplyOvertimeHourlyRate": 1.0,
      "CompliantPercentage": 14.1,
      "ApprovedPercentage": 15.1,
      "ApprovedOn": "2025-05-06T13:14:28.512495Z",
      "Summary": "sample string 16",
      "CandidateAssetId": 1,
      "JourneyTime": 1,
      "DrivingOpt": true,
      "PublicTransportOpt": true,
      "PublicTransportBus": true,
      "PublicTransportTrain": true,
      "PublicTransportUnderground": true,
      "Cycling": true,
      "Walking": true,
      "CVName": "sample string 23",
      "RegisteredBy": "sample string 24",
      "ApprovedBy": "sample string 25",
      "FountainStage": {
        "CandidateId": "sample string 1",
        "OpeningId": "sample string 2",
        "StageId": "sample string 3",
        "ApplicationId": "sample string 4",
        "Title": "sample string 5",
        "JobRoleId": "sample string 6",
        "LocationId": "sample string 7"
      },
      "CandidateCardStatusHistories": [
        {
          "Id": 1,
          "CandidateId": "sample string 2",
          "CandidateCardId": 3,
          "ComplianceStatusRank": {
            "ComplianceStatusRankId": 1,
            "ComplianceStatusName": "sample string 2",
            "ComplianceStatusRank": 3
          },
          "Transition": {
            "TransitionedOn": "2025-05-06T13:14:28.512495Z",
            "TransitionedById": "sample string 2",
            "TransitionedByFirstName": "sample string 3",
            "TransitionedByLastName": "sample string 4",
            "SelfTransitioned": true
          }
        },
        {
          "Id": 1,
          "CandidateId": "sample string 2",
          "CandidateCardId": 3,
          "ComplianceStatusRank": {
            "ComplianceStatusRankId": 1,
            "ComplianceStatusName": "sample string 2",
            "ComplianceStatusRank": 3
          },
          "Transition": {
            "TransitionedOn": "2025-05-06T13:14:28.512495Z",
            "TransitionedById": "sample string 2",
            "TransitionedByFirstName": "sample string 3",
            "TransitionedByLastName": "sample string 4",
            "SelfTransitioned": true
          }
        }
      ]
    }
  ],
  "Position": 0,
  "LongTermAvailableFrom": "2025-05-06T13:14:28.512495Z",
  "Location": {
    "Name": "sample string 1",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "AddressLine4": "sample string 5",
    "PostCode": "sample string 6",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "City": "sample string 7",
    "Region": "sample string 8",
    "Address": "sample string 2 sample string 3 sample string 4 sample string 5 sample string 6",
    "AddressDescription": "sample string 9",
    "ArrivalInstructions": "sample string 10"
  },
  "DailySupplyAvailability": [
    {
      "Date": "2025-05-06T13:14:28.512495Z",
      "AvailabilityType": 0
    },
    {
      "Date": "2025-05-06T13:14:28.512495Z",
      "AvailabilityType": 0
    }
  ],
  "UserDevices": [
    {
      "Id": 1,
      "UserId": "sample string 2",
      "DeviceToken": "sample string 3",
      "DeviceType": 4,
      "CreatedOn": "2025-05-06T13:14:28.512495Z",
      "CandidateName": "sample string 6"
    },
    {
      "Id": 1,
      "UserId": "sample string 2",
      "DeviceToken": "sample string 3",
      "DeviceType": 4,
      "CreatedOn": "2025-05-06T13:14:28.512495Z",
      "CandidateName": "sample string 6"
    }
  ],
  "IsApproved": true,
  "IsActive": true,
  "AmbassadorSummary": {
    "ReferralCode": "sample string 1",
    "ReferralUrl": "https://app-qa.opogo.com/signup?source%3Dreferral%26referralid%3Dsample string 1",
    "HasReferrals": true
  }
}