...

The RescueGroups.org HTTP API provides detailed information concerning object properties. The definition for each object can be retrieved using the define action, as shown in the example below.

$data = array(
  "token" => $token,
  "tokenHash" => $tokenHash,
  "objectType" => "animals",
  "objectAction" => "define",
);

...

• disableAnimalExportAdopted: Prevent adopted animals from being uploaded to Petfinder (string from values list)
• disableAnimalExportCourtesy: Prevent courtesy animals from being uploaded to other sites (string from values list)
• disableAnimalExportAnimalWebPageLink: Disable the link to the animal's web page (string from values list)
• disableAnimalExportWebsiteLink: Disable the link to your organization's website (string from values list)
• disableAnimalExportAdoptionFormLink: Disable the link to your adoption form (string from values list)
• enableAnimalExportDescriptionHeader: Include the Animal Description Header in the animal description (string from values list)
• enableAnimalExportDescriptionFooter: Include the Animal Description Footer in the animal description (string from values list)
• enableAnimalExportUniqueAnimalID: Use the RescueGroups.org Animal ID as a Unique ID (string from values list)
• enableAnimalExportContactFieldFirstname: Show the foster/caretaker's first name (string from values list)
• enableAnimalExportContactFieldLastname: Show the foster/caretaker's last name (string from values list)
• enableAnimalExportContactFieldEmail: Show the foster/caretaker's email address (string from values list)
• enableAnimalExportContactFieldPhoneHome: Show the foster/caretaker's home phone number (string from values list)
• enableAnimalExportContactFieldPhoneCell: Show the foster/caretaker's cell phone number (string from values list)
• setAnimalExportYouTubeAccount: Account to use for YouTube video upload (string from values list)
• **: ()
• setAnimalExportDefaultCategory1: By default, export to services that list animals for adoption (string from values list)
• setAnimalExportDefaultCategory4: By default, export to services that list animals for adoption (from non-rescue/shelters) (string from values list)
• setAnimalExportDefaultCategory3: By default, export to services that list animals for sale by breeder (string from values list)
• setAnimalExportDefaultCategory2: By default, export to services that list animals for sale by owner (string from values list)
• setAnimalExportDefaultCategory5: By default, export to services that provide animal related classifieds (string from values list)
• setAnimalExportDefaultCategory6: By default, export to services that provide animal related community discussion/forums (string from values list)
• setAnimalExportDefaultCategory8: By default, export to services that provide animal related educational information (string from values list)
• setAnimalExportDefaultCategory7: By default, export to services that provide animal related news (string from values list)
• setAnimalExportDefaultCategory13: By default, export to services that provide event calendars (string from values list)
• setAnimalExportDefaultCategory9: By default, export to services that sell/promote animal related products (food, toys, treats, etc) (string from values list)
• setAnimalExportDefaultCategory11: By default, export to services that sell/promote animal related services (training, grooming) (string from values list)
• setAnimalExportDefaultCategory10: By default, export to services that sell/promote non-animal related products (string from values list)
• setAnimalExportDefaultCategory12: By default, export to services that sell/promote non-animal related services (string from values list)

animalsMedia

Actions:

Warning: Invalid argument supplied for foreach() in /var/www/htdocs/admin/api_docs.php on line 149

...

:

...

animalsReasonsEuthanasia

Actions:

...

