Retrieving an object definition

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",
);

Objects

• affiliates
• animals
• animalBreeds
• animalColors
• animalConditions
• animalExportAccounts
• animalFiles
• animalGroups
• animalsAdoptions
• animalsJournalCategories
• animalsJournalEntrytypes
• animalsJournalEntries
• animalsMeetrequests
• animalPatterns
• animalQualities
• animalsExports
• animalsReasonsEuthanasia
• animalsReasonsImpound
• animalsReasonsSurrender
• animalsReasonsTransfer
• animalSpecies
• animalStatuses
• animalAdoptionLeads
• animalAdoptionStatuses
• calls
• callsCategories
• callsLogentries
• callsOutcomes
• callsQueues
• callsQueuesMembers
• callsStatuses
• callsUrgencies
• colonies
• coloniesCaretakers
• contacts
• contactFiles
• contactsGroups
• countries
• donations
• events
• eventanimalattendance
• intakes
• intakesBorninrescueshelter
• intakesImpounds
• intakesOwnerrequestedeuthanasias
• intakesOwnersurrenders
• intakesServices
• intakesStraydropoffs
• intakesStraypickups
• intakesTransfers
• intakesServicetypes
• inventoryitems
• inventoryitemsConditions
• inventoryfiles
• inventoryLoaners
• locations
• memorials
• microchipRegistrations
• microchipVendors
• newsarticles
• orgs
• outcomes
• outcomesAdoptions
• outcomesDeceased
• outcomesEuthanasias
• outcomesReleases
• outcomesReturntoowner
• outcomesTransfers
• partnerships
• roles
• submittedforms
• settings
• testimonials
• users
• volunteerHours
• volunteersJournalEntries
• waitinglists
• webfiles
• webimages
• webpages
• website

affiliates

Actions:

1. define
2. getSettings
3. updateSettings

1. define

Permissions

User permissions required: OrginfoAdmin

2. getSettings

Permissions

User permissions required: OrginfoAdmin

3. updateSettings

Permissions

User permissions required: OrginfoAdmin

Fields

• setAffiliatesPayPalEmail: (email)
• showAffiliatesPayPalLink: (string from values list)
• setAffiliatesIGiveCauseID: (string)
• showAffiliatesIGiveLink: (string from values list)
• setAffiliatesAmazonTag: (string)
• showAffiliatesAmazonLink: (string from values list)
• setAffiliatesUWID: (string)
• showAffiliatesUWLink: (string from values list)
• setAffiliatesCFCID: (string)
• showAffiliatesCFCLink: (string from values list)
• setAffiliatesVolunteerMatchOrgID: (string)
• showAffiliatesVolunteerMatchLink: (string from values list)
• setAffiliatesEIN: (string)
• showAffiliatesHelpingLink: (string from values list)
• setAffiliatesEbayStoreName: (string)
• showAffiliatesEbayStoreLink: (string from values list)
• setAffiliatesByVetsOnlyPartner: (string)
• showAffiliatesByVetsOnlyLink: (string from values list)
• setAffiliatesFacebookPage: (string)
• showAffiliatesFacebookLink: (string from values list)
• showAffiliatesFacebookBadge: (string from values list)
• setAffiliatesTwitterAccount: (string)
• showAffiliatesTwitterLink: (string from values list)
• showAffiliatesTwitterBadge: (string from values list)
• **: ()

animals

Actions:

1. define
2. list
3. publicView
4. view
5. getRequireableFields
6. getRequiredFields
7. setRequiredFields
8. getDisableableFields
9. getDisabledFields
10. setDisabledFields
11. getSpecies
12. getEnabledSpecies
13. setEnabledSpecies
14. getPublicableStatuses
15. getPublicStatuses
16. setPublicStatuses
17. publicSearch
18. getSettings
19. updateSettings
20. search
21. add
22. edit
23. addPicture
24. addPictureUrl
25. addVideo
26. addYoutubeUrl
27. pictureReorder
28. videoReorder
29. videoUrlReorder
30. pictures
31. videos
32. youtubeUrls

1. define

Permissions

Public

2. list

Permissions

User permissions required: Volunteer

3. publicView

Permissions

Public

Fields

• animalID: ID (key)

4. view

Permissions

User permissions required: Volunteer

Fields

• animalID: ID (key)

5. getRequireableFields

Permissions

User permissions required: Volunteer

6. getRequiredFields

Permissions

User permissions required: Volunteer

7. setRequiredFields

Permissions

User permissions required: Volunteer

Fields

• fieldlist: Field list (string)

8. getDisableableFields

Permissions

User permissions required: Volunteer

9. getDisabledFields

Permissions

User permissions required: Volunteer

10. setDisabledFields

Permissions

User permissions required: Volunteer

Fields

• fieldlist: Field list (string)

11. getSpecies

Permissions

User permissions required: Volunteer

12. getEnabledSpecies

Permissions

User permissions required: Volunteer

13. setEnabledSpecies

Permissions

User permissions required: Volunteer

Fields

• fieldlist: Field list (string)

14. getPublicableStatuses

Permissions

User permissions required: Volunteer

15. getPublicStatuses

Permissions

User permissions required: Volunteer

16. setPublicStatuses

Permissions

User permissions required: Volunteer

Fields

• statuslist: Statuses (int)

17. publicSearch

Permissions

Public

Fields

• animalID: ID (key)
• animalOrgID: Org ID (key)
• animalActivityLevel: Activity level (string from values list)
• animalAdoptionFee: Adoption fee (string)
• animalAltered: Altered (string from values list)
• animalAvailableDate: Available Date (date)
• animalBirthdate: Birthdate (date)
• animalBirthdateExact: Exact Birthdate (string from values list)
• animalBreed: Breed (string)
• animalCoatLength: Coat Length (string from values list)
• animalColor: Color (string)
• animalColorID: Color (General) (key)
• animalColorDetails: Color details (string)
• animalCourtesy: Courtesy (string from values list)
• animalDeclawed: Declawed (string from values list)
• animalDescription: Description (string)
• animalDescriptionPlain: Description (no html) (string)
• animalDistinguishingMarks: Distinguishing marks (string)
• animalEarType: Ear type (string from values list)
• animalEnergyLevel: Energy level (string from values list)
• animalExerciseNeeds: Exercise needs (string from values list)
• animalEyeColor: Eye color (string from values list)
• animalFence: Requires a home with fence (string from values list)
• animalFound: Found (string from values list)
• animalFoundDate: Found date (date)
• animalFoundPostalcode: Found zip/postal code (postalcode)
• animalGeneralAge: General Age (string from values list)
• animalGeneralSizePotential: Size potential (general) (string from values list)
• animalGroomingNeeds: Grooming needs (string from values list)
• animalHousetrained: Housetrained (string from values list)
• animalIndoorOutdoor: Indoor/Outdoor (string from values list)
• animalKillDate: Euthanasia date (date)
• animalKillReason: Euthanasia reason (string from values list)
• animalLocation: Location (postalcode)
• animalLocationDistance: Distance (int)
• animalLocationCitystate: Distance (int)
• animalMicrochipped: Microchipped (string from values list)
• animalMixedBreed: Mixed breed (string from values list)
• animalName: Name (string)
• animalSpecialneeds: Has special needs (string from values list)
• animalSpecialneedsDescription: Special needs description (string)
• animalNeedsFoster: Needs a Foster (string from values list)
• animalNewPeople: Reaction to new people (string from values list)
• animalNotHousetrainedReason: Reason not housetrained (string)
• animalObedienceTraining: Obedience training (string from values list)
• animalOKWithAdults: Good with adults (string from values list)
• animalOKWithCats: OK with cats (string from values list)
• animalOKWithDogs: OK with dogs (string from values list)
• animalOKWithKids: OK with kids (string from values list)
• animalOwnerExperience: Owner experience needed (string from values list)
• animalPattern: Pattern (string)
• animalPatternID: Pattern ID (key)
• animalAdoptionPending: Adoption pending (string from values list)
• animalPrimaryBreed: Primary breed (string)
• animalPrimaryBreedID: Primary breed ID (key)
• animalRescueID: Rescue ID (string)
• animalSearchString: Search (string)
• animalSecondaryBreed: Secondary Breed (string)
• animalSecondaryBreedID: Secondary Breed ID (key)
• animalSex: Sex (string from values list)
• animalShedding: Shedding amount (string from values list)
• animalSizeCurrent: Current size (decimal)
• animalSizePotential: Size potential (decimal)
• animalSizeUOM: Size unit of measure (string from values list)
• animalSpecies: Species (string)
• animalSpeciesID: Species (key)
• animalSponsorable: Allow sponsorship (string from values list)
• animalSponsors: Sponsors (string)
• animalSponsorshipDetails: Sponsorship details (string)
• animalSponsorshipMinimum: Sponsorship minimum (decimal)
• animalStatus: Status (string)
• animalStatusID: Status ID (key)
• animalSummary: Summary (string)
• animalTailType: Tail type (string from values list)
• animalThumbnailUrl: Thumbnail URL (string)
• animalUptodate: Up-to-date (string from values list)
• animalUpdatedDate: Last updated (date)
• animalUrl: Web page (url)
• animalVocal: Likes to vocalize (string from values list)
• animalYardRequired: Requires a Yard (string from values list)
• animalAffectionate: Affectionate (string from values list)
• animalApartment: Apartment appropriate (string from values list)
• animalCratetrained: Crate trained (string from values list)
• animalDrools: Drools excessively (string from values list)
• animalEagerToPlease: Eager to please (string from values list)
• animalEscapes: Tries to escape (string from values list)
• animalEventempered: Even-tempered (string from values list)
• animalFetches: Likes to fetch (string from values list)
• animalGentle: Gentle (string from values list)
• animalGoodInCar: Does well in a car (string from values list)
• animalGoofy: Goofy (string from values list)
• animalHasAllergies: Has allergies (string from values list)
• animalHearingImpaired: Hearing impaired (string from values list)
• animalHypoallergenic: Hypoallergenic (string from values list)
• animalIndependent: Independent / aloof (string from values list)
• animalIntelligent: Intelligent (string from values list)
• animalLap: Lap pet (string from values list)
• animalLeashtrained: Leash trained (string from values list)
• animalNeedsCompanionAnimal: Needs companion animal (string from values list)
• animalNoCold: Cold sensitive (string from values list)
• animalNoFemaleDogs: Not good with female dogs (string from values list)
• animalNoHeat: Heat sensitive (string from values list)
• animalNoLargeDogs: Not good with large dogs (string from values list)
• animalNoMaleDogs: Not good with male dogs (string from values list)
• animalNoSmallDogs: Not good with small dogs (string from values list)
• animalObedient: Obedient (string from values list)
• animalOKForSeniors: Good for seniors / elderly (string from values list)
• animalOKWithFarmAnimals: Good with farm animals (string from values list)
• animalOlderKidsOnly: Older/ considerate kids only (string from values list)
• animalOngoingMedical: Needs ongoing medical care (string from values list)
• animalPlayful: Playful (string from values list)
• animalPlaysToys: Likes toys (string from values list)
• animalPredatory: Predatory (string from values list)
• animalProtective: Protective / territorial (string from values list)
• animalSightImpaired: Sight impaired (string from values list)
• animalSkittish: Skittish (string from values list)
• animalSpecialDiet: Special diet required (string from values list)
• animalSwims: Likes to swim (string from values list)
• animalTimid: Timid / shy (string from values list)
• fosterEmail: Email (string)
• fosterFirstname: First Name (string)
• fosterLastname: Last Name (string)
• fosterName: Foster (string)
• fosterPhoneCell: Phone (Cell) (string)
• fosterPhoneHome: Phone (Home) (string)
• fosterSalutation: Salutation (string)
• locationAddress: Address (string)
• locationCity: City (string)
• locationCountry: Country (string)
• locationUrl: Link (string)
• locationName: Location (enumLookup)
• locationPhone: Phone (string)
• locationState: State (string)
• locationPostalcode: Postal Code (postalcode)
• animalPictures: Pictures (string)
• animalVideos: Videos (string)
• animalVideoUrls: Video URLs (string)

18. getSettings

Permissions

User permissions required: OptionsAdmin

19. updateSettings

Permissions

User permissions required: OptionsAdmin

Fields

• enableAnimalsSpecialListBabies: Babies (Kittens, Puppies) enabled (string from values list)
• setAnimalsSpecialListBabiesYoungest: Babies (Kittens, Puppies) Youngest Age (int)
• setAnimalsSpecialListBabiesOldest: Babies (Kittens, Puppies) Oldest Age (int)
• enableAnimalsSpecialListTeens: Teens enabled (string from values list)
• setAnimalsSpecialListTeensYoungest: Teens Youngest Age (int)
• setAnimalsSpecialListTeensOldest: Teens Oldest Age (int)
• enableAnimalsSpecialListAdults: Adults enabled (string from values list)
• setAnimalsSpecialListAdultsYoungest: Adults Youngest Age (int)
• setAnimalsSpecialListAdultsOldest: Adults Oldest Age (int)
• enableAnimalsSpecialListSeniors: Seniors enabled (string from values list)
• setAnimalsSpecialListSeniorsYoungest: Seniors Youngest Age (int)
• enableAnimalsSpecialListLongtime: Long Time/Must Adopt enabled (string from values list)
• setAnimalsSpecialListLongtimeYoungest: Long Time/Must Adopt Shortest length of time (int)
• setAnimalsSpecialListLongtimeOldest: Long Time/Must Adopt Longest length of time (int)
• enableAnimalsSpecialListRecent: Recent Arrivals enabled (string from values list)
• setAnimalsSpecialListRecentDays: Recent Arrivals Shortest length of time (int)
• enableAnimalsSpecialListSpecialNeeds: Special Needs enabled (string from values list)
• enableAnimalsSpecialListUrgent: Urgent enabled (string from values list)
• enableAnimalsSpecialListFoster: Needs a Caretaker/Foster enabled (string from values list)
• enableAnimalsSpecialListCourtesy: Courtesy Listings enabled (string from values list)
• enableAnimalAutoRescueID: Automatically set animal's Rescue ID (string from values list)
• setAnimalAutoRescueIDFormat: Format for Rescue IDs (string from values list)
• disableAnimalAutoRescueIDCourtesyListings: Do not automatically assign Rescue ID for courtesy listings (string from values list)
• showAnimalMicrochip: Show if the animal is microchipped (string from values list)
• showAnimalAltered: Show if the animal is altered (string from values list)
• showAnimalWillBeAltered: Show if the animal will be altered before adoption (string from values list)
• showAnimalRescueID: Show the animal's Rescue ID (string from values list)
• showAnimalAdoptionFee: Show the animal's adoption fee (string from values list)
• showAnimalEuthanasiaInfo: Show the animal's euthanasia information (string from values list)
• disableAnimalCourtesyHeaderFooter: Disable the animal header/footer to courtesy animals (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)
• disableAnimalExportAdopted: Prevent adopted animals from being uploaded to Petfinder (string from values list)
• enableExportAdoptedToAdoptapet: Export adopted pets to Adopt-a-Pet.com (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)
• setAnimalExportYouTubeAuthorizationCode: YouTube authorization code (string)
• 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)
• 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)
• enableFreePetChipRegistry: Enable FreePetChipRegistry registrations (string from values list)
• setFreePetChipRegistryUserName: FreePetChipRegistry user name (string)
• disableMicrochipUserAlert: Disable the email alert to the volunteer concerning microchip registration (success or failure) (string from values list)
• setMicrochipAlertEmails: Email address(es) to alert concerning microchip registration (success or failure) (string)

20. search

Permissions

User permissions required: Volunteer

Fields

