DELETE | /pet/{id} | ||
---|---|---|---|
PUT | /pet/{id} | ||
POST | /pet |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
Pet | body | Pet | No | |
NameId | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Type | form | string | No | |
Name | form | string | No | |
Breed | form | string | No | |
Color | form | string | No | |
Weight | form | string | No | |
BirthDate | form | DateTime? | No | |
VeterinarianName | form | string | No | |
VeterinarianPhone | form | string | No | |
Microchipped | form | bool | No | |
ServiceAnimal | form | bool | No | |
SfAccountId | form | string | No | |
Status | form | string | No | |
IsDeleted | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } } }