POST api/v2/Version2.CreateMatch

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

CreateMatchInputModel
NameDescriptionTypeAdditional information
LoginUserID

string

None.

AuthenticationKey

string

None.

DeviceType

string

None.

DeviceToken

string

None.

ProgramId

string

None.

MatchCount

string

None.

ClientId

string

None.

MatchType

string

None.

ListMatches

Collection of MatchingPiars

None.

Request Formats

application/json, text/json

Sample:
{
  "LoginUserID": "sample string 1",
  "AuthenticationKey": "sample string 2",
  "DeviceType": "sample string 3",
  "DeviceToken": "sample string 4",
  "ProgramId": "sample string 5",
  "MatchCount": "sample string 6",
  "ClientId": "sample string 7",
  "MatchType": "sample string 8",
  "ListMatches": [
    {
      "Mentoree": "sample string 1",
      "Mentor": "sample string 2",
      "StartDate": "sample string 3",
      "StartNotes": "sample string 4"
    },
    {
      "Mentoree": "sample string 1",
      "Mentor": "sample string 2",
      "StartDate": "sample string 3",
      "StartNotes": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<MCObjects.CreateMatchInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MC.Entity.v2">
  <AuthenticationKey>sample string 2</AuthenticationKey>
  <ClientId>sample string 7</ClientId>
  <DeviceToken>sample string 4</DeviceToken>
  <DeviceType>sample string 3</DeviceType>
  <ListMatches>
    <MCObjects.MatchingPiars>
      <Mentor>sample string 2</Mentor>
      <Mentoree>sample string 1</Mentoree>
      <StartDate>sample string 3</StartDate>
      <StartNotes>sample string 4</StartNotes>
    </MCObjects.MatchingPiars>
    <MCObjects.MatchingPiars>
      <Mentor>sample string 2</Mentor>
      <Mentoree>sample string 1</Mentoree>
      <StartDate>sample string 3</StartDate>
      <StartNotes>sample string 4</StartNotes>
    </MCObjects.MatchingPiars>
  </ListMatches>
  <LoginUserID>sample string 1</LoginUserID>
  <MatchCount>sample string 6</MatchCount>
  <MatchType>sample string 8</MatchType>
  <ProgramId>sample string 5</ProgramId>
</MCObjects.CreateMatchInputModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateMatchInputModel'.

Response Information

Resource Description

CreateMatchResult
NameDescriptionTypeAdditional information
Result

string

None.

Message

string

None.

MessageCode

string

None.

MessageVariables

string

None.

ListMatchedPairs

Collection of MatchedPairs

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": "sample string 1",
  "Message": "sample string 2",
  "MessageCode": "sample string 3",
  "MessageVariables": "sample string 4",
  "ListMatchedPairs": [
    {
      "MentorUserId": "sample string 1",
      "MentoreeUserId": "sample string 2",
      "ErrorMessage": "sample string 3"
    },
    {
      "MentorUserId": "sample string 1",
      "MentoreeUserId": "sample string 2",
      "ErrorMessage": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<MCObjects.CreateMatchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MC.Entity.v2">
  <ListMatchedPairs>
    <MCObjects.MatchedPairs>
      <ErrorMessage>sample string 3</ErrorMessage>
      <MentorUserId>sample string 1</MentorUserId>
      <MentoreeUserId>sample string 2</MentoreeUserId>
    </MCObjects.MatchedPairs>
    <MCObjects.MatchedPairs>
      <ErrorMessage>sample string 3</ErrorMessage>
      <MentorUserId>sample string 1</MentorUserId>
      <MentoreeUserId>sample string 2</MentoreeUserId>
    </MCObjects.MatchedPairs>
  </ListMatchedPairs>
  <Message>sample string 2</Message>
  <MessageCode>sample string 3</MessageCode>
  <MessageVariables>sample string 4</MessageVariables>
  <Result>sample string 1</Result>
</MCObjects.CreateMatchResult>