• animalID: ID (key)
• animalActivityLevel: Activity level (string from values list)
• animalAdoptedDate: Adopted date (date)
• animalAdoptionFee: Adoption fee (string)
• animalAdoptionLead: Adoption lead (string)
• animalAdoptionLeadID: Adoption lead ID (key)
• animalAltered: Altered (string from values list)
• animalApplicationID: Application ID (key)
• animalAvailableDate: Available Date (date)
• animalBirthdate: Birthdate (date)
• animalBirthdateExact: Exact Birthdate (string from values list)
• animalBreed: Breed (string)
• animalCoatLength: Coat Length (string from values list)
• animalColonyID: Colony ID (key)
• animalColor: Color (string)
• animalColorID: Color (General) (key)
• animalColorDetails: Color details (string)
• animalCondition: Condition (string)
• animalConditionID: Condition ID (key)
• animalCost: Cost (string)
• animalCourtesy: Courtesy (string from values list)
• animalCreatedDate: Created (datetime)
• animalCreatedBy: Created by (string)
• animalCreatedByID: Created by ID (key)
• animalCreatedTimeframe: Created time frame (int)
• animalDaysInFoster: Days in Foster (int)
• animalDeclawed: Declawed (string from values list)
• animalDescription: Description (string)
• animalDescriptionPlain: Description (no html) (string)
• animalDistinguishingMarks: Distinguishing marks (string)
• animalAllowExport: Allow export (string from values list)
• animalEarType: Ear type (string from values list)
• animalEnergyLevel: Energy level (string from values list)
• animalExerciseNeeds: Exercise needs (string from values list)
• animalEyeColor: Eye color (string from values list)
• animalFence: Requires a home with fence (string from values list)
• animalFosterID: Foster ID (key)
• animalFound: Found (string from values list)
• animalFoundDate: Found date (date)
• animalFoundPostalcode: Found zip/postal code (postalcode)
• animalGeneralAge: General Age (string from values list)
• animalGeneralSizePotential: Size potential (general) (string from values list)
• animalGroomingNeeds: Grooming needs (string from values list)
• animalHighlightOrder: Highlight (int)
• animalHousetrained: Housetrained (string from values list)
• animalIndoorOutdoor: Indoor/Outdoor (string from values list)
• animalIntakes: Intakes (int)
• animalInternalID: Internal ID (string)
• animalKillDate: Euthanasia date (date)
• animalKillReason: Euthanasia reason (string from values list)
• animalUpdatedBy: Updated by (string)
• animalUpdatedByID: Updated by ID (key)
• animalUpdatedDate: Last updated (date)
• animalUpdatedTimeframe: Updated timeframe (int)
• animalLocationID: Location ID (key)
• animalLocationPublic: Location public (string from values list)
• animalMicrochipped: Microchipped (string from values list)
• animalMicrochipNumber: Microchip number (string)
• animalMicrochipVendor: Microchip vendor (key)
• animalMixedBreed: Mixed breed (string from values list)
• animalName: Name (string)
• animalSpecialneeds: Has special needs (string from values list)
• animalSpecialneedsDescription: Special needs description (string)
• animalNeedsFoster: Needs a Foster (string from values list)
• animalNewPeople: Reaction to new people (string from values list)
• animalNotes: Private notes (string)
• animalNotHousetrainedReason: Reason not housetrained (string)
• animalObedienceTraining: Obedience training (string from values list)
• animalOKWithAdults: Good with adults (string from values list)
• animalOKWithCats: OK with cats (string from values list)
• animalOKWithDogs: OK with dogs (string from values list)
• animalOKWithKids: OK with kids (string from values list)
• animalOpenIntakes: Open Intakes (int)
• animalOrigin: Origin (string)
• animalOthernames: Other names (string)
• animalOutcomes: Outcomes (int)
• animalOwnerExperience: Owner experience needed (string from values list)
• animalOwnerID: Owner ID (key)
• animalPattern: Pattern (string)
• animalPatternID: Pattern ID (key)
• animalAdoptionPending: Adoption pending (string from values list)
• animalPrimaryBreed: Primary breed (string)
• animalPrimaryBreedID: Primary breed ID (key)
• animalReceivedDate: Received date (date)
• animalRescueID: Rescue ID (string)
• animalSecondaryBreed: Secondary Breed (string)
• animalSecondaryBreedID: Secondary Breed ID (key)
• animalSex: Sex (string from values list)
• animalShared: Shared (string from values list)
• animalShedding: Shedding amount (string from values list)
• animalSizeCurrent: Current size (decimal)
• animalSizePotential: Size potential (decimal)
• animalSizeUOM: Size unit of measure (string from values list)
• animalSpecies: Species (string)
• animalSpeciesID: Species (key)
• animalSponsorable: Allow sponsorship (string from values list)
• animalSponsors: Sponsors (string)
• animalSponsorshipDetails: Sponsorship details (string)
• animalSponsorshipMinimum: Sponsorship minimum (decimal)
• animalStatus: Status (string)
• animalStatusID: Status ID (key)
• animalSummary: Summary (string)
• animalTailType: Tail type (string from values list)
• animalTransferredToID: Transferred to ID (key)
• animalUptodate: Up-to-date (string from values list)
• animalVocal: Likes to vocalize (string from values list)
• animalYardRequired: Requires a Yard (string from values list)
• animalAffectionate: Affectionate (string from values list)
• animalApartment: Apartment appropriate (string from values list)
• animalCratetrained: Crate trained (string from values list)
• animalDrools: Drools excessively (string from values list)
• animalEagerToPlease: Eager to please (string from values list)
• animalEscapes: Tries to escape (string from values list)
• animalEventempered: Even-tempered (string from values list)
• animalFetches: Likes to fetch (string from values list)
• animalGentle: Gentle (string from values list)
• animalGoodInCar: Does well in a car (string from values list)
• animalGoofy: Goofy (string from values list)
• animalHasAllergies: Has allergies (string from values list)
• animalHearingImpaired: Hearing impaired (string from values list)
• animalHypoallergenic: Hypoallergenic (string from values list)
• animalIndependent: Independent / aloof (string from values list)
• animalIntelligent: Intelligent (string from values list)
• animalLap: Lap pet (string from values list)
• animalLeashtrained: Leash trained (string from values list)
• animalNeedsCompanionAnimal: Needs companion animal (string from values list)
• animalNoCold: Cold sensitive (string from values list)
• animalNoFemaleDogs: Not good with female dogs (string from values list)
• animalNoHeat: Heat sensitive (string from values list)
• animalNoLargeDogs: Not good with large dogs (string from values list)
• animalNoMaleDogs: Not good with male dogs (string from values list)
• animalNoSmallDogs: Not good with small dogs (string from values list)
• animalObedient: Obedient (string from values list)
• animalOKForSeniors: Good for seniors / elderly (string from values list)
• animalOKWithFarmAnimals: Good with farm animals (string from values list)
• animalOlderKidsOnly: Older/ considerate kids only (string from values list)
• animalOngoingMedical: Needs ongoing medical care (string from values list)
• animalPlayful: Playful (string from values list)
• animalPlaysToys: Likes toys (string from values list)
• animalPredatory: Predatory (string from values list)
• animalProtective: Protective / territorial (string from values list)
• animalSightImpaired: Sight impaired (string from values list)
• animalSkittish: Skittish (string from values list)
• animalSpecialDiet: Special diet required (string from values list)
• animalSwims: Likes to swim (string from values list)
• animalTimid: Timid / shy (string from values list)
• ownerID: Owner ID (key)
• ownerActive: Active (string from values list)
• ownerAddress: Address (string)
• ownerBounces: Bounced Emails (string)
• ownerCarrier: Carrier (string)
• ownerCity: City (string)
• ownerComment: Comment (string)
• ownerCompany: Company (string)
• ownerCountry: Country (string)
• ownerCounty: County (string)
• ownerEmail: Email (string)
• ownerEmailAlt: Email (Alternate) (string)
• ownerEmailPager: Email (Text/Pager) (string)
• ownerFax: Fax (string)
• ownerFirstname: First Name (string)
• ownerLastname: Last Name (string)
• ownerName: Name (string)
• ownerPhoneCell: Phone (Cell) (string)
• ownerPhoneHome: Phone (Home) (string)
• ownerPhoneWork: Phone (Work) (string)
• ownerPhoneWorkExt: Phone Extension (Work) (string)
• ownerPlus4: Plus4 (string)
• ownerReferredBy: Referred By (string)
• ownerSalutation: Salutation (string)
• ownerSendMail: Send Mail (string from values list)
• ownerState: State (string)
• ownerTitle: Title (string)
• ownerPostalcode: Zip/Postal Code (string)
• colonyAnimals: Animals (string)
• colonyCaretakers: Caretakers (string)
• colonyLocation: Location (string)
• colonyLocationID: Location (key)
• colonyName: Colony (string)
• colonyRegisteredDate: Registered (date)
• colonySpecificLocation: Specific Location (string)
• fosterID: Foster ID (key)
• fosterActive: Active (string from values list)
• fosterAddress: Address (string)
• fosterBounces: Bounced Emails (string)
• fosterCarrier: Carrier (string)
• fosterCity: City (string)
• fosterComment: Comment (string)
• fosterCompany: Company (string)
• fosterCountry: Country (string)
• fosterCounty: County (string)
• fosterEmail: Email (string)
• fosterEmailAlt: Email (Alternate) (string)
• fosterEmailPager: Email (Text/Pager) (string)
• fosterFax: Fax (string)
• fosterFirstname: First Name (string)
• fosterLastname: Last Name (string)
• fosterName: Foster (string)
• fosterPhoneCell: Phone (Cell) (string)
• fosterPhoneHome: Phone (Home) (string)
• fosterPhoneWork: Phone (Work) (string)
• fosterPhoneWorkExt: Phone Extension (Work) (string)
• fosterPlus4: Plus4 (string)
• fosterReferredBy: Referred By (string)
• fosterSalutation: Salutation (string)
• fosterSendMail: Send Mail (string from values list)
• fosterState: State (string)
• fosterTitle: Title (string)
• fosterPostalcode: Zip/Postal Code (string)
• locationAddress: Address (string)
• locationAnimals: Animals (string)
• locationCity: City (string)
• locationColonies: Colonies (string)
• locationCountry: Country (string)
• locationUrl: Link (string)
• locationEvents: Events (string)
• locationMeetrequests: Meet Requests (string)
• locationName: Location (enumLookup)
• locationPhone: Phone (string)
• locationState: State (string)
• locationPostalcode: Postal Code (string)
• submittedformID: Form ID (string)
• submittedformAnimalID: Animal (string)
• submittedformAssignedToID: Assigned To (string)
• submittedformCommentsCount: Comments (int)
• submittedformCommentsInline: Comments (inline) (string)
• submittedformCompletedDate: Submitted (date)
• submittedformFormName: Form (string)
• submittedformPending: Open (string from values list)
• submittedformStatus: Status (enumLookup)
• submittedformStepsCount: Steps (int)
• submitterID: Submitter ID (key)
• submitterActive: Active (string from values list)
• submitterAddress: Address (string)
• submitterBounces: Bounced Emails (string)
• submitterCarrier: Carrier (string)
• submitterCity: City (string)
• submitterComment: Comment (string)
• submitterCompany: Company (string)
• submitterCountry: Country (string)
• submitterCounty: County (string)
• submitterEmail: Email (string)
• submitterEmailAlt: Email (Alternate) (string)
• submitterEmailPager: Email (Text/Pager) (string)
• submitterFax: Fax (string)
• submitterFirstname: First Name (string)
• submitterLastname: Last Name (string)
• submitterName: Name (string)
• submitterPhoneCell: Phone (Cell) (string)
• submitterPhoneHome: Phone (Home) (string)
• submitterPhoneWork: Phone (Work) (string)
• submitterPhoneWorkExt: Phone Extension (Work) (string)
• submitterPlus4: Plus4 (string)
• submitterReferredBy: Referred By (string)
• submitterSalutation: Salutation (string)
• submitterSendMail: Send Mail (string from values list)
• submitterState: State (string)
• submitterTitle: Title (string)
• submitterPostalcode: Zip/Postal Code (string)
• transferredtoActive: Active (string from values list)
• transferredtoAddress: Address (string)
• transferredtoBounces: Bounced Emails (string)
• transferredtoCarrier: Carrier (string)
• transferredtoCity: City (string)
• transferredtoComment: Comment (string)
• transferredtoCompany: Company (string)
• transferredtoID: Transferred To ID (string)
• transferredtoCountry: Country (string)
• transferredtoCounty: County (string)
• transferredtoEmail: Email (string)
• transferredtoEmailAlt: Email (Alternate) (string)
• transferredtoEmailPager: Email (Text/Pager) (string)
• transferredtoFax: Fax (string)
• transferredtoFirstname: First Name (string)
• transferredtoLastname: Last Name (string)
• transferredtoName: Transferred to Name (string)
• transferredtoPhoneCell: Phone (Cell) (string)
• transferredtoPhoneHome: Phone (Home) (string)
• transferredtoPhoneWork: Phone (Work) (string)
• transferredtoPhoneWorkExt: Phone Extension (Work) (string)
• transferredtoPlus4: Plus4 (string)
• transferredtoReferredBy: Referred By (string)
• transferredtoSalutation: Salutation (string)
• transferredtoSendMail: Send Mail (string from values list)
• transferredtoState: State (string)
• transferredtoTitle: Title (string)
• transferredtoPostalcode: Zip/Postal Code (string)
• animalGroups: Groups (key)
• animalExportAccounts: Export accounts (key)
• animalPictures: Pictures (string)

21. add

Permissions

User permissions required: AnimalAdd

Fields

• animalActivityLevel: Activity level (string from values list)
• animalAdoptedDate: Adopted date (date)
• animalAdoptionFee: Adoption fee (string)
• animalAdoptionLeadID: Adoption lead (key)
• animalAltered: Altered (string from values list)
• animalApplicationID: Application (key)
• animalAvailableDate: Available Date (date)
• animalBirthdate: Birthdate (date)
• animalBirthdateExact: Exact Birthdate (string from values list)
• animalCoatLength: Coat Length (string from values list)
• animalColonyID: Colony (key)
• animalColorID: Color (General) (key)
• animalColorDetails: Color details (string)
• animalConditionID: Condition (key)
• animalCourtesy: Courtesy (string from values list)
• animalDeclawed: Declawed (string from values list)
• animalDescription: Description (string)
• animalDistinguishingMarks: Distinguishing marks (string)
• animalAllowExport: Allow export (string from values list)
• animalEarType: Ear type (string from values list)
• animalEnergyLevel: Energy level (string from values list)
• animalExerciseNeeds: Exercise needs (string from values list)
• animalEyeColor: Eye color (string from values list)
• animalFence: Requires a home with fence (string from values list)
• animalFosterID: Foster (key)
• animalFound: Found (string from values list)
• animalFoundDate: Found date (date)
• animalFoundPostalcode: Found zip/postal code (postalcode)
• animalGeneralAge: General Age (string from values list)
• animalGeneralSizePotential: Size potential (general) (string from values list)
• animalGroomingNeeds: Grooming needs (string from values list)
• animalHighlightOrder: Highlight (int)
• animalHousetrained: Housetrained (string from values list)
• animalIndoorOutdoor: Indoor/Outdoor (string from values list)
• animalInternalID: Internal ID (string)
• animalKillDate: Euthanasia date (date)
• animalKillReason: Euthanasia reason (string from values list)
• animalLocationID: Location (key)
• animalLocationPublic: Location public (string from values list)
• animalMicrochipNumber: Microchip number (string)
• animalMicrochipVendor: Microchip vendor (key)
• animalMixedBreed: Mixed breed (string from values list)
• animalName: Name (string)
• animalSpecialneeds: Has special needs (string from values list)
• animalSpecialneedsDescription: Special needs description (string)
• animalNeedsFoster: Needs a Foster (string from values list)
• animalNewPeople: Reaction to new people (string from values list)
• animalNotes: Private notes (string)
• animalNotHousetrainedReason: Reason not housetrained (string)
• animalObedienceTraining: Obedience training (string from values list)
• animalOKWithAdults: Good with adults (string from values list)
• animalOKWithCats: OK with cats (string from values list)
• animalOKWithDogs: OK with dogs (string from values list)
• animalOKWithKids: OK with kids (string from values list)
• animalOrigin: Origin (string)
• animalOthernames: Other names (string)
• animalOwnerExperience: Owner experience needed (string from values list)
• animalOwnerID: Owner (key)
• animalPatternID: Pattern (key)
• animalAdoptionPending: Adoption pending (string from values list)
• animalPrimaryBreedID: Primary breed (key)
• animalReceivedDate: Received date (date)
• animalRescueID: Rescue ID (string)
• animalSecondaryBreedID: Secondary breed (key)
• animalSex: Sex (string from values list)
• animalShared: Shared (string from values list)
• animalShedding: Shedding amount (string from values list)
• animalSizeCurrent: Current size (decimal)
• animalSizePotential: Size potential (decimal)
• animalSizeUOM: Size unit of measure (string from values list)
• animalSpeciesID: Species (key)
• animalSponsorable: Allow sponsorship (string from values list)
• animalSponsors: Sponsors (string)
• animalSponsorshipDetails: Sponsorship details (string)
• animalSponsorshipMinimum: Sponsorship minimum (decimal)
• animalStatusID: Status (key)
• animalSummary: Summary (string)
• animalTailType: Tail type (string from values list)
• animalTransferredToID: Transferred to rescue (key)
• animalUptodate: Up-to-date (string from values list)
• animalVocal: Likes to vocalize (string from values list)
• animalYardRequired: Requires a Yard (string from values list)
• animalAffectionate: Affectionate (string from values list)
• animalApartment: Apartment appropriate (string from values list)
• animalCratetrained: Crate trained (string from values list)
• animalDrools: Drools excessively (string from values list)
• animalEagerToPlease: Eager to please (string from values list)
• animalEscapes: Tries to escape (string from values list)
• animalEventempered: Even-tempered (string from values list)
• animalFetches: Likes to fetch (string from values list)
• animalGentle: Gentle (string from values list)
• animalGoodInCar: Does well in a car (string from values list)
• animalGoofy: Goofy (string from values list)
• animalHasAllergies: Has allergies (string from values list)
• animalHearingImpaired: Hearing impaired (string from values list)
• animalHypoallergenic: Hypoallergenic (string from values list)
• animalIndependent: Independent / aloof (string from values list)
• animalIntelligent: Intelligent (string from values list)
• animalLap: Lap pet (string from values list)
• animalLeashtrained: Leash trained (string from values list)
• animalNeedsCompanionAnimal: Needs companion animal (string from values list)
• animalNoCold: Cold sensitive (string from values list)
• animalNoFemaleDogs: Not good with female dogs (string from values list)
• animalNoHeat: Heat sensitive (string from values list)
• animalNoLargeDogs: Not good with large dogs (string from values list)
• animalNoMaleDogs: Not good with male dogs (string from values list)
• animalNoSmallDogs: Not good with small dogs (string from values list)
• animalObedient: Obedient (string from values list)
• animalOKForSeniors: Good for seniors / elderly (string from values list)
• animalOKWithFarmAnimals: Good with farm animals (string from values list)
• animalOlderKidsOnly: Older/ considerate kids only (string from values list)
• animalOngoingMedical: Needs ongoing medical care (string from values list)
• animalPlayful: Playful (string from values list)
• animalPlaysToys: Likes toys (string from values list)
• animalPredatory: Predatory (string from values list)
• animalProtective: Protective / territorial (string from values list)
• animalSightImpaired: Sight impaired (string from values list)
• animalSkittish: Skittish (string from values list)
• animalSpecialDiet: Special diet required (string from values list)
• animalSwims: Likes to swim (string from values list)
• animalTimid: Timid / shy (string from values list)
• animalGroups: Groups (key)
• animalExportAccounts: Export accounts (key)

