Skip to main content

Try It Now Dialog

get_pet_by_id

Returns a user based on a single ID, if the user does not have access to the pet

Method​

  • JSON-RPC method name: get_pet_by_id
  • JSON-RPC version: 2.0

Parameters​

NameTypeRequiredDescription
idintegeryesID of pet to fetch

Parameter schema​

{
  "id": {
    "description": "ID of pet to fetch",
    "required": true,
    "schema": {
      "type": "integer"
    }
  }
}

Result​

  • Name: pet
  • Description: pet response
  • Type: allOf

Result schema​

{
  "allOf": [
    {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "tag": {
          "type": "string"
        }
      }
    },
    {
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer"
        }
      }
    }
  ]
}

Positional parameters​

Parameter order:

  1. id

Errors​

This method may return JSON-RPC standard errors (e.g. -32600, -32601, -32602, -32603) as well as application-specific errors.

TODO: Document method-specific error codes and conditions.

Named Parameters
{
  "jsonrpc": "2.0",
  "method": "get_pet_by_id",
  "params": {
    "id": 1
  },
  "id": 1
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": "example",
  "id": 1
}
Positional Parameters
{
  "jsonrpc": "2.0",
  "method": "get_pet_by_id",
  "params": [
    1
  ],
  "id": 2
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": "example",
  "id": 2
}