POST api/v2.0/Mentoring/GetParticipantsByDemographicValue

Returns a paginated list of active participants who chose a specific MentorMatch demographic value. Can only be accessed by an Admin user.

Request Information

URI Parameters

None.

Body Parameters

DemographicTypeName: configured MentorMatch category name (case-insensitive), Role: "mentor" or "mentee", ValueName: the specific value to list participants for, as returned by GetDemographicSummary, Page: 1-based page number (max 200), ResultsPerPage: number of participants per page (max 500).

MentoringParticipantsByDemographicValueRequest

Name	Description	Type	Additional information
DemographicTypeName	Configured MentorMatch demographic category name (case-insensitive). Free-form categories are not currently supported.	string	None.
Role	Participant role: "mentor" or "mentee".	string	None.
ValueName	The specific value within the category to list participants for.	string	None.
Page	1-based page number. Defaults to 1, capped at 200.	integer	Range: inclusive between 1 and 200
ResultsPerPage	Number of participants to return per page. Defaults to 25, capped at 500.	integer	Range: inclusive between 1 and 500

Request Formats

application/json, text/json

Sample:

{
  "DemographicTypeName": "Industry",
  "Role": "mentor",
  "ValueName": "Technology",
  "Page": 1,
  "ResultsPerPage": 25
}

application/xml, text/xml

Sample:

<MentoringParticipantsByDemographicValueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Mentoring">
  <DemographicTypeName>sample string 1</DemographicTypeName>
  <Page>4</Page>
  <ResultsPerPage>5</ResultsPerPage>
  <Role>sample string 2</Role>
  <ValueName>sample string 3</ValueName>
</MentoringParticipantsByDemographicValueRequest>

Response Information

Resource Description

A page of participants for the requested value, plus paging metadata.

MentoringParticipantsByDemographicValueResponse

Name	Description	Type	Additional information
DemographicTypeKey	Key of the MentorMatch demographic category.	globally unique identifier	None.
DemographicTypeName	Name of the MentorMatch demographic category.	string	None.
Role	Normalized to "mentor" or "mentee".	string	None.
ValueName	The specific value this page of participants was requested for.	string	None.
ContactKeys	ContactKeys for this page of participants who chose ValueName.	Collection of globally unique identifier	None.
Page	The page requested, clamped to at least 1. A page beyond the available data returns an empty ContactKeys array.	integer	None.
TotalCount	Total number of active participants who chose this value.	integer	None.
HasMore	True if more pages are available beyond this one.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "DemographicTypeKey": "b1e2c3d4-1234-5678-9abc-def012345678",
  "DemographicTypeName": "Industry",
  "Role": "mentor",
  "ValueName": "Technology",
  "ContactKeys": [
    "05d3b5cb-307e-40ce-8641-79131502c558",
    "e166f8be-bbe2-4e01-98b2-49ddf4086ac8"
  ],
  "Page": 1,
  "TotalCount": 2,
  "HasMore": false
}

application/xml, text/xml

Sample:

<MentoringParticipantsByDemographicValueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Mentoring">
  <ContactKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>60cced58-f2eb-47b0-a396-561995c92ce7</d2p1:guid>
    <d2p1:guid>532ec331-1539-4216-874a-345841b2606a</d2p1:guid>
  </ContactKeys>
  <DemographicTypeKey>85e033de-e476-47ca-807a-93515afe1573</DemographicTypeKey>
  <DemographicTypeName>sample string 2</DemographicTypeName>
  <HasMore>true</HasMore>
  <Page>5</Page>
  <Role>sample string 3</Role>
  <TotalCount>6</TotalCount>
  <ValueName>sample string 4</ValueName>
</MentoringParticipantsByDemographicValueResponse>