22. edit

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)
• animalActivityLevel: Activity level (string from values list)
• animalAdoptedDate: Adopted date (date)
• animalAdoptionFee: Adoption fee (string)
• animalAdoptionLeadID: Adoption lead (key)
• animalAltered: Altered (string from values list)
• animalApplicationID: Application (key)
• animalAvailableDate: Available Date (date)
• animalBirthdate: Birthdate (date)
• animalBirthdateExact: Exact Birthdate (string from values list)
• animalCoatLength: Coat Length (string from values list)
• animalColonyID: Colony (key)
• animalColorID: Color (General) (key)
• animalColorDetails: Color details (string)
• animalConditionID: Condition (key)
• animalCourtesy: Courtesy (string from values list)
• animalDeclawed: Declawed (string from values list)
• animalDescription: Description (string)
• animalDistinguishingMarks: Distinguishing marks (string)
• animalAllowExport: Allow export (string from values list)
• animalEarType: Ear type (string from values list)
• animalEnergyLevel: Energy level (string from values list)
• animalExerciseNeeds: Exercise needs (string from values list)
• animalEyeColor: Eye color (string from values list)
• animalFence: Requires a home with fence (string from values list)
• animalFosterID: Foster (key)
• animalFound: Found (string from values list)
• animalFoundDate: Found date (date)
• animalFoundPostalcode: Found zip/postal code (postalcode)
• animalGeneralAge: General Age (string from values list)
• animalGeneralSizePotential: Size potential (general) (string from values list)
• animalGroomingNeeds: Grooming needs (string from values list)
• animalHighlightOrder: Highlight (int)
• animalHousetrained: Housetrained (string from values list)
• animalIndoorOutdoor: Indoor/Outdoor (string from values list)
• animalInternalID: Internal ID (string)
• animalKillDate: Euthanasia date (date)
• animalKillReason: Euthanasia reason (string from values list)
• animalLocationID: Location (key)
• animalLocationPublic: Location public (string from values list)
• animalMicrochipNumber: Microchip number (string)
• animalMicrochipVendor: Microchip vendor (key)
• animalMixedBreed: Mixed breed (string from values list)
• animalName: Name (string)
• animalSpecialneeds: Has special needs (string from values list)
• animalSpecialneedsDescription: Special needs description (string)
• animalNeedsFoster: Needs a Foster (string from values list)
• animalNewPeople: Reaction to new people (string from values list)
• animalNotes: Private notes (string)
• animalNotHousetrainedReason: Reason not housetrained (string)
• animalObedienceTraining: Obedience training (string from values list)
• animalOKWithAdults: Good with adults (string from values list)
• animalOKWithCats: OK with cats (string from values list)
• animalOKWithDogs: OK with dogs (string from values list)
• animalOKWithKids: OK with kids (string from values list)
• animalOrigin: Origin (string)
• animalOthernames: Other names (string)
• animalOwnerExperience: Owner experience needed (string from values list)
• animalOwnerID: Owner (key)
• animalPatternID: Pattern (key)
• animalAdoptionPending: Adoption pending (string from values list)
• animalPrimaryBreedID: Primary breed (key)
• animalReceivedDate: Received date (date)
• animalRescueID: Rescue ID (string)
• animalSecondaryBreedID: Secondary Breed (key)
• animalSex: Sex (string from values list)
• animalShared: Shared (string from values list)
• animalShedding: Shedding amount (string from values list)
• animalSizeCurrent: Current size (decimal)
• animalSizePotential: Size potential (decimal)
• animalSizeUOM: Size unit of measure (string from values list)
• animalSpeciesID: Species (key)
• animalSponsorable: Allow sponsorship (string from values list)
• animalSponsors: Sponsors (string)
• animalSponsorshipDetails: Sponsorship details (string)
• animalSponsorshipMinimum: Sponsorship minimum (decimal)
• animalStatusID: Status (key)
• animalSummary: Summary (string)
• animalTailType: Tail type (string from values list)
• animalTransferredToID: Transferred to rescue (key)
• animalUptodate: Up-to-date (string from values list)
• animalVocal: Likes to vocalize (string from values list)
• animalYardRequired: Requires a Yard (string from values list)
• animalAffectionate: Affectionate (string from values list)
• animalApartment: Apartment appropriate (string from values list)
• animalCratetrained: Crate trained (string from values list)
• animalDrools: Drools excessively (string from values list)
• animalEagerToPlease: Eager to please (string from values list)
• animalEscapes: Tries to escape (string from values list)
• animalEventempered: Even-tempered (string from values list)
• animalFetches: Likes to fetch (string from values list)
• animalGentle: Gentle (string from values list)
• animalGoodInCar: Does well in a car (string from values list)
• animalGoofy: Goofy (string from values list)
• animalHasAllergies: Has allergies (string from values list)
• animalHearingImpaired: Hearing impaired (string from values list)
• animalHypoallergenic: Hypoallergenic (string from values list)
• animalIndependent: Independent / aloof (string from values list)
• animalIntelligent: Intelligent (string from values list)
• animalLap: Lap pet (string from values list)
• animalLeashtrained: Leash trained (string from values list)
• animalNeedsCompanionAnimal: Needs companion animal (string from values list)
• animalNoCold: Cold sensitive (string from values list)
• animalNoFemaleDogs: Not good with female dogs (string from values list)
• animalNoHeat: Heat sensitive (string from values list)
• animalNoLargeDogs: Not good with large dogs (string from values list)
• animalNoMaleDogs: Not good with male dogs (string from values list)
• animalNoSmallDogs: Not good with small dogs (string from values list)
• animalObedient: Obedient (string from values list)
• animalOKForSeniors: Good for seniors / elderly (string from values list)
• animalOKWithFarmAnimals: Good with farm animals (string from values list)
• animalOlderKidsOnly: Older/ considerate kids only (string from values list)
• animalOngoingMedical: Needs ongoing medical care (string from values list)
• animalPlayful: Playful (string from values list)
• animalPlaysToys: Likes toys (string from values list)
• animalPredatory: Predatory (string from values list)
• animalProtective: Protective / territorial (string from values list)
• animalSightImpaired: Sight impaired (string from values list)
• animalSkittish: Skittish (string from values list)
• animalSpecialDiet: Special diet required (string from values list)
• animalSwims: Likes to swim (string from values list)
• animalTimid: Timid / shy (string from values list)
• animalGroups: Groups (key)
• animalExportAccounts: Export accounts (key)

23. addPicture

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)
• pictureBinary: Picture (binary)
• fileName: File name (string)
• mediaOrder: Order (int)

24. addPictureUrl

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)
• pictureUrl: Picture Url (url)
• mediaOrder: Order (int)

25. addVideo

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)
• videoBinary: Video (binary)
• fileName: File name (string)
• mediaOrder: Order (int)

26. addYoutubeUrl

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)
• youtubeUrl: YouTube Url (url)
• mediaOrder: Order (int)

27. pictureReorder

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)
• mediaID: ID (key)
• newOrder: Order (int)

28. videoReorder

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)
• mediaID: ID (key)
• newOrder: Order (int)

29. videoUrlReorder

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)
• mediaID: ID (key)
• newOrder: Order (int)

30. pictures

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)

31. videos

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)

32. youtubeUrls

Permissions

User permissions required: AnimalFosterUpdate

Fields

• animalID: ID (key)

animalBreeds

Actions:

1. define
2. publicList
3. list
4. search

1. define

Permissions

Public

2. publicList

Permissions

Public

Fields

• animalBreeds: Animal Breeds (string)

3. list

Permissions

User permissions required: Volunteer

Fields

• animalBreeds: Animal Breeds (string)

4. search

Permissions

User permissions required: Volunteer

Fields

• breedID: ID (key)
• species: Species (string)
• breedName: Breed Name (string)

animalColors

Actions:

1. define
2. publicList
3. list

1. define

Permissions

Public

2. publicList

Permissions

Public

Fields

• animalColors: Color (string)

3. list

Permissions

User permissions required: Volunteer

Fields

• animalColors: Color (string)

animalConditions

Actions:

1. define
2. list

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• conditions: Condition (string)

animalExportAccounts

Actions:

1. define
2. list

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• account: Export Account (string)

animalFiles

Actions:

1. define
2. list
3. search
4. view
5. add
6. edit

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

Fields

• animalfile: File (string)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• animalfileID: File ID (key)
• animalfileAnimalID: ID (key)
• animalfileOldName: Old file name (string)
• animalfileDescription: Description (string)
• animalfileStatus: Status (string from values list)
• animalfileDisplayInline: Inline (string from values list)
• animalfilePublic: Public (string from values list)
• animalfileSize: File size (int)
• animalfileCreatedDate: Created Date (date)

4. view

Permissions

User permissions required: AnimalAdd

Fields

• animalfileID: File ID (key)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• animalfileAnimalID: Animal (key)
• animalfileBinary: File (binary)
• animalfileOldFileName: Old file name (string)
• animalfileDescription: Description (string)
• animalfileStatus: Status (string from values list)
• animalfileDisplayInline: Inline (string from values list)
• animalfilePublic: Public (string from values list)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• animalfileID: File ID (key)
• animalfileAnimalID: ID (key)
• animalfileDescription: Description (string)
• animalfileStatus: Status (string from values list)
• animalfileDisplayInline: Inline (string from values list)
• animalfilePublic: Public (string from values list)

animalGroups

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• group: Group (string)

3. view

Permissions

User permissions required: Volunteer

Fields

• groupID: ID (key)

4. search

Permissions

User permissions required: Volunteer

Fields

• groupID: ID (key)
• groupName: Name (string)
• groupHeaderID: Header (key)
• groupAnimals: Animals (int)
• webpageName: Name (string)

5. add

Permissions

User permissions required: AnimalAdmin

Fields

• groupName: Name (string)
• groupHeaderID: Header (key)

6. edit

Permissions

User permissions required: AnimalAdmin

Fields

• groupID: ID (key)
• groupName: Name (string)
• groupHeaderID: Header (key)

7. delete

Permissions

User permissions required: AnimalAdmin

Fields

• groupID: ID (key)

animalsAdoptions

Actions:

1. define
2. list
3. search
4. view
5. add
6. edit
7. delete
8. getSettings
9. updateSettings

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. search

Permissions

User permissions required: AnimalAdd

Fields

• adoptionID: Adoption ID (key)
• adoptionAnimalID: Animal ID (key)
• adoptionAdopterID: Adopter ID (key)
• adoptionLeadID: Lead ID (key)
• adoptionLead: Lead (string)
• adoptionFeeAmount: Fee (decimal)
• adoptionDonationAmount: Donation (decimal)
• adoptionDonationID: Donation ID (key)
• adoptionDate: Date (date)
• adoptionStatusID: Status ID (key)
• adoptionStatus: Status (string)
• adoptionLetterSent: Thank you letter sent (string from values list)
• adoptionSubmittedformID: Submitted form ID (key)
• animalCost: Cost (string)
• animalName: Animal Name (string)
• animalFosterID: Foster ID (key)
• animalFosterName: Foster Name (string)
• adopterName: Adopter Name (string)
• adopterType: Adopter Type (string)
• submitterName: Submitter Name (string)

4. view

Permissions

User permissions required: AnimalAdd

Fields

• adoptionID: Adoption ID (key)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• adoptionAnimalID: Animal (key)
• adoptionAdopterID: Adopter (key)
• adoptionLeadID: Lead (key)
• adoptionFeeAmount: Fee (decimal)
• adoptionDonationAmount: Donation (decimal)
• adoptionDonationID: Donation ID (key)
• adoptionDate: Date (date)
• adoptionSubmittedformID: Submitted form (key)
• adoptionStatusID: Status (key)
• adoptionLetterSent: Thank you letter sent (string from values list)
• adoptionAddAdopterRole: Add contact to adopters group (string from values list)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• adoptionID: Adoption ID (key)
• adoptionAnimalID: Animal ID (key)
• adoptionAdopterID: Adopter ID (key)
• adoptionLeadID: Lead (key)
• adoptionFeeAmount: Fee (decimal)
• adoptionDonationAmount: Donation (decimal)
• adoptionDonationID: Donation ID (key)
• adoptionDate: Date (date)
• adoptionSubmittedformID: Submitted form (key)
• adoptionStatusID: Status (key)
• adoptionLetterSent: Thank you letter sent (string from values list)

7. delete

Permissions

User permissions required: AnimalAdd

Fields

• adoptionID: Adoption ID (key)
• adoptionRemoveContact: Remove contact from adopters group (string from values list)
• adoptionChangeAnimal: Change animal to available (string from values list)
• adoptionChangeSubmittedform: Change submitted form to cancelled (string from values list)
• adoptionRemoveUser: Remove Adopter role from user (string from values list)
• adoptionDonationAmount: Modified donation amount (decimal)
• adoptionLetterSent: Thank you letter sent (string from values list)

8. getSettings

Permissions

User permissions required: AnimalAdd

9. updateSettings

Permissions

User permissions required: AnimalAdd

Fields

• showAdoptionsTrackingMessage: Show a reminder to use the Adoptions feature when changing an animal's status to Adopted (string from values list)
• showAppPending: Show an "Application Pending" message on public pages for animals when applicable (string from values list)
• showAppPendingAdoptAnyway: Show an "Apply anyway" message on public pages for animals when applicable (string from values list)
• preventApplicationsForPendingAnimals: Prevent applications from being submitted for animals with a pending application (string from values list)

animalsJournalCategories

Actions:

1. define
2. list

1. define

Permissions

User permissions required: JournalUser

2. list

Permissions

User permissions required: JournalUser

Fields

• categories: Category (string)

animalsJournalEntrytypes

Actions:

1. define
2. list
3. search
4. view
5. add
6. edit

1. define

Permissions

User permissions required: JournalUser

2. list

Permissions

User permissions required: JournalUser

Fields

• entrytypes: Entrytype (string)

3. search

Permissions

User permissions required: JournalUser

Fields

• journalEntrytypeID: Entrytype ID (key)
• journalEntrytypeDescription: Description (string)
• journalEntrytypeCategoryID: Category ID (key)
• journalEntrytypeCategoryName: Category (string)

4. view

Permissions

User permissions required: JournalUser

Fields

• journalEntrytypeID: Entrytype ID (key)

5. add

Permissions

User permissions required: JournalAdmin

Fields

• journalEntrytypeDescription: Description (string)
• journalEntrytypeCategoryID: Category (key)

6. edit

Permissions

User permissions required: JournalAdmin

Fields

• journalEntrytypeID: Entrytype ID (key)
• journalEntrytypeDescription: Description (string)
• journalEntrytypeCategoryID: Category (key)

animalsJournalEntries

Actions:

1. define
2. search
3. view
4. add
5. edit
6. delete

1. define

Permissions

User permissions required: JournalUser

2. search

Permissions

User permissions required: JournalUser

Fields

• journalEntryID: Entry ID (key)
• journalEntryAnimalID: Animal ID (key)
• journalEntryDate: Date (date)
• journalEntryComment: Comment (string)
• journalEntryEntrytypeID: Entrytype ID (key)
• journalEntrytypeDescription: Entrytype (string)
• journalEntrytypeCategoryID: Category ID (key)
• journalEntrytypeCategoryName: Category (string)
• journalEntryCost: Cost (decimal)
• journalEntryReminderDate: Reminder Date (date)
• journalEntryReminderContactID: Reminder Contact ID (key)
• journalEntryReminderContactName: Reminder Contact Name (string)

3. view

Permissions

User permissions required: JournalUser

Fields

• journalEntryID: Entry ID (key)

4. add

Permissions

User permissions required: JournalAdmin

Fields

• journalEntryAnimalID: Animal (key)
• journalEntryDate: Date (date)
• journalEntryComment: Comment (string)
• journalEntryEntrytypeID: Entry Type (key)
• journalEntryCost: Cost (decimal)
• journalEntryReminderDate: Reminder Date (date)

5. edit

Permissions

User permissions required: JournalAdmin

Fields

• journalEntryID: Entry ID (key)
• journalEntryAnimalID: Animal ID (key)
• journalEntryDate: Date (date)
• journalEntryComment: Comment (string)
• journalEntryEntrytypeID: Entry Type (key)
• journalEntryCost: Cost (decimal)
• journalEntryReminderDate: Reminder Date (date)

6. delete

Permissions

User permissions required: JournalAdmin

Fields

• journalEntryID: Entry ID (key)

animalsMeetrequests

Actions:

1. define
2. search
3. view
4. add
5. edit
6. delete

1. define

Permissions

User permissions required: AnimalAdd

2. search

Permissions

User permissions required: AnimalAdd

Fields

• meetrequestID: Meet Request ID (key)
• meetrequestAnimalID: Animal ID (key)
• meetrequestContactID: Contact ID (key)
• meetrequestEventID: Event ID (key)
• meetrequestLocationID: Location ID (key)
• meetrequestDate: Date (date)
• animalName: Animal (string)
• contactName: Contact (string)
• contactType: Contact Type (string)
• eventName: Event (string)
• locationName: Location (string)

3. view

Permissions

User permissions required: AnimalAdd

Fields

• meetrequestID: Meet Request ID (key)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• meetrequestAnimalID: Animal (key)
• meetrequestContactID: Contact (key)
• meetrequestEventID: Event (key)
• meetrequestLocationID: Location (key)
• meetrequestDate: Date (date)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• meetrequestID: Meet Request ID (key)
• meetrequestAnimalID: Animal (key)
• meetrequestContactID: Contact (key)
• meetrequestEventID: Event (key)
• meetrequestLocationID: Location (key)
• meetrequestDate: Date (date)

6. delete

Permissions

User permissions required: AnimalAdd

Fields

• meetrequestID: Meet Request ID (key)

animalPatterns

Actions:

1. define
2. publicList
3. list

1. define

Permissions

Public

2. publicList

Permissions

Public

Fields

• patterns: Pattern (string)

3. list

Permissions

User permissions required: Volunteer

Fields

• patterns: Pattern (string)

animalQualities

Actions:

1. define
2. publicList
3. list

1. define

Permissions

Public

2. publicList

Permissions

Public

Fields

• animalQualities: Animal Qualities (string)

3. list

Permissions

User permissions required: Volunteer

Fields

• animalQualities: Animal Qualities (string)

animalsExports

Actions:

1. define
2. getExports
3. updateExports
4. getSettings
5. updateSettings

1. define

Permissions

User permissions required: SiteAdmin

2. getExports

Permissions

User permissions required: SiteAdmin

3. updateExports

Permissions

User permissions required: SiteAdmin

Fields

• exportID: Export ID (key)
• exportEnabled: Export enabled (string from values list)

4. getSettings

Permissions

User permissions required: OptionsAdmin

5. updateSettings

Permissions

User permissions required: OptionsAdmin

Fields

• 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)

animalsReasonsEuthanasia

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• euthanasiaReasons: Euthanasia Reason (string)

3. view

Permissions

User permissions required: Volunteer

Fields

• reasonID: Reason ID (key)

4. search

Permissions

User permissions required: Volunteer

Fields