• enableWebsiteDown: Website down for maintenance (string from values list)
• disableWebsiteFavoriteEmails: Disable user email alerts for Favorite Animals and Breeds (string from values list)
• enableWebsitePetfinderHomePageUpload: Upload website home page as Petfinder web page (string from values list)
• setWebsiteSlogan: Website slogan (string)
• setWebsiteMenuSource: Website menu source (key)
• setWebsiteIndexPageID: Custom front page (key)
• enableWebsiteFrontPageLogo: Display Logo on front page (string from values list)
• enableWebsiteFrontPageNews: Show the latest News articles on the front page (string from values list)
• enableWebsiteFrontPageEvents: Show upcoming Events on the front page (string from values list)
• enableWebsiteFrontPageHighlightedAnimals: Show highlighted animals on the front page (string from values list)
• setWebsiteFrontPageNumberOfHighlightedAnimals: Number of highlighted animals to show on the front page (int)
• setWebsiteFrontPageHighlightedAnimalsDescriptionLength: Amount of highlighted animals' description to show on the front page (int)
• enableWebsiteRescueGroupsPoweredByImage: Show the Powered by RescueGroups.org image (string from values list)
• enableWebsiteMenuLogoutUsername: Show the user name on the menu next to the Logout option (string from values list)
• enableWebsiteLastUpdated: Show the date/time the website was last updated (string from values list)
• setWebsiteAnimalPictureMode: Set the animal picture mode (string from values list)
• setWebsiteAnimalPictureAnimalID: Select the animal for the Featured animal picture (key)
• enableWebsiteAnimalSearchBox: Show the animal seach box (string from values list)
• enableWebsiteSideBarAddress: Show mailing address on the side bar (string from values list)
• enableWebsiteEmailFriend: Show Email Page to a Friend (string from values list)
• enableWebsiteShareButton: Show share button (string from values list)
• enableWebsiteSparky: Show the DogTime Sparky widget (string from values list)
• setWebsiteSideBarWidth: Set the side bar width (int)
• enableWebsiteLogo: Show logo (string from values list)
• setWebsiteBackgroundImageID: Set the background image (key)
• enableAnimalMeet: Enable the Meet Request feature (string from values list)
• enableWebsiteContactUsForm: Enable the Contact Us form (string from values list)
• setWebsiteAnimalBrowseLayout: Animal Browse page layout (string from values list)
• setWebsiteAnimalBrowsePanelWidth: Set the animal browse panel width (int)
• setWebsiteAnimalBrowsePanelColumns: Animal Browse page columns (int from values list)
• setWebsiteAnimalBrowseAnimalsPerPage: Animal Browse page number of animals (int from values list)
• setWebsiteAnimalBrowseLimit: Animal limit (int from values list)
• disableWebsiteAnimalBrowseCourtesyListings: Hide courtesy listings on browse/list page (string from values list)
• showWebsiteAnimalBrowseSponsorshipLink: Show sponsorship link on the browse page (string from values list)
• setWebsiteAnimalBrowseDescriptionLength: How much of each animal's description to display (int)
• setWebsiteAnimalBrowseFields: (string)
• enableAnimalAdoptions: List Animals available for adoption (string from values list)
• setAnimalDetailPageStyle: Animal detail page layout (string from values list)
• enableAnimalDetailPagePopover: Use a popover to display animal details (string from values list)
• enableAnimalDetailPageShareButton: Show the Animal detail page share button (string from values list)
• disableAnimalDetailPageAdoptionInfoLink: Disable the Animal detail page Adoption Information link (string from values list)
• disableAnimalDetailPageAdoptionInfoLinkCourtesy: Disable the Animal detail page Adoption Information link on courtesy animals (string from values list)
• showAnimalDetailPageDogTimeContent: Show DogTime content on the Animal detail page (string from values list)
• showAnimalDetailPageDogTimeSaveaDog: Show a link on the Animal detail page to Save-a-Dog or Save-a-Cat on DogTime (string from values list)
• setAnimalDetailPageEventsLimit: How many Events to show on the Animal detail page (string from values list)
• showAnimalDetailPageAdoptMeSayings: Show the Adopt Me sayings on the Animal detail page (string from values list)
• disableAnimalDetailPageMyRescue: Disable the My Rescue box on the Animal detail page (string from values list)
• disableAnimalFlyer: Disable the link to the Petbond Animal adoption flyer (string from values list)
• disableAnimalFavoriteCount: Disable the Animal favorite count (string from values list)
• disableAnimalSuccessesPublic: Disable public access to the Animal successes (string from values list)
• disableAnimalStories: Disable Animal success stories (string from values list)
• showAnimalTransferredWithSuccesses: Show transferred Animals with successes (string from values list)
• showAnimalLinks: Show Animal links (string from values list)
• showAnimalHomePageHighlighted: Show Highlighted Animals on the Animal Home Page (string from values list)
• enableAnimalImageBorder: Set the Animal image border (string from values list)
• setAnimalImageBorderStyle: Set the Animal image border style (string from values list)
• setAnimalImageBorderColor: Set the Animal image border color (string)
• setAnimalImageMatteColor: Set the Animal image matte color (string)
• disableAnimalDescriptionVideo: Disable videos in Animal descriptions (string from values list)
• enableAnimalDescriptionVideoLink: Use a link instead of embedding the video in Animal descriptions (string from values list)
• enableAnimalKennelcardPrintAuto: Automatically print the Animal Kennel Card (string from values list)
• showAnimalKennelcardJournalEntries: Show journal entries on the kennel card (string from values list)
• showAnimalKennelcardJournalCost: Show cost on the kennel card (string from values list)
• disableAnimalAgeBestEstimate: Disable the message that animal ages are best estimates (string from values list)

...