POST api/list/groupmatches/csv

Generates a csv file from group matches by property role id

Request Information

URI Parameters

None.

Body Parameters

PropertyGroupMatchCsvCommandDataContract

Name	Type	Additional information
PropertyRoleId	integer	None.
ApplicantRoleIds	Collection of integer	None.
ExcludedApplicantRoleIds	Collection of integer	None.
Filter	RoleApplicantMatchFilterDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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
  }
}

Response Information

Resource Description

JobInvocationDetailsDataContract

Name	Type	Additional 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": "7e783150-39ba-4f02-bb4e-2eca8c64e8f4",
  "Success": true
}