• reasonID: Reason ID (key)
• reasonName: Reason (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• reasonName: Reason (string)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• reasonID: Reason ID (key)
• reasonName: Reason (string)

7. delete

Permissions

User permissions required: AnimalAdd

Fields

• reasonID: Reason ID (key)

animalsReasonsImpound

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• impoundReasons: Impound Reason (string)

3. view

Permissions

User permissions required: Volunteer

Fields

• reasonID: Reason ID (key)

4. search

Permissions

User permissions required: Volunteer

Fields

• reasonID: Reason ID (key)
• reasonName: Reason (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• reasonName: Reason (string)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• reasonID: Reason ID (key)
• reasonName: Reason (string)

7. delete

Permissions

User permissions required: AnimalAdd

Fields

• reasonID: Reason ID (key)

animalsReasonsSurrender

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• euthanasiaReasons: Surrender Reason (string)

3. view

Permissions

User permissions required: Volunteer

Fields

• reasonID: Reason ID (key)

4. search

Permissions

User permissions required: Volunteer

Fields

• reasonID: Reason ID (key)
• reasonName: Reason (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• reasonName: Reason (string)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• reasonID: Reason ID (key)
• reasonName: Reason (string)

7. delete

Permissions

User permissions required: AnimalAdd

Fields

• reasonID: Reason ID (key)

animalsReasonsTransfer

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• euthanasiaReasons: Transfer Reason (string)

3. view

Permissions

User permissions required: Volunteer

Fields

• reasonID: Reason ID (key)

4. search

Permissions

User permissions required: Volunteer

Fields

• reasonID: Reason ID (key)
• reasonName: Reason (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• reasonName: Reason (string)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• reasonID: Reason ID (key)
• reasonName: Reason (string)

7. delete

Permissions

User permissions required: AnimalAdd

Fields

• reasonID: Reason ID (key)

animalSpecies

Actions:

1. define
2. publicList
3. list
4. listActive
5. search

1. define

Permissions

Public

2. publicList

Permissions

Public

Fields

• species: Species (string)

3. list

Permissions

User permissions required: Volunteer

Fields

• species: Species (string)

4. listActive

Permissions

User permissions required: Volunteer

Fields

• species: Species (string)

5. search

Permissions

User permissions required: Volunteer

Fields

• speciesID: ID (key)
• speciesSingular: Singular name (string)
• speciesPlural: Plural name (string)
• speciesSingularYoung: Singular young name (string)
• speciesPluralYoung: Plural young name (string)
• speciesFullname: Full name (string)

animalStatuses

Actions:

1. define
2. list
3. search

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• statuses: Status (string)

3. search

Permissions

User permissions required: Volunteer

Fields

• statusID: ID (key)
• statusName: Status name (string)
• statusDescription: Status description (string)

animalAdoptionLeads

Actions:

1. define
2. list

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• adoptionLeads: Adoption Leads (string)

animalAdoptionStatuses

Actions:

1. define
2. list

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• adoptionStatuses: Adoption Statuses (string)

calls

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit

1. define

Permissions

User permissions required: CallOperator

2. list

Permissions

User permissions required: CallOperator

3. view

Permissions

User permissions required: CallOperator

Fields

• callID: ID (key)

4. search

Permissions

User permissions required: CallOperator

Fields

• callID: ID (key)
• callContactID: Contact ID (key)
• callAssignedID: Assigned ID (key)
• callStatusID: Status ID (key)
• callUrgencyID: Urgency ID (key)
• callCategoryID: Category ID (key)
• callQueueID: Queue ID (key)
• callDate: Call date (datetime)
• contactName: Contact (string)
• contactType: Contact Type (string)
• assignedName: Assigned To (string)
• queueName: Queue (string)
• categoryName: Category (string)
• statusName: Status (string)
• urgencyName: Urgency (string)
• lastOutcome: Last Outcome (string)
• logEntryCount: Log Entries Count (string)

5. add

Permissions

User permissions required: CallOperator

Fields

• callContactID: Contact (key)
• callAssignedID: Assigned (key)
• callStatusID: Status (key)
• callUrgencyID: Urgency (key)
• callCategoryID: Category (key)
• callQueueID: Queue (key)
• callDate: Call date (datetime)

6. edit

Permissions

User permissions required: CallAdmin

Fields

• callID: ID (key)
• callContactID: Contact (key)
• callAssignedID: Assigned (key)
• callStatusID: Status (key)
• callUrgencyID: Urgency (key)
• callCategoryID: Category (key)
• callQueueID: Queue (key)
• callDate: Call date (datetime)

callsCategories

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: CallOperator

2. list

Permissions

User permissions required: CallOperator

Fields

• categories: Categories (string)

3. view

Permissions

User permissions required: CallOperator

Fields

• categoryID: ID (key)

4. search

Permissions

User permissions required: CallOperator

Fields

• categoryID: ID (key)
• categoryName: Name (string)
• categoryDescription: Description (string)
• categoryPublic: Public (string from values list)
• categoryDefaultQueueID: Default Queue ID (key)
• categoryDefaultQueueName: Default Queue Name (string)
• categoryCreatedDate: Created Date (date)
• categoryCreatedByID: Created By ID (key)
• categoryUpdatedDate: Updated Date (date)
• categoryUpdatedByID: Updated By ID (key)
• categoryCallsCount: Calls Count (int)

5. add

Permissions

User permissions required: CallAdmin

Fields

• categoryName: Name (string)
• categoryDescription: Description (string)
• categoryPublic: Public (string from values list)
• categoryDefaultQueueID: Default Queue (key)

6. edit

Permissions

User permissions required: CallAdmin

Fields

• categoryID: ID (key)
• categoryName: Name (string)
• categoryDescription: Description (string)
• categoryPublic: Public (string from values list)
• categoryDefaultQueueID: Default Queue (key)

7. delete

Permissions

User permissions required: CallAdmin

Fields

• categoryID: ID (key)

callsLogentries

Actions:

1. define
2. view
3. search
4. add

1. define

Permissions

User permissions required: CallOperator

2. view

Permissions

User permissions required: CallOperator

Fields

• logentryID: ID (key)

3. search

Permissions

User permissions required: CallOperator

Fields

• logentryID: ID (key)
• logentryCallID: ID (key)
• logentryContactID: Contact ID (key)
• logentryDate: Date (datetime)
• logentryOutcomeID: Outcome ID (key)
• logentryComments: Comments (string)
• contactName: Contact (string)
• outcomeName: Outcome (string)

4. add

Permissions

User permissions required: CallOperator

Fields

• logentryCallID: ID (key)
• logentryContactID: Contact (key)
• logentryDate: Date (datetime)
• logentryOutcomeID: Outcome (key)
• logentryComments: Comments (string)

callsOutcomes

Actions:

1. define
2. list

1. define

Permissions

User permissions required: CallOperator

2. list

Permissions

User permissions required: CallOperator

Fields

• outcomes: Outcomes (string)

callsQueues

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: CallOperator

2. list

Permissions

User permissions required: CallOperator

Fields

• queues: Queues (string)

3. view

Permissions

User permissions required: CallOperator

Fields

• queueID: ID (key)

4. search

Permissions

User permissions required: CallOperator

Fields

• queueID: ID (key)
• queueName: Name (string)
• queueFromEmail: From Email Address (email)
• queueDefaultUrgencyID: Default Urgency ID (key)
• queueDefaultUrgencyName: Default Urgency (string)
• queueCreatedDate: Created Date (date)
• queueCreatedByID: Created By ID (key)
• queueUpdatedDate: Updated Date (date)
• queueUpdatedByID: Updated By ID (key)
• queueOpenCallsCount: Open Calls (int)
• queueMembersCount: Members (int)

5. add

Permissions

User permissions required: CallAdmin

Fields

• queueName: Name (string)
• queueFromEmail: From Email Address (email)
• queueDefaultUrgencyID: Default Urgency (key)

6. edit

Permissions

User permissions required: CallAdmin

Fields

• queueID: ID (key)
• queueName: Name (string)
• queueFromEmail: From Email Address (email)
• queueDefaultUrgencyID: Default Urgency (key)

7. delete

Permissions

User permissions required: CallAdmin

Fields

• queueID: ID (key)

callsQueuesMembers

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: CallOperator

2. list

Permissions

User permissions required: CallOperator

Fields

• members: Members (string)

3. view

Permissions

User permissions required: CallOperator

Fields

• memberID: ID (key)

4. search

Permissions

User permissions required: CallOperator

Fields

• memberID: ID (key)
• memberContactID: Contact ID (key)
• memberQueueID: Queue ID (key)
• memberManager: Manager (string from values list)
• memberCreatedDate: Created Date (date)
• memberCreatedByID: Created By ID (key)
• memberUpdatedDate: Updated Date (date)
• memberUpdatedByID: Updated By ID (key)
• queueName: Call Queue (string)
• memberName: Member (string)
• memberContactType: Type (string)

5. add

Permissions

User permissions required: CallAdmin

Fields

• memberContactID: Contact (key)
• memberQueueID: Queue (key)
• memberManager: Manager (string from values list)

6. edit

Permissions

User permissions required: CallAdmin

Fields

• memberID: ID (key)
• memberContactID: Contact (key)
• memberQueueID: Queue (key)
• memberManager: Manager (string from values list)

7. delete

Permissions

User permissions required: CallAdmin

Fields

• memberID: ID (key)

callsStatuses

Actions:

1. define
2. list

1. define

Permissions

User permissions required: CallOperator

2. list

Permissions

User permissions required: CallOperator

Fields

• statuses: Statuses (string)

callsUrgencies

Actions:

1. define
2. list

1. define

Permissions

User permissions required: CallOperator

2. list

Permissions

User permissions required: CallOperator

Fields

• urgencies: Urgencies (string)

colonies

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: ContactsAddColonyAdmin

2. list

Permissions

User permissions required: Volunteer

Fields

• colonies: Colony (string)

3. view

Permissions

User permissions required: ContactsAddColonyAdmin

Fields

• colonyID: ID (key)

4. search

Permissions

User permissions required: ContactsAddColonyAdmin

Fields

• colonyID: Colony ID (key)
• colonyAnimals: Animals (string)
• colonyCaretakers: Caretakers (string)
• colonyLocationID: Location ID (key)
• colonyName: Name (string)
• colonyTotalAnimals: Number of animals (int)
• colonyRegisteredDate: Registered (date)
• colonySpecificLocation: Specific location (string)
• locationName: Name (string)
• locationUrl: Web address (url)
• locationAddress: Street address (string)
• locationCity: City (string)
• locationState: State/Province (province)
• locationPostalcode: Postal Code (postalcode)
• locationCountry: Country (key)
• locationPhone: Phone (phone)
• locationPhoneExt: Phone extension (string)
• locationAnimals: Animals (int)
• locationEvents: Events (int)
• locationColonies: Colonies (int)
• locationMeetrequests: Meet Requests (int)

5. add

Permissions

User permissions required: ColonyAdmin

Fields

• colonyName: Name (string)
• colonyLocationID: Location (key)
• colonyTotalAnimals: Number of animals (int)
• colonyRegisteredDate: Registered date (date)
• colonySpecificLocation: Specific location (string)

6. edit

Permissions

User permissions required: ColonyAdmin

Fields

• colonyID: Colony ID (key)
• colonyName: Name (string)
• colonyLocationID: Location (key)
• colonyTotalAnimals: Number of animals (int)
• colonyRegisteredDate: Registered date (date)
• colonySpecificLocation: Specific location (string)

7. delete

Permissions

User permissions required: ColonyAdmin

Fields

• colonyID: Colony ID (key)

coloniesCaretakers

Actions:

1. define
2. list
3. view
4. search
5. add
6. delete

1. define

Permissions

User permissions required: ColonyAdmin

2. list

Permissions

User permissions required: Volunteer

Fields

• coloniesCaretakers: Caretaker (string)

3. view

Permissions

User permissions required: ColonyAdmin

Fields

• caretakerID: ID (key)

4. search

Permissions

User permissions required: ColonyAdmin

Fields

• caretakerID: Caretaker ID (key)
• caretakerColonyID: Colony ID (key)
• caretakerContactID: Contact ID (key)
• caretakerContactName: Contact (string)

5. add

Permissions

User permissions required: ColonyAdmin

Fields

• caretakerColonyID: Colony (key)
• caretakerContactID: Caretaker (key)

6. delete

Permissions

User permissions required: ColonyAdmin

Fields

• caretakerID: Caretaker ID (key)

contacts

Actions:

1. define
2. view
3. list
4. listRescues
5. listFosters
6. search
7. add
8. edit
9. delete
10. getSettings
11. updateSettings

1. define

Permissions

User permissions required: Volunteer

2. view

Permissions

User permissions required: Volunteer

Fields

• contactID: ID (key)

3. list

Permissions

User permissions required: Volunteer

4. listRescues

Permissions

User permissions required: Volunteer

5. listFosters

Permissions

User permissions required: Volunteer

6. search

Permissions

User permissions required: Volunteer

Fields

• contactID: ID (key)
• contactClass: Class (string from values list)
• contactSalutation: Salutation (string from values list)
• contactName: Name (string)
• contactFirstname: First name (string)
• contactLastname: Last name (string)
• contactTitle: Title (string)
• contactAddress: Street address (string)
• contactCity: City (string)
• contactState: State/Province (province)
• contactPostalcode: Postal Code (postalcode)
• contactPlus4: Zip code plus 4 (string)
• contactCounty: County (string)
• contactCountry: Country (key)
• contactPhoneHome: Home phone number (phone)
• contactPhoneWork: Work phone number (phone)
• contactPhoneWorkExt: Work phone extension (string)
• contactPhoneCell: Cell phone number (phone)
• contactFax: Fax number (phone)
• contactEmail: Email address (email)
• contactEmailAlt: Alternate email address (email)
• contactEmailPager: Pager email address (email)
• contactCompany: Company (string)
• contactReferredBy: Referred by (string)
• contactCarrier: Carrier (string)
• contactBounces: Number of bounced email messages (int)
• contactSendMail: Send mail (string from values list)
• contactActive: Active (string from values list)
• contactComment: Comment (string)
• contactTransportation: Transportation (string)
• contactAvailability: Availability (string)
• contactCaretakerPublic: Caretaker public (string from values list)
• contactCoalitionMember: Coalition member (string from values list)
• contactGroups: Groups (key)
• contactType: Contact Type (string from values list)

7. add

Permissions

User permissions required: Volunteer

Fields

• contactClass: Class (string from values list)
• contactSalutation: Salutation (string from values list)
• contactFirstname: First name (string)
• contactLastname: Last name (string)
• contactTitle: Title (string)
• contactAddress: Street address (string)
• contactCity: City (string)
• contactState: State/Province (province)
• contactPostalcode: Postal Code (postalcode)
• contactPlus4: Zip code plus 4 (string)
• contactCounty: County (string)
• contactCountry: Country (key)
• contactPhoneHome: Home phone number (phone)
• contactPhoneWork: Work phone number (phone)
• contactPhoneWorkExt: Work phone extension (string)
• contactPhoneCell: Cell phone number (phone)
• contactFax: Fax number (phone)
• contactEmail: Email address (email)
• contactEmailAlt: Alternate email address (email)
• contactEmailPager: Pager email address (email)
• contactCompany: Company (string)
• contactReferredBy: Referred by (string)
• contactCarrier: Carrier (string)
• contactSendMail: Send mail (string from values list)
• contactActive: Active (string from values list)
• contactComment: Comment (string)
• contactCoalitionMember: Coalition member (string from values list)
• contactTransportation: Transportation (string)
• contactAvailability: Availability (string)
• contactCaretakerPublic: Caretaker public (string from values list)
• contactSendInvite: Send website invitation (string from values list)
• contactGroups: Groups (key)

8. edit

Permissions

User permissions required: Volunteer

Fields

• contactID: ID (key)
• contactClass: Class (string from values list)
• contactSalutation: Salutation (string from values list)
• contactFirstname: First name (string)
• contactLastname: Last name (string)
• contactTitle: Title (string)
• contactAddress: Street address (string)
• contactCity: City (string)
• contactState: State/Province (province)
• contactPostalcode: Postal Code (postalcode)
• contactPlus4: Zip code plus 4 (string)
• contactCounty: County (string)
• contactCountry: Country (key)
• contactPhoneHome: Home phone number (phone)
• contactPhoneWork: Work phone number (phone)
• contactPhoneWorkExt: Work phone extension (string)
• contactPhoneCell: Cell phone number (phone)
• contactFax: Fax number (phone)
• contactEmail: Email address (email)
• contactEmailAlt: Alternate email address (email)
• contactEmailPager: Pager email address (email)
• contactCompany: Company (string)
• contactReferredBy: Referred by (string)
• contactCarrier: Carrier (string)
• contactSendMail: Send mail (string from values list)
• contactActive: Active (string from values list)
• contactComment: Comment (string)
• contactTransportation: Transportation (string)
• contactAvailability: Availability (string)
• contactCaretakerPublic: Caretaker public (string from values list)
• contactCoalitionMember: Coalition member (string from values list)
• contactGroups: Groups (key)

9. delete

Permissions

User permissions required: ContactsAdmin

Fields

• contactID: ID (key)

10. getSettings

Permissions

User permissions required: ContactsAdmin

11. updateSettings

Permissions

User permissions required: ContactsAdmin

Fields

• enableContactsDoNotAdoptListSharing: Share your organization's Do Not Adopt list (string from values list)
• enableContactsAutoSelectRegistrationInvitation: Automatically select to send Registration Invitation (string from values list)
• enableContactsAutoSelectCaretakerInfoPublic: Automatically select to set caretaker information public (string from values list)
• enableAddContactOnlineFormSubmission: Add a Contact record when an Online Form is submitted (string from values list)
• enableContactsAddContactMeetRequest: Add a Contact record when an Meet Request is submitted (string from values list)
• enableContactsAddContactCallCreation: Add a Contact record when a Call is created from the Contact Us page (string from values list)
• enableContactsAddContactAnimalSponsorship: Add a Contact record when an Animal Sponsorship is submitted (string from values list)
• enableContactsAddContactUserRegistration: Add a Contact record when a user registers (string from values list)

contactFiles

Actions:

1. define
2. list
3. search
4. view
5. add
6. edit

1. define

Permissions

User permissions required: ContactsAdd

2. list

Permissions

User permissions required: ContactsAdd

Fields

• contactfile: File (string)

3. search

Permissions

User permissions required: ContactsAdd

Fields

• contactfileID: File ID (key)
• contactfileContactID: ID (key)
• contactfileOldName: Old file name (string)
• contactfileDescription: Description (string)
• contactfileStatus: Status (string from values list)
• contactfileDisplayInline: Inline (string from values list)
• contactfileSize: File size (int)
• contactfileCreatedDate: Created Date (date)

4. view

Permissions

User permissions required: ContactsAdd

Fields

• contactfileID: File ID (key)

5. add

Permissions

User permissions required: ContactsAdd

Fields

• contactfileContactID: Contact (key)
• contactfileBinary: File (binary)
• contactfileOldFileName: Old file name (string)
• contactfileDescription: Description (string)
• contactfileStatus: Status (string from values list)
• contactfileDisplayInline: Inline (string from values list)

6. edit

Permissions

User permissions required: ContactsAdd

Fields

• contactfileID: File ID (key)
• contactfileContactID: ID (key)
• contactfileDescription: Description (string)
• contactfileStatus: Status (string from values list)
• contactfileDisplayInline: Inline (string from values list)

contactsGroups

Actions:

1. define
2. view
3. list
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: Volunteer

2. view

Permissions

User permissions required: ContactsAdd

Fields

• groupID: ID (key)

3. list

Permissions

User permissions required: Volunteer

Fields

• contactGroup: Group (string)

4. search

Permissions

User permissions required: Volunteer

Fields

• groupID: ID (key)
• groupName: Name (string)
• groupBusiness: Business (string from values list)
• groupProtected: Protected (string from values list)

5. add

Permissions

User permissions required: ContactsAdmin

Fields

• groupName: Name (string)
• groupBusiness: Business (string from values list)

6. edit

Permissions

User permissions required: ContactsAdmin

Fields

• groupID: ID (key)
• groupName: Name (string)
• groupBusiness: Business (string from values list)

7. delete

Permissions

User permissions required: ContactsAdmin

Fields

• groupID: ID (key)

countries

Actions:

1. define
2. list

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• country: Country (string)

donations

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: ContactsAdmin

2. list

Permissions

User permissions required: ContactsAdmin

3. view

Permissions

User permissions required: ContactsAdmin

Fields

• donationID: ID (key)

4. search

Permissions

User permissions required: ContactsAdmin

Fields

• donationID: Donation ID (key)
• donationContactID: Contact ID (key)
• donationContactName: Contact (string)
• donationContactType: Donor Type (string)
• donationAmount: Amount (decimal)
• donationInkind: Inkind type (string)
• donationComment: Comment (string)
• donationLettersent: Letter sent (string from values list)
• donationPurpose: Purpose (string)
• donationDate: Date (date)

5. add

Permissions

User permissions required: ContactsAdmin

Fields

• donationContactID: Contact (key)
• donationAmount: Amount (decimal)
• donationInkind: Inkind type (string)
• donationComment: Comment (string)
• donationLettersent: Letter sent (string from values list)
• donationPurpose: Purpose (string)
• donationDate: Date (date)
• donationAddDonorGroup: Add contact to Donor group (string from values list)

6. edit

Permissions

User permissions required: ContactsAdmin

Fields

• donationID: Donation ID (key)
• donationContactID: Contact (key)
• donationAmount: Amount (decimal)
• donationInkind: Inkind type (string)
• donationComment: Comment (string)
• donationLettersent: Letter sent (string from values list)
• donationPurpose: Purpose (string)
• donationDate: Date (date)

7. delete

Permissions

User permissions required: ContactsAdmin

Fields

• donationID: Donation ID (key)

events

Actions:

1. define
2. list
3. publicView
4. view
5. publicSearch
6. search
7. add
8. edit
9. delete
10. getSettings
11. updateSettings

1. define

Permissions

Public

2. list

Permissions

User permissions required: Volunteer

Fields

• event: Event (string)

3. publicView

Permissions

Public

Fields

• eventID: ID (key)

4. view

Permissions

User permissions required: Volunteer

Fields

• eventID: ID (key)

5. publicSearch

Permissions

Public

Fields

• eventID: ID (key)
• eventOrgID: Organization ID (key)
• eventName: Name (string)
• eventStart: Start Date/Time (datetime)
• eventEnd: End Date/Time (datetime)
• eventUrl: Web address (url)
• eventDescription: Description (string)
• eventLocationID: Location (key)
• eventLocationDistance: Distance (int)
• eventSpecies: Species attending (key)
• locationName: Location name (string)
• locationUrl: Location web address (url)
• locationAddress: Location street address (string)
• locationCity: Location city (string)
• locationState: Location state/province (province)
• locationPostalcode: Location postal code (postalcode)
• locationCountry: Location country (key)
• locationPhone: Location phone (phone)
• locationPhoneExt: Location phone extension (string)
• locationEvents: Location events (int)

6. search

Permissions

User permissions required: Volunteer

Fields

• eventID: ID (key)
• eventName: Name (string)
• eventStart: Start Date/Time (datetime)
• eventEnd: End Date/Time (datetime)
• eventUrl: Web address (url)
• eventDescription: Description (string)
• eventLocationID: Location (key)
• eventAnimalAttendance: Event animal attendance (int)
• eventMeetrequests: Event meet requests (int)
• eventSpecies: Species attending (key)
• locationID: Location ID (key)
• locationName: Location name (string)
• locationUrl: Location web address (url)
• locationAddress: Location street address (string)
• locationCity: Location city (string)
• locationState: Location state/province (province)
• locationPostalcode: Location postal code (postalcode)
• locationCountry: Location country (key)
• locationPhone: Location phone (phone)
• locationPhoneExt: Location phone extension (string)
• locationAnimals: Location animals (int)
• locationEvents: Location events (int)
• locationColonies: Location colonies (int)
• locationMeetrequests: Location meet requests (int)

7. add

Permissions

User permissions required: EventAdmin

Fields

• eventName: Name (string)
• eventStart: Start Date/Time (datetime)
• eventEnd: End Date/Time (datetime)
• eventUrl: Web address (url)
• eventDescription: Description (string)
• eventLocationID: Location (key)
• eventSpecies: Species attending (key)

8. edit

Permissions

User permissions required: EventAdmin

Fields

• eventID: ID (key)
• eventName: Name (string)
• eventStart: Start Date/Time (datetime)
• eventEnd: End Date/Time (datetime)
• eventUrl: Web address (url)
• eventDescription: Description (string)
• eventLocationID: Location (key)
• eventSpecies: Species attending (key)

9. delete

Permissions

User permissions required: EventAdmin

Fields

• eventID: ID (key)

10. getSettings

Permissions

User permissions required: EventAdmin

11. updateSettings

Permissions

User permissions required: EventAdmin

Fields

• enableEvents: Enable the Events feature (string from values list)
• setEventsMapWebsite: Map website to use with the Events feature (string from values list)

eventanimalattendance

Actions:

1. define
2. publicView
3. view
4. publicSearch
5. search
6. add
7. edit
8. delete

1. define

Permissions

User permissions required: Array

2. publicView

Permissions

Public

Fields

• attendanceID: ID (key)

3. view

Permissions

User permissions required: Array

Fields

• attendanceID: ID (key)

4. publicSearch

Permissions

Public

Fields

• attendanceID: ID (key)
• attendanceStatus: Status (string from values list)
• attendanceAnimalID: Animal ID (key)
• animalOrgID: Org ID (key)
• animalActivityLevel: Activity level (string from values list)
• animalAdoptionFee: Adoption fee (string)
• animalAltered: Altered (string from values list)
• animalAvailableDate: Available Date (date)
• animalBirthdate: Birthdate (date)
• animalBirthdateExact: Exact Birthdate (string from values list)
• animalBreed: Breed (string)
• animalCoatLength: Coat Length (string from values list)
• animalColor: Color (string)
• animalColorID: Color (General) (key)
• animalColorDetails: Color details (string)
• animalCourtesy: Courtesy (string from values list)
• animalDeclawed: Declawed (string from values list)
• animalDescription: Description (string)
• animalDescriptionPlain: Description (no html) (string)
• animalDistinguishingMarks: Distinguishing marks (string)
• animalEarType: Ear type (string from values list)
• animalEnergyLevel: Energy level (string from values list)
• animalExerciseNeeds: Exercise needs (string from values list)
• animalEyeColor: Eye color (string from values list)
• animalFence: Requires a home with fence (string from values list)
• animalFound: Found (string from values list)
• animalFoundDate: Found date (date)
• animalFoundPostalcode: Found zip/postal code (postalcode)
• animalGeneralAge: General Age (string from values list)
• animalGeneralSizePotential: Size potential (general) (string from values list)
• animalGroomingNeeds: Grooming needs (string from values list)
• animalHousetrained: Housetrained (string from values list)
• animalIndoorOutdoor: Indoor/Outdoor (string from values list)
• animalKillDate: Euthanasia date (date)
• animalKillReason: Euthanasia reason (string from values list)
• animalLocation: Location (postalcode)
• animalLocationDistance: Distance (int)
• animalMicrochiped: Microchiped (string from values list)
• animalMixedBreed: Mixed breed (string from values list)
• animalName: Name (string)
• animalSpecialneeds: Has special needs (string from values list)
• animalSpecialneedsDescription: Special needs description (string)
• animalNeedsFoster: Needs a Foster (string from values list)
• animalNewPeople: Reaction to new people (string from values list)
• animalNotHousetrainedReason: Reason not housetrained (string)
• animalObedienceTraining: Obedience training (string from values list)
• animalOKWithAdults: Good with adults (string from values list)
• animalOKWithCats: OK with cats (string from values list)
• animalOKWithDogs: OK with dogs (string from values list)
• animalOKWithKids: OK with kids (string from values list)
• animalOthernames: Other names (string)
• animalOwnerExperience: Owner experience needed (string from values list)
• animalPattern: Pattern (string)
• animalPatternID: Pattern ID (key)
• animalAdoptionPending: Adoption pending (string from values list)
• animalPrimaryBreed: Primary breed (string)
• animalPrimaryBreedID: Primary breed ID (key)
• animalRescueID: Rescue ID (string)
• animalSearchString: Search (string)
• animalSecondaryBreed: Secondary Breed (string)
• animalSecondaryBreedID: Secondary Breed ID (key)
• animalSex: Sex (string from values list)
• animalShedding: Shedding amount (string from values list)
• animalSizeCurrent: Current size (decimal)
• animalSizePotential: Size potential (decimal)
• animalSizeUOM: Size unit of measure (string from values list)
• animalSpecies: Species (string)
• animalSpeciesID: Species (key)
• animalSponsorable: Allow sponsorship (string from values list)
• animalSponsors: Sponsors (string)
• animalSponsorshipDetails: Sponsorship details (string)
• animalSponsorshipMinimum: Sponsorship minimum (decimal)
• animalStatus: Status (string)
• animalStatusID: Status ID (key)
• animalSummary: Summary (string)
• animalTailType: Tail type (string from values list)
• animalUptodate: Up-to-date (string from values list)
• animalUpdatedDate: Last updated (date)
• animalUrl: Web page (url)
• animalVocal: Likes to vocalize (string from values list)
• animalYardRequired: Requires a Yard (string from values list)
• animalAffectionate: Affectionate (string from values list)
• animalApartment: Apartment appropriate (string from values list)
• animalCratetrained: Crate trained (string from values list)
• animalDrools: Drools excessively (string from values list)
• animalEagerToPlease: Eager to please (string from values list)
• animalEscapes: Tries to escape (string from values list)
• animalEventempered: Even-tempered (string from values list)
• animalFetches: Likes to fetch (string from values list)
• animalGentle: Gentle (string from values list)
• animalGoodInCar: Does well in a car (string from values list)
• animalGoofy: Goofy (string from values list)
• animalHasAllergies: Has allergies (string from values list)
• animalHearingImpaired: Hearing impaired (string from values list)
• animalHypoallergenic: Hypoallergenic (string from values list)
• animalIndependent: Independent / aloof (string from values list)
• animalIntelligent: Intelligent (string from values list)
• animalLap: Lap pet (string from values list)
• animalLeashtrained: Leash trained (string from values list)
• animalNeedsCompanionAnimal: Needs companion animal (string from values list)
• animalNoCold: Cold sensitive (string from values list)
• animalNoFemaleDogs: Not good with female dogs (string from values list)
• animalNoHeat: Heat sensitive (string from values list)
• animalNoLargeDogs: Not good with large dogs (string from values list)
• animalNoMaleDogs: Not good with male dogs (string from values list)
• animalNoSmallDogs: Not good with small dogs (string from values list)
• animalObedient: Obedient (string from values list)
• animalOKForSeniors: Good for seniors / elderly (string from values list)
• animalOKWithFarmAnimals: Good with farm animals (string from values list)
• animalOlderKidsOnly: Older/ considerate kids only (string from values list)
• animalOngoingMedical: Needs ongoing medical care (string from values list)
• animalPlayful: Playful (string from values list)
• animalPlaysToys: Likes toys (string from values list)
• animalPredatory: Predatory (string from values list)
• animalProtective: Protective / territorial (string from values list)
• animalSightImpaired: Sight impaired (string from values list)
• animalSkittish: Skittish (string from values list)
• animalSpecialDiet: Special diet required (string from values list)
• animalSwims: Likes to swim (string from values list)
• animalTimid: Timid / shy (string from values list)
• fosterEmail: Email (string)
• fosterFirstname: First Name (string)
• fosterLastname: Last Name (string)
• fosterName: Foster (string)
• fosterPhoneCell: Phone (Cell) (string)
• fosterPhoneHome: Phone (Home) (string)
• fosterPhoneWork: Phone (Work) (string)
• fosterPhoneWorkExt: Phone Extension (Work) (string)
• fosterSalutation: Salutation (string)
• attendanceEventID: Event ID (key)
• eventName: Name (string)
• eventStart: Start Date/Time (datetime)
• eventEnd: End Date/Time (datetime)
• eventUrl: Web address (url)
• eventDescription: Description (string)
• eventLocationID: Location ID (key)
• eventAnimalAttendance: Event animal attendance (int)
• eventMeetrequests: Event meet requests (int)
• eventSpecies: Species attending (string)
• eventSpeciesID: Species attending (key)
• eventLocationName: Location name (string)
• eventLocationUrl: Location web address (url)
• eventLocationAddress: Location street address (string)
• eventLocationCity: Location city (string)
• eventLocationState: Location state/province (province)
• eventLocationPostalcode: Location postal code (postalcode)
• eventLocationCountry: Location country (key)
• eventLocationPhone: Location phone (phone)
• eventLocationPhoneExt: Location phone extension (string)
• eventLocationAnimals: Location animals (int)
• eventLocationEvents: Location events (int)
• eventLocationColonies: Location colonies (int)
• eventLocationMeetrequests: Location meet requests (int)

5. search

Permissions

User permissions required: Array

Fields

• attendanceID: ID (key)
• attendanceStatus: Status (string from values list)
• attendanceAnimalID: Animal ID (key)
• animalOrgID: Org ID (key)
• animalActivityLevel: Activity level (string from values list)
• animalAdoptionFee: Adoption fee (string)
• animalAltered: Altered (string from values list)
• animalAvailableDate: Available Date (date)
• animalBirthdate: Birthdate (date)
• animalBirthdateExact: Exact Birthdate (string from values list)
• animalBreed: Breed (string)
• animalCoatLength: Coat Length (string from values list)
• animalColor: Color (string)
• animalColorID: Color (General) (key)
• animalColorDetails: Color details (string)
• animalCourtesy: Courtesy (string from values list)
• animalDeclawed: Declawed (string from values list)
• animalDescription: Description (string)
• animalDescriptionPlain: Description (no html) (string)
• animalDistinguishingMarks: Distinguishing marks (string)
• animalEarType: Ear type (string from values list)
• animalEnergyLevel: Energy level (string from values list)
• animalExerciseNeeds: Exercise needs (string from values list)
• animalEyeColor: Eye color (string from values list)
• animalFence: Requires a home with fence (string from values list)
• animalFound: Found (string from values list)
• animalFoundDate: Found date (date)
• animalFoundPostalcode: Found zip/postal code (postalcode)
• animalGeneralAge: General Age (string from values list)
• animalGeneralSizePotential: Size potential (general) (string from values list)
• animalGroomingNeeds: Grooming needs (string from values list)
• animalHousetrained: Housetrained (string from values list)
• animalIndoorOutdoor: Indoor/Outdoor (string from values list)
• animalKillDate: Euthanasia date (date)
• animalKillReason: Euthanasia reason (string from values list)
• animalLocation: Location (postalcode)
• animalMixedBreed: Mixed breed (string from values list)
• animalName: Name (string)
• animalSpecialneeds: Has special needs (string from values list)
• animalSpecialneedsDescription: Special needs description (string)
• animalNeedsFoster: Needs a Foster (string from values list)
• animalNewPeople: Reaction to new people (string from values list)
• animalNotHousetrainedReason: Reason not housetrained (string)
• animalObedienceTraining: Obedience training (string from values list)
• animalOKWithAdults: Good with adults (string from values list)
• animalOKWithCats: OK with cats (string from values list)
• animalOKWithDogs: OK with dogs (string from values list)
• animalOKWithKids: OK with kids (string from values list)
• animalOthernames: Other names (string)
• animalOwnerExperience: Owner experience needed (string from values list)
• animalPattern: Pattern (string)
• animalPatternID: Pattern ID (key)
• animalAdoptionPending: Adoption pending (string from values list)
• animalPrimaryBreed: Primary breed (string)
• animalPrimaryBreedID: Primary breed ID (key)
• animalRescueID: Rescue ID (string)
• animalSecondaryBreed: Secondary Breed (string)
• animalSecondaryBreedID: Secondary Breed ID (key)
• animalSex: Sex (string from values list)
• animalShedding: Shedding amount (string from values list)
• animalSizeCurrent: Current size (decimal)
• animalSizePotential: Size potential (decimal)
• animalSizeUOM: Size unit of measure (string from values list)
• animalSpecies: Species (string)
• animalSpeciesID: Species (key)
• animalSponsorable: Allow sponsorship (string from values list)
• animalSponsors: Sponsors (string)
• animalStatus: Status (string)
• animalStatusID: Status ID (key)
• animalSummary: Summary (string)
• animalTailType: Tail type (string from values list)
• animalUptodate: Up-to-date (string from values list)
• animalUpdatedDate: Last updated (date)
• animalVocal: Likes to vocalize (string from values list)
• animalYardRequired: Requires a Yard (string from values list)
• fosterEmail: Email (string)
• fosterFirstname: First Name (string)
• fosterLastname: Last Name (string)
• fosterName: Foster (string)
• fosterPhoneCell: Phone (Cell) (string)
• fosterPhoneHome: Phone (Home) (string)
• fosterPhoneWork: Phone (Work) (string)
• fosterPhoneWorkExt: Phone Extension (Work) (string)
• fosterSalutation: Salutation (string)
• attendanceEventID: Event ID (key)
• eventName: Name (string)
• eventStart: Start Date/Time (datetime)
• eventEnd: End Date/Time (datetime)
• eventUrl: Web address (url)
• eventDescription: Description (string)
• eventLocationID: Location ID (key)
• eventAnimalAttendance: Event animal attendance (int)
• eventMeetrequests: Event meet requests (int)
• eventSpecies: Species attending (key)
• eventLocationName: Location name (string)
• eventLocationUrl: Location web address (url)
• eventLocationAddress: Location street address (string)
• eventLocationCity: Location city (string)
• eventLocationState: Location state/province (province)
• eventLocationPostalcode: Location postal code (postalcode)
• eventLocationCountry: Location country (key)
• eventLocationPhone: Location phone (phone)
• eventLocationPhoneExt: Location phone extension (string)
• eventLocationAnimals: Location animals (int)
• eventLocationEvents: Location events (int)
• eventLocationColonies: Location colonies (int)
• eventLocationMeetrequests: Location meet requests (int)

6. add

Permissions

User permissions required: Array

Fields

• attendanceAnimalID: Animal (key)
• attendanceStatus: Status (string from values list)
• attendanceEventID: Event (key)

7. edit

Permissions

User permissions required: Array

Fields

• attendanceID: ID (key)
• attendanceAnimalID: Animal (key)
• attendanceStatus: Status (string from values list)
• attendanceEventID: Event (key)

8. delete

Permissions

User permissions required: Array

Fields

• attendanceID: ID (key)

intakes

Actions:

1. define
2. list
3. search
4. view
5. delete

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakeOutcomeID: Outcome ID (key)
• intakeAnimalID: Animal ID (key)
• intakeAnimalConditionID: Condition ID (key)
• intakeType: Type (string from values list)
• intakeDate: Date (datetime)
• intakeNotes: Notes (string)
• animalName: Animal (string)
• animalConditionName: Condition (string)

4. view

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)

5. delete

Permissions

User permissions required: SiteAdmin

Fields

• intakeID: Intake ID (key)

intakesBorninrescueshelter

Actions:

1. define
2. view
3. search
4. add
5. edit
6. change

1. define

Permissions

User permissions required: AnimalAdd

2. view

Permissions

User permissions required: AnimalAdd

Fields

• intakesBorninrescueshelterID: Born In Rescue/Shelter ID (key)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakesBorninrescueshelterID: Born in Rescue/Shelter ID (key)
• intakesBorninrescueshelterAnimalID: Animal ID (key)
• intakesBorninrescueshelterAnimalConditionID: Condition ID (key)
• intakesBorninrescueshelterDate: Date (datetime)
• intakesBorninrescueshelterNotes: Notes (string)
• animalName: Animal (string)
• animalConditionName: Condition (string)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• intakesBorninrescueshelterAnimalID: Animal (key)
• intakesBorninrescueshelterAnimalConditionID: Condition (key)
• intakesBorninrescueshelterDate: Date (datetime)
• intakesBorninrescueshelterNotes: Notes (string)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• intakesBorninrescueshelterID: Born in Rescue/Shelter ID (key)
• intakesBorninrescueshelterAnimalID: Animal (key)
• intakesBorninrescueshelterAnimalConditionID: Condition (key)
• intakesBorninrescueshelterDate: Date (datetime)
• intakesBorninrescueshelterNotes: Notes (string)

6. change

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakesBorninrescueshelterAnimalID: Animal (key)
• intakesBorninrescueshelterAnimalConditionID: Condition (key)
• intakesBorninrescueshelterDate: Date (datetime)
• intakesBorninrescueshelterNotes: Notes (string)

intakesImpounds

Actions:

1. define
2. view
3. search
4. add
5. edit
6. change

1. define

Permissions

User permissions required: AnimalAdd

2. view

Permissions

User permissions required: AnimalAdd

Fields

• intakesImpoundID: Impound ID (key)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakesImpoundID: Impound ID (key)
• intakesImpoundAnimalID: Animal ID (key)
• intakesImpoundAnimalConditionID: Condition ID (key)
• intakesImpoundDate: Date (datetime)
• intakesImpoundNotes: Notes (string)
• intakesImpoundLocation: Impound Location (string)
• intakesImpoundAddress: Impound Street address (string)
• intakesImpoundCity: Impound City (string)
• intakesImpoundState: Impound State/Province (province)
• intakesImpoundPostalcode: Impound Postal Code (postalcode)
• intakesImpoundFromID: Impound From ID (key)
• intakesImpoundStaffID: Impound Performed By ID (key)
• intakesImpoundReasonID: Reason (key)
• animalName: Animal (string)
• animalConditionName: Animal Condition (string)
• impoundFromName: Impound From (string)
• impoundStaffName: Impound Performed by (string)
• impoundReason: Impound Reason (string)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• intakesImpoundAnimalID: Animal (key)
• intakesImpoundAnimalConditionID: Animal Condition (key)
• intakesImpoundDate: Date (datetime)
• intakesImpoundNotes: Notes (string)
• intakesImpoundLocation: Impound Location (string)
• intakesImpoundAddress: Impound Street address (string)
• intakesImpoundCity: Impound City (string)
• intakesImpoundState: Impound State/Province (province)
• intakesImpoundPostalcode: Impound Postal Code (postalcode)
• intakesImpoundFromID: Impound From (key)
• intakesImpoundStaffID: Impound Performed By (key)
• intakesImpoundReasonID: Impound Reason (key)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• intakesImpoundID: Stray Pickup ID (key)
• intakesImpoundAnimalID: Animal (key)
• intakesImpoundAnimalConditionID: Condition (key)
• intakesImpoundDate: Date (datetime)
• intakesImpoundNotes: Notes (string)
• intakesImpoundLocation: Pickup Location (string)
• intakesImpoundAddress: Pickup Street address (string)
• intakesImpoundCity: Pickup City (string)
• intakesImpoundState: Pickup State/Province (province)
• intakesImpoundPostalcode: Pickup Postal Code (postalcode)
• intakesImpoundFromID: Impound From (key)
• intakesImpoundStaffID: Impound By (key)
• intakesImpoundReasonID: Reason (key)

6. change

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakesImpoundAnimalID: Animal (key)
• intakesImpoundAnimalConditionID: Condition (key)
• intakesImpoundDate: Date (datetime)
• intakesImpoundNotes: Notes (string)
• intakesImpoundLocation: Pickup Location (string)
• intakesImpoundAddress: Pickup Street address (string)
• intakesImpoundCity: Pickup City (string)
• intakesImpoundState: Pickup State/Province (province)
• intakesImpoundPostalcode: Pickup Postal Code (postalcode)
• intakesImpoundFromID: Impound From (key)
• intakesImpoundStaffID: Impound By (key)
• intakesImpoundReasonID: Reason (key)

intakesOwnerrequestedeuthanasias

Actions:

1. define
2. view
3. search
4. add
5. edit
6. change

1. define

Permissions

User permissions required: AnimalAdd

2. view

Permissions

User permissions required: AnimalAdd

Fields

• intakesOwnerrequestedeuthanasiaID: Owner requestedeuthanasia ID (key)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakesOwnerrequestedeuthanasiaID: Owner Pickup ID (key)
• intakesOwnerrequestedeuthanasiaAnimalID: Animal ID (key)
• intakesOwnerrequestedeuthanasiaAnimalConditionID: Condition ID (key)
• intakesOwnerrequestedeuthanasiaDate: Date (datetime)
• intakesOwnerrequestedeuthanasiaNotes: Notes (string)
• intakesOwnerrequestedeuthanasiaOwnerID: Owner (key)
• intakesOwnerrequestedeuthanasiaReasonID: Euthanasia Reason (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• ownerName: Owner (string)
• euthanasiaReason: Euthanasia Reason (string)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• intakesOwnerrequestedeuthanasiaAnimalID: Animal (key)
• intakesOwnerrequestedeuthanasiaAnimalConditionID: Condition (key)
• intakesOwnerrequestedeuthanasiaDate: Date (datetime)
• intakesOwnerrequestedeuthanasiaNotes: Notes (string)
• intakesOwnerrequestedeuthanasiaOwnerID: Owner (key)
• intakesOwnerrequestedeuthanasiaReasonID: Euthanasia Reason (key)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• intakesOwnerrequestedeuthanasiaID: Owner Pickup ID (key)
• intakesOwnerrequestedeuthanasiaAnimalID: Animal (key)
• intakesOwnerrequestedeuthanasiaAnimalConditionID: Condition (key)
• intakesOwnerrequestedeuthanasiaDate: Date (datetime)
• intakesOwnerrequestedeuthanasiaNotes: Notes (string)
• intakesOwnerrequestedeuthanasiaOwnerID: Owner (key)
• intakesOwnerrequestedeuthanasiaReasonID: Euthanasia Reason (key)

6. change

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakesOwnerrequestedeuthanasiaAnimalID: Animal (key)
• intakesOwnerrequestedeuthanasiaAnimalConditionID: Condition (key)
• intakesOwnerrequestedeuthanasiaDate: Date (datetime)
• intakesOwnerrequestedeuthanasiaNotes: Notes (string)
• intakesOwnerrequestedeuthanasiaOwnerID: Owner (key)
• intakesOwnerrequestedeuthanasiaReasonID: Euthanasia Reason (key)

intakesOwnersurrenders

Actions:

1. define
2. view
3. search
4. add
5. edit
6. change

1. define

Permissions

User permissions required: AnimalAdd

2. view

Permissions

User permissions required: AnimalAdd

Fields

• intakesOwnersurrenderID: Owner Surrender ID (key)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakesOwnersurrenderID: Owner Pickup ID (key)
• intakesOwnersurrenderAnimalID: Animal ID (key)
• intakesOwnersurrenderAnimalConditionID: Condition ID (key)
• intakesOwnersurrenderDate: Date (datetime)
• intakesOwnersurrenderNotes: Notes (string)
• intakesOwnersurrenderOwnerID: Surrendered By (key)
• intakesOwnersurrenderReasonID: Surrender Reason (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• ownerName: Surrendered By (string)
• surrenderReason: Surrender Reason (string)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• intakesOwnersurrenderAnimalID: Animal (key)
• intakesOwnersurrenderAnimalConditionID: Condition (key)
• intakesOwnersurrenderDate: Date (datetime)
• intakesOwnersurrenderNotes: Notes (string)
• intakesOwnersurrenderOwnerID: Surrendered By (key)
• intakesOwnersurrenderReasonID: Surrender Reason (key)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• intakesOwnersurrenderID: Owner Pickup ID (key)
• intakesOwnersurrenderAnimalID: Animal (key)
• intakesOwnersurrenderAnimalConditionID: Condition (key)
• intakesOwnersurrenderDate: Date (datetime)
• intakesOwnersurrenderNotes: Notes (string)
• intakesOwnersurrenderOwnerID: Surrendered By (key)
• intakesOwnersurrenderReasonID: Surrender Reason (key)

6. change

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakesOwnersurrenderAnimalID: Animal (key)
• intakesOwnersurrenderAnimalConditionID: Condition (key)
• intakesOwnersurrenderDate: Date (datetime)
• intakesOwnersurrenderNotes: Notes (string)
• intakesOwnersurrenderOwnerID: Surrendered By (key)
• intakesOwnersurrenderReasonID: Surrender Reason (key)

intakesServices

Actions:

1. define
2. view
3. search
4. add
5. edit
6. change

1. define

Permissions

User permissions required: AnimalAdd

2. view

Permissions

User permissions required: AnimalAdd

Fields

• intakesServiceID: Service ID (key)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakesServiceID: Owner Pickup ID (key)
• intakesServiceAnimalID: Animal ID (key)
• intakesServiceAnimalConditionID: Condition ID (key)
• intakesServiceDate: Date (datetime)
• intakesServiceNotes: Notes (string)
• intakesServiceOwnerID: Owner (key)
• intakesServiceServicetypeID: Service (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• ownerName: Owner (string)
• serviceName: Service (string)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• intakesServiceAnimalID: Animal (key)
• intakesServiceAnimalConditionID: Condition (key)
• intakesServiceDate: Date (datetime)
• intakesServiceNotes: Notes (string)
• intakesServiceOwnerID: Owner (key)
• intakesServiceServicetypeID: Service (key)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• intakesServiceID: Owner Pickup ID (key)
• intakesServiceAnimalID: Animal (key)
• intakesServiceAnimalConditionID: Condition (key)
• intakesServiceDate: Date (datetime)
• intakesServiceNotes: Notes (string)
• intakesServiceOwnerID: Owner (key)
• intakesServiceServicetypeID: Service (key)

6. change

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakesServiceAnimalID: Animal (key)
• intakesServiceAnimalConditionID: Condition (key)
• intakesServiceDate: Date (datetime)
• intakesServiceNotes: Notes (string)
• intakesServiceOwnerID: Owner (key)
• intakesServiceServicetypeID: Service (key)

intakesStraydropoffs

Actions:

1. define
2. view
3. search
4. add
5. edit
6. change

1. define

Permissions

User permissions required: AnimalAdd

2. view

Permissions

User permissions required: AnimalAdd

Fields

• intakesStraydropoffID: Stray Pickup ID (key)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakesStraydropoffID: Stray Pickup ID (key)
• intakesStraydropoffAnimalID: Animal ID (key)
• intakesStraydropoffAnimalConditionID: Condition ID (key)
• intakesStraydropoffDate: Date (datetime)
• intakesStraydropoffNotes: Notes (string)
• intakesStraydropoffFoundLocation: Found Location (string)
• intakesStraydropoffFoundAddress: Found Street address (string)
• intakesStraydropoffFoundCity: Found City (string)
• intakesStraydropoffFoundState: Found State/Province (province)
• intakesStraydropoffFoundPostalcode: Found Postal Code (postalcode)
• intakesStraydropoffFinderID: Dropped off by (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• finderName: Dropped off by (string)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• intakesStraydropoffAnimalID: Animal (key)
• intakesStraydropoffAnimalConditionID: Condition (key)
• intakesStraydropoffDate: Date (datetime)
• intakesStraydropoffNotes: Notes (string)
• intakesStraydropoffFoundLocation: Found Location (string)
• intakesStraydropoffFoundAddress: Found Street Address (string)
• intakesStraydropoffFoundCity: Found City (string)
• intakesStraydropoffFoundState: Found State/Province (province)
• intakesStraydropoffFoundPostalcode: Found Postal Code (postalcode)
• intakesStraydropoffFinderID: Dropped off by (key)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• intakesStraydropoffID: Stray Dropoff ID (key)
• intakesStraydropoffAnimalID: Animal (key)
• intakesStraydropoffAnimalConditionID: Condition (key)
• intakesStraydropoffDate: Date (datetime)
• intakesStraydropoffNotes: Notes (string)
• intakesStraydropoffFoundLocation: Found Location (string)
• intakesStraydropoffFoundAddress: Found Street Address (string)
• intakesStraydropoffFoundCity: Found City (string)
• intakesStraydropoffFoundState: Found State/Province (province)
• intakesStraydropoffFoundPostalcode: Found Postal Code (postalcode)
• intakesStraydropoffFinderID: Dropped off by (key)

6. change

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakesStraydropoffAnimalID: Animal (key)
• intakesStraydropoffAnimalConditionID: Condition (key)
• intakesStraydropoffDate: Date (datetime)
• intakesStraydropoffNotes: Notes (string)
• intakesStraydropoffFoundLocation: Found Location (string)
• intakesStraydropoffFoundAddress: Found Street Address (string)
• intakesStraydropoffFoundCity: Found City (string)
• intakesStraydropoffFoundState: Found State/Province (province)
• intakesStraydropoffFoundPostalcode: Found Postal Code (postalcode)
• intakesStraydropoffFinderID: Dropped off by (key)

intakesStraypickups

Actions:

1. define
2. view
3. search
4. add
5. edit
6. change

1. define

Permissions

User permissions required: AnimalAdd

2. view

Permissions

User permissions required: AnimalAdd

Fields

• intakesStraypickupID: Stray Pickup ID (key)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakesStraypickupID: Stray Pickup ID (key)
• intakesStraypickupAnimalID: Animal ID (key)
• intakesStraypickupAnimalConditionID: Condition ID (key)
• intakesStraypickupDate: Date (datetime)
• intakesStraypickupNotes: Notes (string)
• intakesStraypickupLocation: Pickup Location (string)
• intakesStraypickupAddress: Pickup Street address (string)
• intakesStraypickupCity: Pickup City (string)
• intakesStraypickupState: Pickup State/Province (province)
• intakesStraypickupPostalcode: Pickup Postal Code (postalcode)
• intakesStraypickupFinderID: Found By (key)
• intakesStraypickupStaffID: Pickup By (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• finderName: Found by (string)
• pickupstaffName: Pickup by (string)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• intakesStraypickupAnimalID: Animal (key)
• intakesStraypickupAnimalConditionID: Condition (key)
• intakesStraypickupDate: Date (datetime)
• intakesStraypickupNotes: Notes (string)
• intakesStraypickupLocation: Pickup Location (string)
• intakesStraypickupAddress: Pickup Street address (string)
• intakesStraypickupCity: Pickup City (string)
• intakesStraypickupState: Pickup State/Province (province)
• intakesStraypickupPostalcode: Pickup Postal Code (postalcode)
• intakesStraypickupFinderID: Found By (key)
• intakesStraypickupStaffID: Pickup By (key)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• intakesStraypickupID: Stray Pickup ID (key)
• intakesStraypickupAnimalID: Animal (key)
• intakesStraypickupAnimalConditionID: Condition (key)
• intakesStraypickupDate: Date (datetime)
• intakesStraypickupNotes: Notes (string)
• intakesStraypickupLocation: Pickup Location (string)
• intakesStraypickupAddress: Pickup Street address (string)
• intakesStraypickupCity: Pickup City (string)
• intakesStraypickupState: Pickup State/Province (province)
• intakesStraypickupPostalcode: Pickup Postal Code (postalcode)
• intakesStraypickupFinderID: Found By (key)
• intakesStraypickupStaffID: Pickup By (key)

6. change

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakesStraypickupAnimalID: Animal (key)
• intakesStraypickupAnimalConditionID: Condition (key)
• intakesStraypickupDate: Date (datetime)
• intakesStraypickupNotes: Notes (string)
• intakesStraypickupLocation: Pickup Location (string)
• intakesStraypickupAddress: Pickup Street address (string)
• intakesStraypickupCity: Pickup City (string)
• intakesStraypickupState: Pickup State/Province (province)
• intakesStraypickupPostalcode: Pickup Postal Code (postalcode)
• intakesStraypickupFinderID: Found By (key)
• intakesStraypickupStaffID: Pickup By (key)

intakesTransfers

Actions:

1. define
2. view
3. search
4. add
5. edit
6. change

1. define

Permissions

User permissions required: AnimalAdd

2. view

Permissions

User permissions required: AnimalAdd

Fields

• intakesTransferID: Owner Surrender ID (key)

3. search

Permissions

User permissions required: AnimalAdd

Fields

• intakesTransferID: Owner Pickup ID (key)
• intakesTransferAnimalID: Animal ID (key)
• intakesTransferAnimalConditionID: Condition ID (key)
• intakesTransferDate: Date (datetime)
• intakesTransferNotes: Notes (string)
• intakesTransferFromID: Transferred From (key)
• intakesTransferCoalitionMember: Coalition Member (string from values list)
• intakesTransferReasonID: Surrender Reason (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• transferFromName: Transfer From (string)
• transferReason: Transfer Reason (string)

4. add

Permissions

User permissions required: AnimalAdd

Fields

• intakesTransferAnimalID: Animal (key)
• intakesTransferAnimalConditionID: Condition (key)
• intakesTransferDate: Date (datetime)
• intakesTransferNotes: Notes (string)
• intakesTransferFromID: Transferred From (key)
• intakesTransferCoalitionMember: Coalition Member (string from values list)
• intakesTransferReasonID: Transfer Reason (key)

5. edit

Permissions

User permissions required: AnimalAdd

Fields

• intakesTransferID: Owner Pickup ID (key)
• intakesTransferAnimalID: Animal (key)
• intakesTransferAnimalConditionID: Condition (key)
• intakesTransferDate: Date (datetime)
• intakesTransferNotes: Notes (string)
• intakesTransferFromID: Transferred From (key)
• intakesTransferCoalitionMember: Coalition Member (string from values list)
• intakesTransferReasonID: Transfer Reason (key)

6. change

Permissions

User permissions required: AnimalAdd

Fields

• intakeID: Intake ID (key)
• intakesTransferAnimalID: Animal (key)
• intakesTransferAnimalConditionID: Condition (key)
• intakesTransferDate: Date (datetime)
• intakesTransferNotes: Notes (string)
• intakesTransferFromID: Transferred From (key)
• intakesTransferCoalitionMember: Coalition Member (string from values list)
• intakesTransferReasonID: Transfer Reason (key)

intakesServicetypes

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

Fields

• intakeServices: Service (string)

3. view

Permissions

User permissions required: AnimalAdd

Fields

• serviceID: Service ID (key)

4. search

Permissions

User permissions required: AnimalAdd

Fields

• serviceID: Service ID (key)
• serviceName: Service (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• serviceName: Service (string)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• serviceID: Service ID (key)
• serviceName: Service (string)

7. delete

Permissions

User permissions required: AnimalAdd

Fields

• serviceID: Service ID (key)

inventoryitems

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• inventoryitems: Inventory Item (string)

3. view

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryitemID: ID (key)

4. search

Permissions

User permissions required: Volunteer

Fields

• inventoryitemID: ID (key)
• inventoryitemName: Name (string)
• inventoryitemItemID: Item Number/ID (string)
• inventoryitemDescription: Description (string)
• inventoryitemReceivedDate: Received Date (date)
• inventoryitemSource: Source (string)
• inventoryitemCost: Cost (decimal)
• inventoryitemConditionID: Condition (key)
• inventoryitemCondition: Condition (string)
• inventoryitemCategory: Category (string)
• inventoryitemDisposedDate: Disposed Date (date)
• inventoryitemDisposedDestination: Disposed Destination (string)
• inventoryitemStorageLocation: Storage Location (string)
• inventoryitemFiles: Files (int)
• inventoryitemLoaners: Loaners (int)

5. add

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryitemName: Name (string)
• inventoryitemItemID: Item Number/ID (string)
• inventoryitemDescription: Description (string)
• inventoryitemReceivedDate: Received Date (date)
• inventoryitemSource: Source (string)
• inventoryitemCost: Cost (decimal)
• inventoryitemConditionID: Condition (key)
• inventoryitemCategory: Category (string)
• inventoryitemDisposedDate: Disposed Date (date)
• inventoryitemDisposedDestination: Disposed Destination (string)
• inventoryitemStorageLocation: Storage Location (string)
• inventoryitemQuantity: Quantity (int)

6. edit

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryitemID: ID (key)
• inventoryitemName: Name (string)
• inventoryitemItemID: Item Number/ID (string)
• inventoryitemDescription: Description (string)
• inventoryitemReceivedDate: Received Date (date)
• inventoryitemSource: Source (string)
• inventoryitemCost: Cost (decimal)
• inventoryitemConditionID: Condition (key)
• inventoryitemCategory: Category (string)
• inventoryitemDisposedDate: Disposed Date (date)
• inventoryitemDisposedDestination: Disposed Destination (string)
• inventoryitemStorageLocation: Storage Location (string)

7. delete

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryitemID: ID (key)

inventoryitemsConditions

Actions:

1. define
2. list

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• conditions: Condition (string)

inventoryfiles

Actions:

1. define
2. list
3. search
4. view
5. add
6. edit

1. define

Permissions

User permissions required: InventoryAdmin

2. list

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryfile: File (string)

3. search

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryfileID: File ID (key)
• inventoryfileOldName: Old file name (string)
• inventoryfileDescription: Description (string)
• inventoryfileStatus: Status (string from values list)
• inventoryfileDisplayInline: Inline (string from values list)
• inventoryfileSize: File size (int)
• inventoryfileCreatedDate: Created Date (date)
• inventoryfileItemID: ID (key)
• inventoryitemName: Name (string)
• inventoryitemDescription: Description (string)
• inventoryitemReceivedDate: Received Date (date)
• inventoryitemSource: Source (string)
• inventoryitemCost: Cost (decimal)
• inventoryitemConditionID: Condition (key)
• inventoryitemCondition: Condition (string)
• inventoryitemCategory: Category (string)
• inventoryitemDisposedDate: Disposed Date (date)
• inventoryitemDisposedDestination: Disposed Destination (string)
• inventoryitemStorageLocation: Storage Location (string)
• inventoryitemFiles: Files (int)
• inventoryitemLoaners: Loaners (int)

4. view

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryfileID: File ID (key)

5. add

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryfileItemID: Inventory Item (key)
• inventoryfileBinary: File (binary)
• inventoryfileOldFileName: Old file name (string)
• inventoryfileDescription: Description (string)
• inventoryfileStatus: Status (string from values list)
• inventoryfileDisplayInline: Inline (string from values list)

6. edit

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryfileID: File ID (key)
• inventoryfileItemID: Inventory Item (key)
• inventoryfileDescription: Description (string)
• inventoryfileStatus: Status (string from values list)
• inventoryfileDisplayInline: Inline (string from values list)

inventoryLoaners

Actions:

1. define
2. view
3. search
4. add
5. edit
6. delete

1. define

Permissions

User permissions required: InventoryAdmin

2. view

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryLoanerID: ID (key)

3. search

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryLoanerID: ID (key)
• inventoryLoanerContactID: Contact (key)
• inventoryLoanerItemID: Item (key)
• inventoryLoanerLoanDate: Loan Date (date)
• inventoryLoanerLoanCondition: Loan Condition (string)
• inventoryLoanerLoanConditionID: Loan Condition (key)
• inventoryLoanerDueDate: Due Date (date)
• inventoryLoanerReturnDate: Return Date (date)
• inventoryLoanerReturnCondition: Return Condition (string)
• inventoryLoanerReturnConditionID: Return Condition (key)
• inventoryLoanerNotes: Notes (string)
• inventoryLoanerLastDueReminderDate: Due Reminder Date (datetime)
• inventoryitemName: Item Name (string)
• inventoryitemDescription: Description (string)
• inventoryitemReceivedDate: Received Date (date)
• inventoryitemSource: Source (string)
• inventoryitemCost: Cost (decimal)
• inventoryitemConditionID: Condition (key)
• inventoryitemCondition: Condition (string)
• inventoryitemCategory: Category (string)
• inventoryitemDisposedDate: Disposed Date (date)
• inventoryitemDisposedDestination: Disposed Destination (string)
• inventoryitemStorageLocation: Storage Location (string)
• contactClass: Class (string from values list)
• contactSalutation: Salutation (string from values list)
• contactName: Name (string)
• contactFirstname: First name (string)
• contactLastname: Last name (string)
• contactTitle: Title (string)
• contactAddress: Street address (string)
• contactCity: City (string)
• contactState: State/Province (province)
• contactPostalcode: Postal Code (postalcode)
• contactPlus4: Zip code plus 4 (string)
• contactCounty: County (string)
• contactCountry: Country (key)
• contactPhoneHome: Home phone number (phone)
• contactPhoneWork: Work phone number (phone)
• contactPhoneWorkExt: Work phone extension (string)
• contactPhoneCell: Cell phone number (phone)
• contactFax: Fax number (phone)
• contactEmail: Email address (email)
• contactEmailAlt: Alternate email address (email)
• contactEmailPager: Pager email address (email)
• contactCompany: Company (string)
• contactReferredBy: Referred by (string)
• contactCarrier: Carrier (string)
• contactBounces: Number of bounced email messages (int)
• contactSendMail: Send mail (string from values list)
• contactActive: Active (string from values list)
• contactComment: Comment (string)
• contactTransportation: Transportation (string)
• contactAvailability: Availability (string)
• contactCaretakerPublic: Caretaker public (string from values list)
• contactCoalitionMember: Coalition member (string from values list)
• contactGroups: Groups (key)
• contactAdded: Contact Added (string from values list)

4. add

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryLoanerContactID: Contact (key)
• inventoryLoanerItemID: Item (key)
• inventoryLoanerLoanDate: Loan Date (date)
• inventoryLoanerLoanConditionID: Loan Condition (key)
• inventoryLoanerDueDate: Due Date (date)
• inventoryLoanerReturnDate: Return Date (date)
• inventoryLoanerReturnConditionID: Return Condition (key)
• inventoryLoanerNotes: Notes (string)

5. edit

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryLoanerID: Loaner ID (key)
• inventoryLoanerItemID: Item (key)
• inventoryLoanerLoanDate: Loan Date (date)
• inventoryLoanerLoanConditionID: Loan Condition (key)
• inventoryLoanerDueDate: Due Date (date)
• inventoryLoanerReturnDate: Return Date (date)
• inventoryLoanerReturnConditionID: Return Condition (key)
• inventoryLoanerNotes: Notes (string)

6. delete

Permissions

User permissions required: InventoryAdmin

Fields

• inventoryLoanerID: ID (key)

locations

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. delete

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• locations: Location (string)

3. view

Permissions

User permissions required: Volunteer

Fields

• locationID: ID (key)

4. search

Permissions

User permissions required: Volunteer

Fields

• locationID: ID (key)
• locationName: Name (string)
• locationUrl: Web address (url)
• locationAddress: Street address (string)
• locationCity: City (string)
• locationState: State/Province (province)
• locationPostalcode: Postal Code (postalcode)
• locationCountry: Country (key)
• locationPhone: Phone (phone)
• locationPhoneExt: Phone extension (string)
• locationAnimals: Animals (int)
• locationEvents: Events (int)
• locationColonies: Colonies (int)
• locationMeetrequests: Meet Requests (int)

5. add

Permissions

User permissions required: Volunteer

Fields

• locationName: Name (string)
• locationUrl: Web address (url)
• locationAddress: Street address (string)
• locationCity: City (string)
• locationState: State/Province (province)
• locationPostalcode: Postal Code (postalcode)
• locationCountry: Country (key)
• locationPhone: Phone (phone)
• locationPhoneExt: Phone Extension (string)

6. edit

Permissions

User permissions required: Volunteer

Fields

• locationID: ID (key)
• locationName: Name (string)
• locationUrl: Web address (url)
• locationAddress: Street address (string)
• locationCity: City (string)
• locationState: State/Province (province)
• locationPostalcode: Postal Code (postalcode)
• locationCountry: Country (key)
• locationPhone: Phone (phone)
• locationPhoneExt: Phone Extension (string)

7. delete

Permissions

User permissions required: Volunteer

Fields

• locationID: ID (key)

memorials

Actions:

1. define
2. view
3. search
4. add
5. edit
6. delete
7. getSettings
8. updateSettings

1. define

Permissions

User permissions required: MemorialsAdmin

2. view

Permissions

User permissions required: MemorialsAdmin

Fields

• memorialID: Memorial ID (key)

3. search

Permissions

User permissions required: MemorialsAdmin

Fields

• memorialID: Memorial ID (key)
• memorialPictureFileName: File name (string)
• memorialPictureUrl: Url (string)
• memorialPictureThumbnailUrl: Url (string)
• memorialName: File name (string)
• memorialDescription: Description (string)
• memorialOrder: Order (integer)

4. add

Permissions

User permissions required: MemorialsAdmin

Fields

• memorialPictureBinary: File (binary)
• memorialName: File name (string)
• memorialPictureOldFileName: Old file name (string)
• memorialDescription: Description (string)
• memorialOrder: Order (integer)

5. edit

Permissions

User permissions required: MemorialsAdmin

Fields

• memorialID: Memorial ID (key)
• memorialPictureBinary: File (binary)
• memorialPictureOldFileName: Old file name (string)
• memorialName: File name (string)
• memorialDescription: Description (string)

6. delete

Permissions

User permissions required: MemorialsAdmin

Fields

• memorialID: Memorial ID (key)

7. getSettings

Permissions

User permissions required: MemorialsAdmin

8. updateSettings

Permissions

User permissions required: MemorialsAdmin

Fields

• enableMemorials: Enable the Memorials feature (string from values list)
• setMemorialsDonationOnlineStoreItem: Select Memorials donation store item (int)
• showMemorialsAlphaLinks: Show alphabetical links (A-Z) on the Memorials page (string from values list)

microchipRegistrations

Actions:

1. define
2. view
3. search
4. add
5. getSettings
6. updateSettings

1. define

Permissions

User permissions required: AnimalFosterUpdate

2. view

Permissions

User permissions required: AnimalFosterUpdate

Fields

• microchipRegistrationID: ID (key)

3. search

Permissions

User permissions required: AnimalFosterUpdate

Fields

• microchipRegistrationID: ID (key)
• microchipRegistrationCreatedDate: Created (date)
• microchipRegistrationCreatedByID: Created by (int)
• microchipRegistrationUpdatedDate: Last updated (date)
• microchipRegistrationUpdatedByID: Updated By (int)
• microchipRegistrationMicrochipNumber: Microchip number (microchipnumber)
• microchipRegistrationMicrochipVendor: Microchip vendor (string)
• microchipRegistrationRegistry: Registry (string from values list)
• microchipRegistrationOrgID: Org ID (key)
• microchipRegistrationAnimalID: Animal ID (key)
• microchipRegistrationRegistrantName: Name (string)
• microchipRegistrationRegistrantFirstname: First name (string)
• microchipRegistrationRegistrantLastname: Last name (string)
• microchipRegistrationRegistrantAddress: Street address (string)
• microchipRegistrationRegistrantCity: City (string)
• microchipRegistrationRegistrantState: State/Province (province)
• microchipRegistrationRegistrantPostalcode: Postal Code (postalcode)
• microchipRegistrationRegistrantCountry: Country (key)
• microchipRegistrationRegistrantPrimaryPhone: Primary phone number (phone)
• microchipRegistrationRegistrantSecondaryPhone: Secondary phone number (phone)
• microchipRegistrationRegistrantPrimaryEmail: Primary email address (email)
• microchipRegistrationRegistrantSecondaryEmail: Secondary email address (email)
• microchipRegistrationDate: Registration Date (date)
• microchipRegistrationCode: Confimation Code (string)
• microchipRegistrationComplete: Registration Complete (string from values list)

4. add

Permissions

User permissions required: AnimalFosterUpdate

Fields

• microchipRegistrationAnimalID: Animal ID (key)
• microchipRegistrationMicrochipNumber: Microchip number (microchipnumber)
• microchipRegistrationMicrochipVendor: Microchip vendor (string)
• microchipRegistrationRegistry: Registry (string from values list)
• microchipRegistrationRegistrantFirstname: First name (string)
• microchipRegistrationRegistrantLastname: Last name (string)
• microchipRegistrationRegistrantAddress: Street address (string)
• microchipRegistrationRegistrantCity: City (string)
• microchipRegistrationRegistrantState: State/Province (province)
• microchipRegistrationRegistrantPostalcode: Postal Code (postalcode)
• microchipRegistrationRegistrantCountry: Country (key)
• microchipRegistrationRegistrantPrimaryPhone: Primary phone number (phone)
• microchipRegistrationRegistrantSecondaryPhone: Secondary phone number (phone)
• microchipRegistrationRegistrantPrimaryEmail: Primary email address (email)
• microchipRegistrationRegistrantSecondaryEmail: Secondary email address (email)

5. getSettings

Permissions

User permissions required: OptionsAdmin

6. updateSettings

Permissions

User permissions required: OptionsAdmin

Fields

• setFreePetChipRegistryUserName: FreePetChipRegistry user name (string)
• enableFreePetChipRegistry: Enable FreePetChipRegistry registrations (string from values list)
• disableMicrochipUserAlert: Disable the email alert to the volunteer concerning microchip registration (success or failure) (string from values list)
• setMicrochipAlertEmails: Email address(es) to alert concerning microchip registration (success or failure) (string)

microchipVendors

Actions:

1. define
2. list

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• microchipVendors: Microchip Vendor (string)

newsarticles

Actions:

1. define
2. publicView
3. view
4. publicSearch
5. search
6. add
7. edit
8. delete
9. getSettings
10. updateSettings

1. define

Permissions

User permissions required: Volunteer

2. publicView

Permissions

Public

Fields

• articleID: ID (key)

3. view

Permissions

User permissions required: Volunteer

Fields

• articleID: ID (key)

4. publicSearch

Permissions

Public

Fields

• articleID: News Article ID (key)
• articleOrgID: Organization ID (key)
• articleTitle: Title (string)
• articleDescription: Description (string)
• articleDate: Date (date)
• articleUpdatedDate: Last updated (datetime)

5. search

Permissions

User permissions required: Volunteer

Fields

• articleID: News Article ID (key)
• articleTitle: Title (string)
• articleDescription: Description (string)
• articleDate: Date (date)
• articleUpdatedDate: Last updated (datetime)

6. add

Permissions

User permissions required: NewsAdmin

Fields

• articleTitle: Title (string)
• articleDescription: Description (string)
• articleDate: Date (date)

7. edit

Permissions

User permissions required: NewsAdmin

Fields

• articleID: News Article ID (key)
• articleTitle: Title (string)
• articleDescription: Description (string)
• articleDate: Date (date)

8. delete

Permissions

User permissions required: NewsAdmin

Fields

• articleID: ID (key)

9. getSettings

Permissions

User permissions required: NewsAdmin

10. updateSettings

Permissions

User permissions required: NewsAdmin

Fields

• enableNewsarticles: Enable the News Articles feature (string from values list)

orgs

Actions:

1. define
2. list
3. publicView
4. publicSearch

1. define

Permissions

Public

2. list

Permissions

User permissions required: Volunteer

Fields

• orgs: Org (string)

3. publicView

Permissions

Public

Fields

• orgID: ID (key)

4. publicSearch

Permissions

Public

Fields

• orgID: ID (key)
• orgLocation: Location (postalcode)
• orgName: Name (string)
• orgAddress: Address (string)
• orgCity: City (string)
• orgState: State/Province (province)
• orgPostalcode: Postal Code (postalcode)
• orgPlus4: Plus 4 (string)
• orgCountry: Country (key)
• orgPhone: Phone (phone)
• orgFax: Fax (phone)
• orgEmail: Email (email)
• orgWebsiteUrl: Url (url)
• orgFacebookUrl: Facebook Url (url)
• orgAdoptionUrl: Url (url)
• orgDonationUrl: Url (url)
• orgSponsorshipUrl: Url (url)
• orgServeAreas: Serve Areas (string)
• orgAdoptionProcess: Adoption Process (string)
• orgAbout: About (string)
• orgServices: Services (string)
• orgMeetPets: Meet Pets (string)
• orgType: Org Type (string from values list)
• orgLocationDistance: Distance (int)
• orgCommonapplicationAccept: Accepting common application submissions (string from values list)

outcomes

Actions:

1. define
2. list
3. search
4. view

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. search

Permissions

User permissions required: AnimalAdd

Fields

• outcomeID: Outcome ID (key)
• outcomeAnimalConditionID: Condition ID (key)
• outcomeType: Type (string from values list)
• outcomeDate: Date (datetime)
• outcomeNotes: Notes (string)
• intakeID: Intake ID (key)
• intakeAnimalID: Animal ID (key)
• animalName: Animal (string)
• outcomeAnimalConditionName: Condition (string)

4. view

Permissions

User permissions required: AnimalAdd

Fields

• outcomeID: Outcome ID (key)

outcomesAdoptions

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. change

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. view

Permissions

User permissions required: AnimalAdd

Fields

• outcomesAdoptionID: Outcome Adoption ID (key)

4. search

Permissions

User permissions required: AnimalAdd

Fields

• outcomesAdoptionID: Outcome Adoption ID (key)
• outcomesAdoptionIntakeID: Outcome Adoption Intake ID (key)
• outcomesAdoptionAnimalConditionID: Condition ID (key)
• outcomesAdoptionDate: Date (datetime)
• outcomesAdoptionNotes: Notes (string)
• outcomesAdoptionAdoptionID: Adoption (key)
• animalID: Animal (string)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• adopterContactID: Adopter Contact ID (string)
• ownerName: Owner (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• outcomesAdoptionIntakeID: Outcome Adoption Intake (key)
• outcomesAdoptionAnimalConditionID: Condition (key)
• outcomesAdoptionDate: Date (datetime)
• outcomesAdoptionNotes: Notes (string)
• outcomesAdoptionAdoptionID: Adoption (key)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• outcomesAdoptionID: Outcome Adoption ID (key)
• outcomesAdoptionAnimalConditionID: Condition (key)
• outcomesAdoptionDate: Date (datetime)
• outcomesAdoptionNotes: Notes (string)
• outcomesAdoptionAdoptionID: Adoption (key)

7. change

Permissions

User permissions required: AnimalAdd

Fields

• outcomeID: Outcome ID (key)
• outcomesAdoptionAnimalConditionID: Condition (key)
• outcomesAdoptionDate: Date (datetime)
• outcomesAdoptionNotes: Notes (string)
• outcomesAdoptionAdoptionID: Adoption (key)

outcomesDeceased

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. change

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. view

Permissions

User permissions required: AnimalAdd

Fields

• outcomesDeceasedID: Outcome Deceased ID (key)

4. search

Permissions

User permissions required: AnimalAdd

Fields

• outcomesDeceasedID: Outcome Deceased ID (key)
• outcomesDeceasedIntakeID: Outcome Deceased Intake ID (key)
• outcomesDeceasedAnimalConditionID: Condition ID (key)
• outcomesDeceasedDate: Date (datetime)
• outcomesDeceasedNotes: Notes (string)
• outcomesDeceasedReason: Reason (string)
• animalID: Animal (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• outcomesDeceasedIntakeID: Outcome Deceased Intake ID (key)
• outcomesDeceasedAnimalConditionID: Condition (key)
• outcomesDeceasedDate: Date (datetime)
• outcomesDeceasedNotes: Notes (string)
• outcomesDeceasedReason: Reason (string)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• outcomesDeceasedID: Outcome Deceased ID (key)
• outcomesDeceasedAnimalConditionID: Condition ID (key)
• outcomesDeceasedDate: Date (datetime)
• outcomesDeceasedNotes: Notes (string)
• outcomesDeceasedReason: Reason (string)

7. change

Permissions

User permissions required: AnimalAdd

Fields

• outcomeID: Outcome ID (key)
• outcomesDeceasedAnimalConditionID: Condition ID (key)
• outcomesDeceasedDate: Date (datetime)
• outcomesDeceasedNotes: Notes (string)
• outcomesDeceasedReason: Reason (string)

outcomesEuthanasias

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. change

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. view

Permissions

User permissions required: AnimalAdd

Fields

• outcomesEuthanasiaID: Outcome Euthanasia ID (key)

4. search

Permissions

User permissions required: AnimalAdd

Fields

• outcomesEuthanasiaID: Outcome Euthanasia ID (key)
• outcomesEuthanasiaIntakeID: Outcome Euthanasia Intake ID (key)
• outcomesEuthanasiaAnimalConditionID: Condition ID (key)
• outcomesEuthanasiaDate: Date (datetime)
• outcomesEuthanasiaNotes: Notes (string)
• outcomesEuthanasiaReasonID: Euthanasia Reason ID (key)
• outcomesEuthanasiaReason: Euthanasia Reason (string)
• animalID: Animal (string)
• animalName: Animal (string)
• animalConditionName: Condition (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• outcomesEuthanasiaIntakeID: Outcome Euthanasia Intake ID (key)
• outcomesEuthanasiaAnimalConditionID: Condition (key)
• outcomesEuthanasiaDate: Date (datetime)
• outcomesEuthanasiaNotes: Notes (string)
• outcomesEuthanasiaReasonID: Euthanasia Reason (key)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• outcomesEuthanasiaID: Outcome Euthanasia ID (key)
• outcomesEuthanasiaAnimalConditionID: Condition (key)
• outcomesEuthanasiaDate: Date (datetime)
• outcomesEuthanasiaNotes: Notes (string)
• outcomesEuthanasiaReasonID: Euthanasia Reason (key)

7. change

Permissions

User permissions required: AnimalAdd

Fields

• outcomeID: Outcome ID (key)
• outcomesEuthanasiaAnimalConditionID: Condition (key)
• outcomesEuthanasiaDate: Date (datetime)
• outcomesEuthanasiaNotes: Notes (string)
• outcomesEuthanasiaReasonID: Euthanasia Reason (key)

outcomesReleases

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. change

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. view

Permissions

User permissions required: AnimalAdd

Fields

• outcomesReleaseID: Outcome Release ID (key)

4. search

Permissions

User permissions required: AnimalAdd

Fields

• outcomesReleaseID: Outcome Release ID (key)
• outcomesReleaseIntakeID: Outcome Release Intake ID (key)
• outcomesReleaseAnimalConditionID: Condition ID (key)
• outcomesReleaseDate: Date (datetime)
• outcomesReleaseNotes: Notes (string)
• outcomesReleaseLocation: Location (string)
• outcomesReleaseAddress: Street address (string)
• outcomesReleaseCity: City (string)
• outcomesReleaseState: State/Province (province)
• outcomesReleasePostalcode: Postal Code (postalcode)
• outcomesReleaseByID: Released By (key)
• animalID: Animal (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• releaseByName: Released By (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• outcomesReleaseIntakeID: Outcome Release Intake ID (key)
• outcomesReleaseAnimalConditionID: Condition (key)
• outcomesReleaseDate: Date (datetime)
• outcomesReleaseNotes: Notes (string)
• outcomesReleaseLocation: Location (string)
• outcomesReleaseAddress: Street address (string)
• outcomesReleaseCity: City (string)
• outcomesReleaseState: State/Province (province)
• outcomesReleasePostalcode: Postal Code (postalcode)
• outcomesReleaseByID: Released By (key)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• outcomesReleaseID: Outcome Release ID (key)
• outcomesReleaseAnimalConditionID: Condition (key)
• outcomesReleaseDate: Date (datetime)
• outcomesReleaseNotes: Notes (string)
• outcomesReleaseLocation: Location (string)
• outcomesReleaseAddress: Street address (string)
• outcomesReleaseCity: City (string)
• outcomesReleaseState: State/Province (province)
• outcomesReleasePostalcode: Postal Code (postalcode)
• outcomesReleaseByID: Released By (key)

7. change

Permissions

User permissions required: AnimalAdd

Fields

• outcomeID: Outcome ID (key)
• outcomesReleaseAnimalConditionID: Condition ID (key)
• outcomesReleaseDate: Date (datetime)
• outcomesReleaseNotes: Notes (string)
• outcomesReleaseLocation: Location (string)
• outcomesReleaseAddress: Street address (string)
• outcomesReleaseCity: City (string)
• outcomesReleaseState: State/Province (province)
• outcomesReleasePostalcode: Postal Code (postalcode)
• outcomesReleaseByID: Released By (key)

outcomesReturntoowner

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. change

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. view

Permissions

User permissions required: AnimalAdd

Fields

• outcomesReturntoownerID: Outcome Return ID (key)

4. search

Permissions

User permissions required: AnimalAdd

Fields

• outcomesReturntoownerID: Outcome Return ID (key)
• outcomesReturntoownerIntakeID: Outcome Returntoowner Intake ID (key)
• outcomesReturntoownerAnimalConditionID: Condition ID (key)
• outcomesReturntoownerDate: Date (datetime)
• outcomesReturntoownerNotes: Notes (string)
• outcomesReturntoownerOwnerID: Return To (key)
• animalID: Animal (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• returntoownerName: Owner (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• outcomesReturntoownerIntakeID: Outcome Returntoowner Intake ID (key)
• outcomesReturntoownerAnimalConditionID: Condition (key)
• outcomesReturntoownerDate: Date (datetime)
• outcomesReturntoownerNotes: Notes (string)
• outcomesReturntoownerOwnerID: Return To (key)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• outcomesReturntoownerID: Outcome Returntoowner ID (key)
• outcomesReturntoownerAnimalConditionID: Condition (key)
• outcomesReturntoownerDate: Date (datetime)
• outcomesReturntoownerNotes: Notes (string)
• outcomesReturntoownerOwnerID: Return To (key)

7. change

Permissions

User permissions required: AnimalAdd

Fields

• outcomeID: Outcome ID (key)
• outcomesReturntoownerAnimalConditionID: Condition (key)
• outcomesReturntoownerDate: Date (datetime)
• outcomesReturntoownerNotes: Notes (string)
• outcomesReturntoownerOwnerID: Return To (key)

outcomesTransfers

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit
7. change

1. define

Permissions

User permissions required: AnimalAdd

2. list

Permissions

User permissions required: AnimalAdd

3. view

Permissions

User permissions required: AnimalAdd

Fields

• outcomesTransferID: Outcome Transfer ID (key)

4. search

Permissions

User permissions required: AnimalAdd

Fields

• outcomesTransferID: Outcome Transfer ID (key)
• outcomesTransferIntakeID: Outcome Transfer Intake ID (key)
• outcomesTransferAnimalConditionID: Condition ID (key)
• outcomesTransferDate: Date (datetime)
• outcomesTransferNotes: Notes (string)
• outcomesTransferReceiveID: Received (key)
• outcomesTransferCoalitionMember: Coalition Member (string from values list)
• outcomesTransferReasonID: Transfer Reason (key)
• outcomesTransferReason: Transfer Reason (string)
• animalID: Animal (key)
• animalName: Animal (string)
• animalConditionName: Condition (string)
• receiveName: Receive Name (string)

5. add

Permissions

User permissions required: AnimalAdd

Fields

• outcomesTransferIntakeID: Outcome Transfer Intake ID (key)
• outcomesTransferAnimalConditionID: Condition (key)
• outcomesTransferDate: Date (datetime)
• outcomesTransferNotes: Notes (string)
• outcomesTransferReceiveID: Received by (key)
• outcomesTransferCoalitionMember: Coalition member (string from values list)
• outcomesTransferReasonID: Transfer reason (key)

6. edit

Permissions

User permissions required: AnimalAdd

Fields

• outcomesTransferID: Outcome Transfer ID (key)
• outcomesTransferAnimalConditionID: Condition (key)
• outcomesTransferDate: Date (datetime)
• outcomesTransferNotes: Notes (string)
• outcomesTransferReceiveID: Received by (key)
• outcomesTransferCoalitionMember: Coalition member (string from values list)
• outcomesTransferReasonID: Transfer reason (key)

7. change

Permissions

User permissions required: AnimalAdd

Fields

• outcomeID: Outcome ID (key)
• outcomesTransferAnimalConditionID: Condition (key)
• outcomesTransferDate: Date (datetime)
• outcomesTransferNotes: Notes (string)
• outcomesTransferReceiveID: Received by (key)
• outcomesTransferCoalitionMember: Coalition member (string from values list)
• outcomesTransferReasonID: Transfer reason (key)

partnerships

Actions:

1. define
2. view
3. search
4. request
5. getSettings
6. updateSettings

1. define

Permissions

User permissions required: PartnerAdmin

2. view

Permissions

User permissions required: PartnerAdmin

Fields

• partnershipID: ID (key)

3. search

Permissions

User permissions required: PartnerAdmin

Fields

• partnershipID: ID (key)
• partnershipRequestOrgID: Sharing Org ID (key)
• partnershipRequestOrgName: Sharing Org (key)
• partnershipSharingOrgID: Sharing Org ID (key)
• partnershipSharingOrgName: Sharing Org Name (key)
• partnershipRequestDate: Request Date (datetime)
• partnershipRequestedByID: Requested by ID (key)
• partnershipRequestedBy: Requested by (string)
• partnershipResponseByID: Response by ID (key)
• partnershipResponseBy: Response by (string)
• partnershipStatus: Status (string)
• partnershipResponseDate: Response Date (datetime)

4. request

Permissions

User permissions required: PartnerAdmin

Fields

• partnershipSharingOrgID: Sharing Org ID (key)

5. getSettings

Permissions

User permissions required: PartnerAdmin

6. updateSettings

Permissions

User permissions required: PartnerAdmin

Fields

• enablePartnerships: Enable the Partnerships feature (string from values list)
• setPartnershipAlertEmailAddresses: Partnership alert email address(es) (string)

roles

Actions:

1. define
2. list

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• role: Role (string)

submittedforms

Actions:

1. define
2. list
3. listRecent
4. listPending
5. publicCommonSubmit
6. search

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

3. listRecent

Permissions

User permissions required: Volunteer

4. listPending

Permissions

User permissions required: Volunteer

5. publicCommonSubmit

Permissions

Public

Fields

• submittedformAnimalID: Animal ID (key)
• submitterSalutation: Salutation (string from values list)
• submitterFirstname: First name (string)
• submitterLastname: Last name (string)
• submitterAddress: Street address (string)
• submitterCity: City (string)
• submitterState: State/Province (string)
• submitterPostalcode: Postal Code (postalcode)
• submitterPlus4: Zip code plus 4 (string)
• submitterCounty: County (string)
• submitterCountry: Country (key)
• submitterPhoneHome: Home phone number (phone)
• submitterPhoneWork: Work phone number (phone)
• submitterPhoneWorkExt: Work phone extension (string)
• submitterPhoneCell: Cell phone number (phone)
• submitterFax: Fax number (phone)
• submitterEmail: Email address (email)
• submitterEmailAlt: Alternate email address (email)
• submitterEmailPager: Pager email address (email)
• submitterReferredBy: Referred by (string)
• submittedformAnswers: Answers (string)

6. search

Permissions

User permissions required: Volunteer

Fields

• submittedformID: ID (key)
• submittedformAnimalID: Animal ID (key)
• submittedformAssignedTo: Assigned To (string)
• submittedformAssignedToID: Assigned To ID (key)
• submittedformCommentsCount: Comments Count (int)
• submittedformCommentsInline: Comments (string)
• submittedformCompleted: Completed Date (date)
• submittedformFormName: Form Name (string)
• submittedformPending: Pending (string from values list)
• submittedformStatus: Status (string from values list)
• submittedformStatusID: Status ID (key)
• submittedformStepsCount: Steps Count (int)
• submitterID: ID (key)
• submitterClass: Class (string from values list)
• submitterSalutation: Salutation (string from values list)
• submitterName: Name (string)
• submitterFirstname: First name (string)
• submitterLastname: Last name (string)
• submitterTitle: Title (string)
• submitterAddress: Street address (string)
• submitterCity: City (string)
• submitterState: State/Province (string)
• submitterPostalcode: Postal Code (postalcode)
• submitterPlus4: Zip code plus 4 (string)
• submitterCounty: County (string)
• submitterCountry: Country (key)
• submitterPhoneHome: Home phone number (phone)
• submitterPhoneWork: Work phone number (phone)
• submitterPhoneWorkExt: Work phone extension (string)
• submitterPhoneCell: Cell phone number (phone)
• submitterFax: Fax number (phone)
• submitterEmail: Email address (email)
• submitterEmailAlt: Alternate email address (email)
• submitterEmailPager: Pager email address (email)
• submitterCompany: Company (string)
• submitterReferredBy: Referred by (string)
• submitterCarrier: Carrier (string)
• submitterBounces: Number of bounced email messages (int)
• submitterSendMail: Send mail (string from values list)
• submitterActive: Active (string from values list)
• submitterComment: Comment (string)
• submitterTransportation: Transportation (string)
• submitterAvailability: Availability (string)
• submitterCaretakerPublic: Caretaker public (string from values list)
• submitterCoalitionMember: Coalition member (string from values list)
• submitterGroups: Groups (key)

settings

Actions:

1. define
2. list
3. getUserSetting
4. setUserSetting

1. define

Permissions

User permissions required: Volunteer

2. list

Permissions

User permissions required: Volunteer

Fields

• settings: Setting (string)

3. getUserSetting

Permissions

User permissions required: Volunteer

Fields

• settingName: Pattern (string)

4. setUserSetting

Permissions

User permissions required: Volunteer

Fields

• settingDefaultAnimalTemplate: Default template to load when adding an animal (string)

testimonials

Actions:

1. define
2. publicSearch

1. define

Permissions

Public

2. publicSearch

Permissions

Public

Fields

• testimonialID: Testimonial ID (key)
• testimonialLocation: Location (string)
• testimonialLocationDistance: Distance (string)
• testimonialLocationCitystate: City, State (string)
• testimonialService: Service (string)
• testimonialUserFirstname: User first name (string)
• testimonialCreatedDate: Date (date)
• testimonialContent: Testimonial (string)

users

Actions:

1. define
2. list
3. view
4. search
5. add
6. edit

1. define

Permissions

User permissions required: ContactsAdmin

2. list

Permissions

User permissions required: ContactsAdmin

Fields

• user: User (string)

3. view

Permissions

User permissions required: Volunteer

Fields

• userID: ID (key)

4. search

Permissions

User permissions required: Volunteer

Fields

• userID: ID (key)
• userLogin: Login (string)
• userSalutation: Salutation (string from values list)
• userName: Name (string)
• userFirstname: First name (string)
• userLastname: Last name (string)
• userAddress: Street address (string)
• userCity: City (string)
• userState: State/Province (province)
• userPostalcode: Postal Code (postalcode)
• userPlus4: Zip code plus 4 (string)
• userCountry: Country (key)
• userPhoneHome: Home phone number (phone)
• userPhoneWork: Work phone number (phone)
• userPhoneWorkExt: Work phone extension (string)
• userPhoneCell: Cell phone number (phone)
• userFax: Fax number (phone)
• userEmail: Email address (email)
• userEmailAlt: Alternate email address (email)
• userEmailPager: Pager email address (email)
• userContactID: User Contact ID (key)
• userRegisteredDate: Registration date (date)
• userLastPasswordResetDate: Last password reset date (date)
• userPasswordResetCount: Password reset count (int)

5. add

Permissions

User permissions required: SiteAdmin

Fields

• userLogin: Login (string)
• userPassword: Password (string)
• userSalutation: Salutation (string from values list)
• userFirstname: First name (string)
• userLastname: Last name (string)
• userAddress: Street address (string)
• userCity: City (string)
• userState: State/Province (province)
• userPostalcode: Postal Code (postalcode)
• userPlus4: Zip code plus 4 (string)
• userCountry: Country (key)
• userPhoneHome: Home phone number (phone)
• userPhoneWork: Work phone number (phone)
• userPhoneWorkExt: Work phone extension (string)
• userPhoneCell: Cell phone number (phone)
• userFax: Fax number (phone)
• userEmail: Email address (email)
• userEmailAlt: Alternate email address (email)
• userEmailPager: Pager email address (email)
• userContactID: User Contact ID (key)
• userType: Type (string from values list)