POST api/list/groupmatches/csv

Generates a csv file from group matches by property role id

Request Information

URI Parameters

None.

Body Parameters

PropertyGroupMatchCsvCommandDataContract
NameDescriptionTypeAdditional information
PropertyRoleId

integer

None.

ApplicantRoleIds

Collection of integer

None.

ExcludedApplicantRoleIds

Collection of integer

None.

Filter

RoleApplicantMatchFilterDataContract

None.

Request Formats

application/json, text/json

Sample:
{
  "PropertyRoleId": 1,
  "ApplicantRoleIds": [
    1,
    2
  ],
  "ExcludedApplicantRoleIds": [
    1,
    2
  ],
  "Filter": {
    "Grades": [
      "sample string 1",
      "sample string 2"
    ],
    "FinancialStatus": [
      "sample string 1",
      "sample string 2"
    ],
    "ExcludeMailoutDays": 1,
    "OwningTeamId": 1,
    "BranchIds": [
      1,
      2
    ],
    "IncludedRoleIds": [
      1,
      2
    ],
    "ExcludedRoleIds": [
      1,
      2
    ],
    "MinScore": 1
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

boolean

None.

ReportsProgress

boolean

None.

InitialStatusText

string

None.

JobReference

globally unique identifier

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "52b3829c-1696-4ee5-92d0-68c6e96dde3c",
  "Success": true
}