POST V4/Partners/BreedMatch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PetType	string	None.
IncludeHybrids	boolean	None.
ExcludeBreeds	Collection of string	None.
KennelOnly	boolean	None.
MaxResults	integer	None.
Inputs	Collection of BreedMatchInput	None.

Request Formats

application/json, text/json

Sample:

{
  "PetType": "sample string 1",
  "IncludeHybrids": true,
  "ExcludeBreeds": [
    "sample string 1",
    "sample string 2"
  ],
  "KennelOnly": true,
  "MaxResults": 4,
  "Inputs": [
    {
      "Category": "sample string 1",
      "ScoreLow": 2.1,
      "ScoreHigh": 3.1,
      "Weight": 4.1
    },
    {
      "Category": "sample string 1",
      "ScoreLow": 2.1,
      "ScoreHigh": 3.1,
      "Weight": 4.1
    }
  ]
}

application/xml, text/xml

Sample:

<BreedMatchOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PetkeyApi.Common">
  <ExcludeBreeds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeBreeds>
  <IncludeHybrids>true</IncludeHybrids>
  <Inputs>
    <BreedMatchInput>
      <Category>sample string 1</Category>
      <ScoreHigh>3.1</ScoreHigh>
      <ScoreLow>2.1</ScoreLow>
      <Weight>4.1</Weight>
    </BreedMatchInput>
    <BreedMatchInput>
      <Category>sample string 1</Category>
      <ScoreHigh>3.1</ScoreHigh>
      <ScoreLow>2.1</ScoreLow>
      <Weight>4.1</Weight>
    </BreedMatchInput>
  </Inputs>
  <KennelOnly>true</KennelOnly>
  <MaxResults>4</MaxResults>
  <PetType>sample string 1</PetType>
</BreedMatchOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of BreedMatchResult

