POST api/Public/AvailableAnimals

Method for getting available animals in PATCH.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageNumber	Current page of animals to return	integer	None.
PageSize	Number of animals on page	integer	None.
SortBy	Column of data list to sort by	string	None.
SortDirection	which direction to sort chosen 'SortBy' column	string	None.
SearchAnimalID	Searches animal by PATCH unique identifier	integer	None.
SearchModule	Searches animals by module, (used to sperate data in to groups in PATCH) ACN can provide modules.	string	None.
SearchBreed	Searches aniamals by breed	string	None.
SearchCentre	Searches animals by centre looking after the animal	string	None.
SearchGender	Searches animals by gender	string	None.
SearchAnimalAgeFrom	Searches the min age an animal can be	integer	None.
SearchAnimalAgeTo	Searches the age max age an animal can be	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "PageNumber": 1,
  "PageSize": 2,
  "SortBy": "sample string 3",
  "SortDirection": "sample string 4",
  "SearchAnimalID": 1,
  "SearchModule": "sample string 5",
  "SearchBreed": "sample string 6",
  "SearchCentre": "sample string 7",
  "SearchGender": "sample string 8",
  "SearchAnimalAgeFrom": 1,
  "SearchAnimalAgeTo": 1
}

application/xml, text/xml

Sample:

<AvailableAnimalsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SCN.Patch.AvailableAnimalsAPI.WebUI.Areas.AvailableAnimals.Models">
  <PageNumber>1</PageNumber>
  <PageSize>2</PageSize>
  <SearchAnimalAgeFrom>1</SearchAnimalAgeFrom>
  <SearchAnimalAgeTo>1</SearchAnimalAgeTo>
  <SearchAnimalID>1</SearchAnimalID>
  <SearchBreed>sample string 6</SearchBreed>
  <SearchCentre>sample string 7</SearchCentre>
  <SearchGender>sample string 8</SearchGender>
  <SearchModule>sample string 5</SearchModule>
  <SortBy>sample string 3</SortBy>
  <SortDirection>sample string 4</SortDirection>
</AvailableAnimalsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Json string for use.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.