POST V4/Partners/Search

Request Information

URI Parameters

None.

Body Parameters

SearchOptions
NameDescriptionTypeAdditional information
Status

string

None.

PetType

string

None.

BreedId

string

None.

Gender

string

None.

HasPhoto

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "PetType": "sample string 2",
  "BreedId": "sample string 3",
  "Gender": "sample string 4",
  "HasPhoto": true
}

application/xml, text/xml

Sample:
<SearchOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PetkeyApi.Common">
  <BreedId>sample string 3</BreedId>
  <Gender>sample string 4</Gender>
  <HasPhoto>true</HasPhoto>
  <PetType>sample string 2</PetType>
  <Status>sample string 1</Status>
</SearchOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Pet
NameDescriptionTypeAdditional information
PetId

integer

None.

OrgName

string

None.

PetType

string

None.

PetName

string

None.

BreedId

string

None.

BreedName

string

None.

Purebred1

string

None.

Purebred2

string

None.

Gender

string

None.

BirthDate

string

None.

Age

string

None.

Weight

string

None.

ReferenceNumber

string

None.

Coloring

string

None.

Description

string

None.

Microchip

string

None.

PublicUrl

string

None.

VideoUrl

string

None.

Status

string

None.

Photo

Photo

None.

PhotoCount

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PetId": 1,
    "OrgName": "sample string 2",
    "PetType": "sample string 3",
    "PetName": "sample string 4",
    "BreedId": "sample string 5",
    "BreedName": "sample string 6",
    "Purebred1": "sample string 7",
    "Purebred2": "sample string 8",
    "Gender": "sample string 9",
    "BirthDate": "sample string 10",
    "Age": "sample string 11",
    "Weight": "sample string 12",
    "ReferenceNumber": "sample string 13",
    "Coloring": "sample string 14",
    "Description": "sample string 15",
    "Microchip": "sample string 16",
    "PublicUrl": "sample string 17",
    "VideoUrl": "sample string 18",
    "Status": "sample string 19",
    "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"
    },
    "PhotoCount": 20
  },
  {
    "PetId": 1,
    "OrgName": "sample string 2",
    "PetType": "sample string 3",
    "PetName": "sample string 4",
    "BreedId": "sample string 5",
    "BreedName": "sample string 6",
    "Purebred1": "sample string 7",
    "Purebred2": "sample string 8",
    "Gender": "sample string 9",
    "BirthDate": "sample string 10",
    "Age": "sample string 11",
    "Weight": "sample string 12",
    "ReferenceNumber": "sample string 13",
    "Coloring": "sample string 14",
    "Description": "sample string 15",
    "Microchip": "sample string 16",
    "PublicUrl": "sample string 17",
    "VideoUrl": "sample string 18",
    "Status": "sample string 19",
    "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"
    },
    "PhotoCount": 20
  }
]

application/xml, text/xml

Sample:
<ArrayOfPet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PetkeyApi.Common">
  <Pet>
    <Age>sample string 11</Age>
    <BirthDate>sample string 10</BirthDate>
    <BreedId>sample string 5</BreedId>
    <BreedName>sample string 6</BreedName>
    <Coloring>sample string 14</Coloring>
    <Description>sample string 15</Description>
    <Gender>sample string 9</Gender>
    <Microchip>sample string 16</Microchip>
    <OrgName>sample string 2</OrgName>
    <PetId>1</PetId>
    <PetName>sample string 4</PetName>
    <PetType>sample string 3</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>
    <PhotoCount>20</PhotoCount>
    <PublicUrl>sample string 17</PublicUrl>
    <Purebred1>sample string 7</Purebred1>
    <Purebred2>sample string 8</Purebred2>
    <ReferenceNumber>sample string 13</ReferenceNumber>
    <Status>sample string 19</Status>
    <VideoUrl>sample string 18</VideoUrl>
    <Weight>sample string 12</Weight>
  </Pet>
  <Pet>
    <Age>sample string 11</Age>
    <BirthDate>sample string 10</BirthDate>
    <BreedId>sample string 5</BreedId>
    <BreedName>sample string 6</BreedName>
    <Coloring>sample string 14</Coloring>
    <Description>sample string 15</Description>
    <Gender>sample string 9</Gender>
    <Microchip>sample string 16</Microchip>
    <OrgName>sample string 2</OrgName>
    <PetId>1</PetId>
    <PetName>sample string 4</PetName>
    <PetType>sample string 3</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>
    <PhotoCount>20</PhotoCount>
    <PublicUrl>sample string 17</PublicUrl>
    <Purebred1>sample string 7</Purebred1>
    <Purebred2>sample string 8</Purebred2>
    <ReferenceNumber>sample string 13</ReferenceNumber>
    <Status>sample string 19</Status>
    <VideoUrl>sample string 18</VideoUrl>
    <Weight>sample string 12</Weight>
  </Pet>
</ArrayOfPet>