Name	Type	Additional information
TotalScore	decimal number	None.
Breed	Breed	None.
Rank	integer	None.
Scores	Collection of BreedMatchScore	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Breed": {
      "BreedId": "sample string 1",
      "PetType": "sample string 2",
      "BreedName": "sample string 3",
      "Purebred1": "sample string 4",
      "Purebred2": "sample string 5",
      "AlternateNames": [
        "sample string 1",
        "sample string 2"
      ],
      "Size": "sample string 6",
      "Description": "sample string 7",
      "Color": "sample string 8",
      "Temperament": "sample string 9",
      "CareLevel": "sample string 10",
      "Origin": "sample string 11",
      "Photo": {
        "BaseUrl": "sample string 1",
        "Original": "sample string 2",
        "Size100": "sample string 3",
        "Size100W": "sample string 4",
        "Size200": "sample string 5",
        "Size200W": "sample string 6",
        "Size300": "sample string 7",
        "Size300W": "sample string 8",
        "Size500": "sample string 9",
        "Size500W": "sample string 10",
        "Size800": "sample string 11",
        "Size800W": "sample string 12",
        "Caption": "sample string 13"
      },
      "Photos": [
        {
          "BaseUrl": "sample string 1",
          "Original": "sample string 2",
          "Size100": "sample string 3",
          "Size100W": "sample string 4",
          "Size200": "sample string 5",
          "Size200W": "sample string 6",
          "Size300": "sample string 7",
          "Size300W": "sample string 8",
          "Size500": "sample string 9",
          "Size500W": "sample string 10",
          "Size800": "sample string 11",
          "Size800W": "sample string 12",
          "Caption": "sample string 13"
        },
        {
          "BaseUrl": "sample string 1",
          "Original": "sample string 2",
          "Size100": "sample string 3",
          "Size100W": "sample string 4",
          "Size200": "sample string 5",
          "Size200W": "sample string 6",
          "Size300": "sample string 7",
          "Size300W": "sample string 8",
          "Size500": "sample string 9",
          "Size500W": "sample string 10",
          "Size800": "sample string 11",
          "Size800W": "sample string 12",
          "Caption": "sample string 13"
        }
      ]
    },
    "Rank": 2,
    "TotalScore": 1.1,
    "Scores": [
      {
        "Category": "sample string 1",
        "BreedValue": 2.1,
        "InputLow": 3.1,
        "InputHigh": 4.1,
        "Delta": 5.1,
        "Weight": 6.1,
        "Score": 7.1
      },
      {
        "Category": "sample string 1",
        "BreedValue": 2.1,
        "InputLow": 3.1,
        "InputHigh": 4.1,
        "Delta": 5.1,
        "Weight": 6.1,
        "Score": 7.1
      }
    ]
  },
  {
    "Breed": {
      "BreedId": "sample string 1",
      "PetType": "sample string 2",
      "BreedName": "sample string 3",
      "Purebred1": "sample string 4",
      "Purebred2": "sample string 5",
      "AlternateNames": [
        "sample string 1",
        "sample string 2"
      ],
      "Size": "sample string 6",
      "Description": "sample string 7",
      "Color": "sample string 8",
      "Temperament": "sample string 9",
      "CareLevel": "sample string 10",
      "Origin": "sample string 11",
      "Photo": {
        "BaseUrl": "sample string 1",
        "Original": "sample string 2",
        "Size100": "sample string 3",
        "Size100W": "sample string 4",
        "Size200": "sample string 5",
        "Size200W": "sample string 6",
        "Size300": "sample string 7",
        "Size300W": "sample string 8",
        "Size500": "sample string 9",
        "Size500W": "sample string 10",
        "Size800": "sample string 11",
        "Size800W": "sample string 12",
        "Caption": "sample string 13"
      },
      "Photos": [
        {
          "BaseUrl": "sample string 1",
          "Original": "sample string 2",
          "Size100": "sample string 3",
          "Size100W": "sample string 4",
          "Size200": "sample string 5",
          "Size200W": "sample string 6",
          "Size300": "sample string 7",
          "Size300W": "sample string 8",
          "Size500": "sample string 9",
          "Size500W": "sample string 10",
          "Size800": "sample string 11",
          "Size800W": "sample string 12",
          "Caption": "sample string 13"
        },
        {
          "BaseUrl": "sample string 1",
          "Original": "sample string 2",
          "Size100": "sample string 3",
          "Size100W": "sample string 4",
          "Size200": "sample string 5",
          "Size200W": "sample string 6",
          "Size300": "sample string 7",
          "Size300W": "sample string 8",
          "Size500": "sample string 9",
          "Size500W": "sample string 10",
          "Size800": "sample string 11",
          "Size800W": "sample string 12",
          "Caption": "sample string 13"
        }
      ]
    },
    "Rank": 2,
    "TotalScore": 1.1,
    "Scores": [
      {
        "Category": "sample string 1",
        "BreedValue": 2.1,
        "InputLow": 3.1,
        "InputHigh": 4.1,
        "Delta": 5.1,
        "Weight": 6.1,
        "Score": 7.1
      },
      {
        "Category": "sample string 1",
        "BreedValue": 2.1,
        "InputLow": 3.1,
        "InputHigh": 4.1,
        "Delta": 5.1,
        "Weight": 6.1,
        "Score": 7.1
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfBreedMatchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PetkeyApi.Common">
  <BreedMatchResult>
    <Breed>
      <AlternateNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AlternateNames>
      <BreedId>sample string 1</BreedId>
      <BreedName>sample string 3</BreedName>
      <CareLevel>sample string 10</CareLevel>
      <Color>sample string 8</Color>
      <Description>sample string 7</Description>
      <Origin>sample string 11</Origin>
      <PetType>sample string 2</PetType>
      <Photo>
        <BaseUrl>sample string 1</BaseUrl>
        <Caption>sample string 13</Caption>
        <Original>sample string 2</Original>
        <Size100>sample string 3</Size100>
        <Size100W>sample string 4</Size100W>
        <Size200>sample string 5</Size200>
        <Size200W>sample string 6</Size200W>
        <Size300>sample string 7</Size300>
        <Size300W>sample string 8</Size300W>
        <Size500>sample string 9</Size500>
        <Size500W>sample string 10</Size500W>
        <Size800>sample string 11</Size800>
        <Size800W>sample string 12</Size800W>
      </Photo>
      <Photos>
        <Photo>
          <BaseUrl>sample string 1</BaseUrl>
          <Caption>sample string 13</Caption>
          <Original>sample string 2</Original>
          <Size100>sample string 3</Size100>
          <Size100W>sample string 4</Size100W>
          <Size200>sample string 5</Size200>
          <Size200W>sample string 6</Size200W>
          <Size300>sample string 7</Size300>
          <Size300W>sample string 8</Size300W>
          <Size500>sample string 9</Size500>
          <Size500W>sample string 10</Size500W>
          <Size800>sample string 11</Size800>
          <Size800W>sample string 12</Size800W>
        </Photo>
        <Photo>
          <BaseUrl>sample string 1</BaseUrl>
          <Caption>sample string 13</Caption>
          <Original>sample string 2</Original>
          <Size100>sample string 3</Size100>
          <Size100W>sample string 4</Size100W>
          <Size200>sample string 5</Size200>
          <Size200W>sample string 6</Size200W>
          <Size300>sample string 7</Size300>
          <Size300W>sample string 8</Size300W>
          <Size500>sample string 9</Size500>
          <Size500W>sample string 10</Size500W>
          <Size800>sample string 11</Size800>
          <Size800W>sample string 12</Size800W>
        </Photo>
      </Photos>
      <Purebred1>sample string 4</Purebred1>
      <Purebred2>sample string 5</Purebred2>
      <Size>sample string 6</Size>
      <Temperament>sample string 9</Temperament>
    </Breed>
    <Rank>2</Rank>
    <Scores>
      <BreedMatchScore>
        <BreedValue>2.1</BreedValue>
        <Category>sample string 1</Category>
        <Delta>5.1</Delta>
        <InputHigh>4.1</InputHigh>
        <InputLow>3.1</InputLow>
        <Score>7.1</Score>
        <Weight>6.1</Weight>
      </BreedMatchScore>
      <BreedMatchScore>
        <BreedValue>2.1</BreedValue>
        <Category>sample string 1</Category>
        <Delta>5.1</Delta>
        <InputHigh>4.1</InputHigh>
        <InputLow>3.1</InputLow>
        <Score>7.1</Score>
        <Weight>6.1</Weight>
      </BreedMatchScore>
    </Scores>
    <TotalScore>1.1</TotalScore>
  </BreedMatchResult>
  <BreedMatchResult>
    <Breed>
      <AlternateNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AlternateNames>
      <BreedId>sample string 1</BreedId>
      <BreedName>sample string 3</BreedName>
      <CareLevel>sample string 10</CareLevel>
      <Color>sample string 8</Color>
      <Description>sample string 7</Description>
      <Origin>sample string 11</Origin>
      <PetType>sample string 2</PetType>
      <Photo>
        <BaseUrl>sample string 1</BaseUrl>
        <Caption>sample string 13</Caption>
        <Original>sample string 2</Original>
        <Size100>sample string 3</Size100>
        <Size100W>sample string 4</Size100W>
        <Size200>sample string 5</Size200>
        <Size200W>sample string 6</Size200W>
        <Size300>sample string 7</Size300>
        <Size300W>sample string 8</Size300W>
        <Size500>sample string 9</Size500>
        <Size500W>sample string 10</Size500W>
        <Size800>sample string 11</Size800>
        <Size800W>sample string 12</Size800W>
      </Photo>
      <Photos>
        <Photo>
          <BaseUrl>sample string 1</BaseUrl>
          <Caption>sample string 13</Caption>
          <Original>sample string 2</Original>
          <Size100>sample string 3</Size100>
          <Size100W>sample string 4</Size100W>
          <Size200>sample string 5</Size200>
          <Size200W>sample string 6</Size200W>
          <Size300>sample string 7</Size300>
          <Size300W>sample string 8</Size300W>
          <Size500>sample string 9</Size500>
          <Size500W>sample string 10</Size500W>
          <Size800>sample string 11</Size800>
          <Size800W>sample string 12</Size800W>
        </Photo>
        <Photo>
          <BaseUrl>sample string 1</BaseUrl>
          <Caption>sample string 13</Caption>
          <Original>sample string 2</Original>
          <Size100>sample string 3</Size100>
          <Size100W>sample string 4</Size100W>
          <Size200>sample string 5</Size200>
          <Size200W>sample string 6</Size200W>
          <Size300>sample string 7</Size300>
          <Size300W>sample string 8</Size300W>
          <Size500>sample string 9</Size500>
          <Size500W>sample string 10</Size500W>
          <Size800>sample string 11</Size800>
          <Size800W>sample string 12</Size800W>
        </Photo>
      </Photos>
      <Purebred1>sample string 4</Purebred1>
      <Purebred2>sample string 5</Purebred2>
      <Size>sample string 6</Size>
      <Temperament>sample string 9</Temperament>
    </Breed>
    <Rank>2</Rank>
    <Scores>
      <BreedMatchScore>
        <BreedValue>2.1</BreedValue>
        <Category>sample string 1</Category>
        <Delta>5.1</Delta>
        <InputHigh>4.1</InputHigh>
        <InputLow>3.1</InputLow>
        <Score>7.1</Score>
        <Weight>6.1</Weight>
      </BreedMatchScore>
      <BreedMatchScore>
        <BreedValue>2.1</BreedValue>
        <Category>sample string 1</Category>
        <Delta>5.1</Delta>
        <InputHigh>4.1</InputHigh>
        <InputLow>3.1</InputLow>
        <Score>7.1</Score>
        <Weight>6.1</Weight>
      </BreedMatchScore>
    </Scores>
    <TotalScore>1.1</TotalScore>
  </BreedMatchResult>
</ArrayOfBreedMatchResult>