Skip to main content

Try It Now Dialog

get_pets

Returns all pets from the system that the user has access to Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam.

Method​

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

Parameters​

NameTypeRequiredDescription
tagsstring[]notags to filter by
limitintegernomaximum number of results to return

Parameter schema​

{
  "tags": {
    "description": "tags to filter by",
    "required": false,
    "schema": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "limit": {
    "description": "maximum number of results to return",
    "required": false,
    "schema": {
      "type": "integer"
    }
  }
}

Result​

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

Result schema​

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

Positional parameters​

Parameter order:

  1. tags
  2. limit

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_pets",
  "params": {
    "tags": [
      "string"
    ],
    "limit": 1
  },
  "id": 1
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": [
    "example"
  ],
  "id": 1
}
Positional Parameters
{
  "jsonrpc": "2.0",
  "method": "get_pets",
  "params": [
    [
      "string"
    ],
    1
  ],
  "id": 2
}
Successful Response
{
  "jsonrpc": "2.0",
  "result": [
    "example"
  ],
  "id": 2
}