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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SalesForceServices.ServiceModel.Request">
  <Id>String</Id>
  <NameId>String</NameId>
  <Pet xmlns:d2p1="http://schemas.datacontract.org/2004/07/SalesForceServices.ServiceModel.Models">
    <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
    <d2p1:Breed>String</d2p1:Breed>
    <d2p1:Color>String</d2p1:Color>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:Microchipped>false</d2p1:Microchipped>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ServiceAnimal>false</d2p1:ServiceAnimal>
    <d2p1:SfAccountId>String</d2p1:SfAccountId>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:Type>String</d2p1:Type>
    <d2p1:VeterinarianName>String</d2p1:VeterinarianName>
    <d2p1:VeterinarianPhone>String</d2p1:VeterinarianPhone>
    <d2p1:Weight>String</d2p1:Weight>
  </Pet>
</PetRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SalesForceServices.ServiceModel.Response">
  <Id>String</Id>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PetResponse>