SalesForce Services

<back to all web services

PetRequest

The following routes are available for this service:
DELETE/pet/{id}
PUT/pet/{id}
POST/pet
PetRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
PetbodyPetNo
NameIdbodystringNo
Pet Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TypeformstringNo
NameformstringNo
BreedformstringNo
ColorformstringNo
WeightformstringNo
BirthDateformDateTime?No
VeterinarianNameformstringNo
VeterinarianPhoneformstringNo
MicrochippedformboolNo
ServiceAnimalformboolNo
SfAccountIdformstringNo
StatusformstringNo
IsDeletedformboolNo
PetResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /pet HTTP/1.1 
Host: salesforceapi.avalonbay.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	pet: 
	{
		id: String,
		type: String,
		name: String,
		breed: String,
		color: String,
		weight: String,
		birthDate: 0001-01-01,
		veterinarianName: String,
		veterinarianPhone: String,
		microchipped: False,
		serviceAnimal: False,
		sfAccountId: String,
		status: String,
		isDeleted: False
	},
	nameId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}