POST api/list/groupmatches/csv

Generates a csv file from group matches by property role id Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The property group match csv command data contract supplied with the request.

PropertyGroupMatchCsvCommandDataContract

Name	Description	Type	Additional information
PropertyRoleId	The unique identifier of the related property role resource.	integer	None.
ApplicantRoleIds	The unique identifiers of the related applicant role resources.	Collection of integer	None.
ExcludedApplicantRoleIds	The unique identifiers of the related excluded applicant role resources.	Collection of integer	None.
Filter	The filter value.	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
    ],
    "InterestedRoleIds": [
      1,
      2
    ],
    "MinScore": 1,
    "MatchSource": 0
  }
}

Response Information

Resource Description

The response returned after the operation completes.

JobInvocationDetailsDataContract

Name	Description	Type	Additional information
SupportsCancellation	Indicates whether supports cancellation is true.	boolean	None.
ReportsProgress	Indicates whether reports progress is true.	boolean	None.
InitialStatusText	The initial status text value.	string	None.
JobReference	The job reference globally unique identifier.	globally unique identifier	None.
Success	Indicates whether success is true.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "0605382e-a405-4351-a4b5-a3001efe2615",
  "Success": true
}