Swagger Petstore

Pet

addPet

Add a new pet to the store

/pet

Usage and SDK Samples


  curl -X post "http://petstore.swagger.io/v2/pet"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

        PetApi apiInstance = new PetApi();
        Pet body = ; // Pet | Pet object that needs to be added to the store
        try {
            apiInstance.addPet(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#addPet");
            e.printStackTrace();
        }
    }
}


  import .PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        PetApi apiInstance = new PetApi();
        Pet body = ; // Pet | Pet object that needs to be added to the store
        try {
            apiInstance.addPet(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#addPet");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: petstore_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Pet *body = ; // Pet object that needs to be added to the store

PetApi *apiInstance = [[PetApi alloc] init];

// Add a new pet to the store
[apiInstance addPetWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new .PetApi()

var body = ; // {Pet} Pet object that needs to be added to the store


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addPet(body, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addPetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: petstore_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PetApi();
            var body = new Pet(); // Pet | Pet object that needs to be added to the store

            try
            {
                // Add a new pet to the store
                apiInstance.addPet(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.addPet: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: petstore_auth
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\PetApi();
$body = ; // Pet | Pet object that needs to be added to the store

try {
    $api_instance->addPet($body);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->addPet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters

Name	Description
body *

Responses

Status: 405 - Invalid input

deletePet

Deletes a pet

/pet/{petId}

Usage and SDK Samples


  curl -X delete "http://petstore.swagger.io/v2/pet/{petId}"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

        PetApi apiInstance = new PetApi();
        Long petId = 789; // Long | Pet id to delete
        String apiKey = apiKey_example; // String | 
        try {
            apiInstance.deletePet(petId, apiKey);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#deletePet");
            e.printStackTrace();
        }
    }
}


  import .PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        PetApi apiInstance = new PetApi();
        Long petId = 789; // Long | Pet id to delete
        String apiKey = apiKey_example; // String | 
        try {
            apiInstance.deletePet(petId, apiKey);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#deletePet");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: petstore_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Long *petId = 789; // Pet id to delete
String *apiKey = apiKey_example; //  (optional)

PetApi *apiInstance = [[PetApi alloc] init];

// Deletes a pet
[apiInstance deletePetWith:petId
    apiKey:apiKey
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new .PetApi()

var petId = 789; // {Long} Pet id to delete

var opts = { 
  'apiKey': apiKey_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePet(petId, opts, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deletePetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: petstore_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PetApi();
            var petId = 789;  // Long | Pet id to delete
            var apiKey = apiKey_example;  // String |  (optional) 

            try
            {
                // Deletes a pet
                apiInstance.deletePet(petId, apiKey);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.deletePet: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: petstore_auth
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\PetApi();
$petId = 789; // Long | Pet id to delete
$apiKey = apiKey_example; // String | 

try {
    $api_instance->deletePet($petId, $apiKey);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->deletePet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
petId*

Header parameters

Name	Description
apiKey

Responses

Status: 400 - Invalid pet value

findPetsByStatus

Finds Pets by status

Multiple status values can be provided with comma separated strings

/pet/findByStatus

Usage and SDK Samples


  curl -X get "http://petstore.swagger.io/v2/pet/findByStatus?status="


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

        PetApi apiInstance = new PetApi();
        array[String] status = ; // array[String] | Status values that need to be considered for filter
        try {
            array[Pet] result = apiInstance.findPetsByStatus(status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#findPetsByStatus");
            e.printStackTrace();
        }
    }
}


  import .PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        PetApi apiInstance = new PetApi();
        array[String] status = ; // array[String] | Status values that need to be considered for filter
        try {
            array[Pet] result = apiInstance.findPetsByStatus(status);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#findPetsByStatus");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: petstore_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


array[String] *status = ; // Status values that need to be considered for filter

PetApi *apiInstance = [[PetApi alloc] init];

// Finds Pets by status
[apiInstance findPetsByStatusWith:status
              completionHandler: ^(array[Pet] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new .PetApi()

var status = ; // {array[String]} Status values that need to be considered for filter


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findPetsByStatus(status, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findPetsByStatusExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: petstore_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PetApi();
            var status = new array[String](); // array[String] | Status values that need to be considered for filter

            try
            {
                // Finds Pets by status
                array[Pet] result = apiInstance.findPetsByStatus(status);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.findPetsByStatus: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: petstore_auth
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\PetApi();
$status = ; // array[String] | Status values that need to be considered for filter

try {
    $result = $api_instance->findPetsByStatus($status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->findPetsByStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

Query parameters

Name	Description
status*

Responses

Status: 200 - successful operation

Schema

Status: 400 - Invalid status value

findPetsByTags

Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

/pet/findByTags

Usage and SDK Samples


  curl -X get "http://petstore.swagger.io/v2/pet/findByTags?tags="


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

        PetApi apiInstance = new PetApi();
        array[String] tags = ; // array[String] | Tags to filter by
        try {
            array[Pet] result = apiInstance.findPetsByTags(tags);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#findPetsByTags");
            e.printStackTrace();
        }
    }
}


  import .PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        PetApi apiInstance = new PetApi();
        array[String] tags = ; // array[String] | Tags to filter by
        try {
            array[Pet] result = apiInstance.findPetsByTags(tags);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#findPetsByTags");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: petstore_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


array[String] *tags = ; // Tags to filter by

PetApi *apiInstance = [[PetApi alloc] init];

// Finds Pets by tags
[apiInstance findPetsByTagsWith:tags
              completionHandler: ^(array[Pet] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new .PetApi()

var tags = ; // {array[String]} Tags to filter by


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findPetsByTags(tags, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class findPetsByTagsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: petstore_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PetApi();
            var tags = new array[String](); // array[String] | Tags to filter by

            try
            {
                // Finds Pets by tags
                array[Pet] result = apiInstance.findPetsByTags(tags);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.findPetsByTags: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: petstore_auth
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\PetApi();
$tags = ; // array[String] | Tags to filter by

try {
    $result = $api_instance->findPetsByTags($tags);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->findPetsByTags: ', $e->getMessage(), PHP_EOL;
}

Parameters

Query parameters

Name	Description
tags*

Responses

Status: 200 - successful operation

Schema

Status: 400 - Invalid tag value

getPetById

Find pet by ID

Returns a single pet

/pet/{petId}

Usage and SDK Samples


  curl -X get -H "api_key: [[apiKey]]"  "http://petstore.swagger.io/v2/pet/{petId}"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        PetApi apiInstance = new PetApi();
        Long petId = 789; // Long | ID of pet to return
        try {
            Pet result = apiInstance.getPetById(petId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#getPetById");
            e.printStackTrace();
        }
    }
}


  import .PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        PetApi apiInstance = new PetApi();
        Long petId = 789; // Long | ID of pet to return
        try {
            Pet result = apiInstance.getPetById(petId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#getPetById");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];


Long *petId = 789; // ID of pet to return

PetApi *apiInstance = [[PetApi alloc] init];

// Find pet by ID
[apiInstance getPetByIdWith:petId
              completionHandler: ^(Pet output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['api_key'] = "Token"

var api = new .PetApi()

var petId = 789; // {Long} ID of pet to return


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPetById(petId, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getPetByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new PetApi();
            var petId = 789;  // Long | ID of pet to return

            try
            {
                // Find pet by ID
                Pet result = apiInstance.getPetById(petId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.getPetById: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
io.swagger.client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new io.swagger.client\Api\PetApi();
$petId = 789; // Long | ID of pet to return

try {
    $result = $api_instance->getPetById($petId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->getPetById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
petId*

Responses

Status: 200 - successful operation

Schema

Status: 400 - Invalid ID supplied

Status: 404 - Pet not found

updatePet

Update an existing pet

/pet

Usage and SDK Samples


  curl -X put "http://petstore.swagger.io/v2/pet"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

        PetApi apiInstance = new PetApi();
        Pet body = ; // Pet | Pet object that needs to be added to the store
        try {
            apiInstance.updatePet(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#updatePet");
            e.printStackTrace();
        }
    }
}


  import .PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        PetApi apiInstance = new PetApi();
        Pet body = ; // Pet | Pet object that needs to be added to the store
        try {
            apiInstance.updatePet(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#updatePet");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: petstore_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Pet *body = ; // Pet object that needs to be added to the store

PetApi *apiInstance = [[PetApi alloc] init];

// Update an existing pet
[apiInstance updatePetWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new .PetApi()

var body = ; // {Pet} Pet object that needs to be added to the store


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePet(body, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updatePetExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: petstore_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PetApi();
            var body = new Pet(); // Pet | Pet object that needs to be added to the store

            try
            {
                // Update an existing pet
                apiInstance.updatePet(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.updatePet: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: petstore_auth
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\PetApi();
$body = ; // Pet | Pet object that needs to be added to the store

try {
    $api_instance->updatePet($body);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->updatePet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters

Name	Description
body *

Responses

Status: 400 - Invalid ID supplied

Status: 404 - Pet not found

Status: 405 - Validation exception

updatePetWithForm

Updates a pet in the store with form data

/pet/{petId}

Usage and SDK Samples


  curl -X post "http://petstore.swagger.io/v2/pet/{petId}"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

        PetApi apiInstance = new PetApi();
        Long petId = 789; // Long | ID of pet that needs to be updated
        String name = name_example; // String | Updated name of the pet
        String status = status_example; // String | Updated status of the pet
        try {
            apiInstance.updatePetWithForm(petId, name, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#updatePetWithForm");
            e.printStackTrace();
        }
    }
}


  import .PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        PetApi apiInstance = new PetApi();
        Long petId = 789; // Long | ID of pet that needs to be updated
        String name = name_example; // String | Updated name of the pet
        String status = status_example; // String | Updated status of the pet
        try {
            apiInstance.updatePetWithForm(petId, name, status);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#updatePetWithForm");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: petstore_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Long *petId = 789; // ID of pet that needs to be updated
String *name = name_example; // Updated name of the pet (optional)
String *status = status_example; // Updated status of the pet (optional)

PetApi *apiInstance = [[PetApi alloc] init];

// Updates a pet in the store with form data
[apiInstance updatePetWithFormWith:petId
    name:name
    status:status
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new .PetApi()

var petId = 789; // {Long} ID of pet that needs to be updated

var opts = { 
  'name': name_example, // {String} Updated name of the pet
  'status': status_example // {String} Updated status of the pet
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePetWithForm(petId, opts, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updatePetWithFormExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: petstore_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PetApi();
            var petId = 789;  // Long | ID of pet that needs to be updated
            var name = name_example;  // String | Updated name of the pet (optional) 
            var status = status_example;  // String | Updated status of the pet (optional) 

            try
            {
                // Updates a pet in the store with form data
                apiInstance.updatePetWithForm(petId, name, status);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.updatePetWithForm: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: petstore_auth
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\PetApi();
$petId = 789; // Long | ID of pet that needs to be updated
$name = name_example; // String | Updated name of the pet
$status = status_example; // String | Updated status of the pet

try {
    $api_instance->updatePetWithForm($petId, $name, $status);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->updatePetWithForm: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
petId*

Form parameters

Name	Description
name
status

Responses

Status: 405 - Invalid input

uploadFile

uploads an image

/pet/{petId}/uploadImage

Usage and SDK Samples


  curl -X post "http://petstore.swagger.io/v2/pet/{petId}/uploadImage"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

        PetApi apiInstance = new PetApi();
        Long petId = 789; // Long | ID of pet to update
        String additionalMetadata = additionalMetadata_example; // String | Additional data to pass to server
        file file = /path/to/file.txt; // file | file to upload
        try {
            ApiResponse result = apiInstance.uploadFile(petId, additionalMetadata, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#uploadFile");
            e.printStackTrace();
        }
    }
}


  import .PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        PetApi apiInstance = new PetApi();
        Long petId = 789; // Long | ID of pet to update
        String additionalMetadata = additionalMetadata_example; // String | Additional data to pass to server
        file file = /path/to/file.txt; // file | file to upload
        try {
            ApiResponse result = apiInstance.uploadFile(petId, additionalMetadata, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#uploadFile");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: petstore_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


Long *petId = 789; // ID of pet to update
String *additionalMetadata = additionalMetadata_example; // Additional data to pass to server (optional)
file *file = /path/to/file.txt; // file to upload (optional)

PetApi *apiInstance = [[PetApi alloc] init];

// uploads an image
[apiInstance uploadFileWith:petId
    additionalMetadata:additionalMetadata
    file:file
              completionHandler: ^(ApiResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new .PetApi()

var petId = 789; // {Long} ID of pet to update

var opts = { 
  'additionalMetadata': additionalMetadata_example, // {String} Additional data to pass to server
  'file': /path/to/file.txt // {file} file to upload
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadFile(petId, opts, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class uploadFileExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: petstore_auth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PetApi();
            var petId = 789;  // Long | ID of pet to update
            var additionalMetadata = additionalMetadata_example;  // String | Additional data to pass to server (optional) 
            var file = new file(); // file | file to upload (optional) 

            try
            {
                // uploads an image
                ApiResponse result = apiInstance.uploadFile(petId, additionalMetadata, file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PetApi.uploadFile: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: petstore_auth
io.swagger.client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new io.swagger.client\Api\PetApi();
$petId = 789; // Long | ID of pet to update
$additionalMetadata = additionalMetadata_example; // String | Additional data to pass to server
$file = /path/to/file.txt; // file | file to upload

try {
    $result = $api_instance->uploadFile($petId, $additionalMetadata, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->uploadFile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
petId*

Form parameters

Name	Description
additionalMetadata
file

Responses

Status: 200 - successful operation

Schema

Store

deleteOrder

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

/store/order/{orderId}

Usage and SDK Samples


  curl -X delete "http://petstore.swagger.io/v2/store/order/{orderId}"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .StoreApi;

import java.io.File;
import java.util.*;

public class StoreApiExample {

    public static void main(String[] args) {
        
        StoreApi apiInstance = new StoreApi();
        String orderId = orderId_example; // String | ID of the order that needs to be deleted
        try {
            apiInstance.deleteOrder(orderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreApi#deleteOrder");
            e.printStackTrace();
        }
    }
}


  import .StoreApi;

public class StoreApiExample {

    public static void main(String[] args) {
        StoreApi apiInstance = new StoreApi();
        String orderId = orderId_example; // String | ID of the order that needs to be deleted
        try {
            apiInstance.deleteOrder(orderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreApi#deleteOrder");
            e.printStackTrace();
        }
    }
}


  
String *orderId = orderId_example; // ID of the order that needs to be deleted

StoreApi *apiInstance = [[StoreApi alloc] init];

// Delete purchase order by ID
[apiInstance deleteOrderWith:orderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .StoreApi()

var orderId = orderId_example; // {String} ID of the order that needs to be deleted


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteOrder(orderId, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteOrderExample
    {
        public void main()
        {
            
            var apiInstance = new StoreApi();
            var orderId = orderId_example;  // String | ID of the order that needs to be deleted

            try
            {
                // Delete purchase order by ID
                apiInstance.deleteOrder(orderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreApi.deleteOrder: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\StoreApi();
$orderId = orderId_example; // String | ID of the order that needs to be deleted

try {
    $api_instance->deleteOrder($orderId);
} catch (Exception $e) {
    echo 'Exception when calling StoreApi->deleteOrder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
orderId*

Responses

Status: 400 - Invalid ID supplied

Status: 404 - Order not found

getInventory

Returns pet inventories by status

Returns a map of status codes to quantities

/store/inventory

Usage and SDK Samples


  curl -X get -H "api_key: [[apiKey]]"  "http://petstore.swagger.io/v2/store/inventory"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .StoreApi;

import java.io.File;
import java.util.*;

public class StoreApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StoreApi apiInstance = new StoreApi();
        try {
            map['String', 'Integer'] result = apiInstance.getInventory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreApi#getInventory");
            e.printStackTrace();
        }
    }
}


  import .StoreApi;

public class StoreApiExample {

    public static void main(String[] args) {
        StoreApi apiInstance = new StoreApi();
        try {
            map['String', 'Integer'] result = apiInstance.getInventory();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreApi#getInventory");
            e.printStackTrace();
        }
    }
}


  Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_key"];



StoreApi *apiInstance = [[StoreApi alloc] init];

// Returns pet inventories by status
[apiInstance getInventoryWithCompletionHandler: 
              ^(map['String', 'Integer'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['api_key'] = "Token"

var api = new .StoreApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInventory(callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getInventoryExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("api_key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_key", "Bearer");

            var apiInstance = new StoreApi();

            try
            {
                // Returns pet inventories by status
                map['String', 'Integer'] result = apiInstance.getInventory();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreApi.getInventory: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
io.swagger.client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// io.swagger.client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

$api_instance = new io.swagger.client\Api\StoreApi();

try {
    $result = $api_instance->getInventory();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreApi->getInventory: ', $e->getMessage(), PHP_EOL;
}

Parameters

Responses

Status: 200 - successful operation

Schema

getOrderById

Find purchase order by ID

For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions

/store/order/{orderId}

Usage and SDK Samples


  curl -X get "http://petstore.swagger.io/v2/store/order/{orderId}"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .StoreApi;

import java.io.File;
import java.util.*;

public class StoreApiExample {

    public static void main(String[] args) {
        
        StoreApi apiInstance = new StoreApi();
        Long orderId = 789; // Long | ID of pet that needs to be fetched
        try {
            Order result = apiInstance.getOrderById(orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreApi#getOrderById");
            e.printStackTrace();
        }
    }
}


  import .StoreApi;

public class StoreApiExample {

    public static void main(String[] args) {
        StoreApi apiInstance = new StoreApi();
        Long orderId = 789; // Long | ID of pet that needs to be fetched
        try {
            Order result = apiInstance.getOrderById(orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreApi#getOrderById");
            e.printStackTrace();
        }
    }
}


  
Long *orderId = 789; // ID of pet that needs to be fetched

StoreApi *apiInstance = [[StoreApi alloc] init];

// Find purchase order by ID
[apiInstance getOrderByIdWith:orderId
              completionHandler: ^(Order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .StoreApi()

var orderId = 789; // {Long} ID of pet that needs to be fetched


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderById(orderId, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getOrderByIdExample
    {
        public void main()
        {
            
            var apiInstance = new StoreApi();
            var orderId = 789;  // Long | ID of pet that needs to be fetched

            try
            {
                // Find purchase order by ID
                Order result = apiInstance.getOrderById(orderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreApi.getOrderById: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\StoreApi();
$orderId = 789; // Long | ID of pet that needs to be fetched

try {
    $result = $api_instance->getOrderById($orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreApi->getOrderById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
orderId*

Responses

Status: 200 - successful operation

Schema

Status: 400 - Invalid ID supplied

Status: 404 - Order not found

placeOrder

Place an order for a pet

/store/order

Usage and SDK Samples


  curl -X post "http://petstore.swagger.io/v2/store/order"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .StoreApi;

import java.io.File;
import java.util.*;

public class StoreApiExample {

    public static void main(String[] args) {
        
        StoreApi apiInstance = new StoreApi();
        Order body = ; // Order | order placed for purchasing the pet
        try {
            Order result = apiInstance.placeOrder(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreApi#placeOrder");
            e.printStackTrace();
        }
    }
}


  import .StoreApi;

public class StoreApiExample {

    public static void main(String[] args) {
        StoreApi apiInstance = new StoreApi();
        Order body = ; // Order | order placed for purchasing the pet
        try {
            Order result = apiInstance.placeOrder(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StoreApi#placeOrder");
            e.printStackTrace();
        }
    }
}


  
Order *body = ; // order placed for purchasing the pet

StoreApi *apiInstance = [[StoreApi alloc] init];

// Place an order for a pet
[apiInstance placeOrderWith:body
              completionHandler: ^(Order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .StoreApi()

var body = ; // {Order} order placed for purchasing the pet


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.placeOrder(body, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class placeOrderExample
    {
        public void main()
        {
            
            var apiInstance = new StoreApi();
            var body = new Order(); // Order | order placed for purchasing the pet

            try
            {
                // Place an order for a pet
                Order result = apiInstance.placeOrder(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoreApi.placeOrder: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\StoreApi();
$body = ; // Order | order placed for purchasing the pet

try {
    $result = $api_instance->placeOrder($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreApi->placeOrder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - successful operation

Schema

Status: 400 - Invalid Order

User

createUser

Create user

This can only be done by the logged in user.

/user

Usage and SDK Samples


  curl -X post "http://petstore.swagger.io/v2/user"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        User body = ; // User | Created user object
        try {
            apiInstance.createUser(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUser");
            e.printStackTrace();
        }
    }
}


  import .UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        User body = ; // User | Created user object
        try {
            apiInstance.createUser(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUser");
            e.printStackTrace();
        }
    }
}


  
User *body = ; // Created user object

UserApi *apiInstance = [[UserApi alloc] init];

// Create user
[apiInstance createUserWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .UserApi()

var body = ; // {User} Created user object


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUser(body, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class createUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var body = new User(); // User | Created user object

            try
            {
                // Create user
                apiInstance.createUser(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.createUser: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\UserApi();
$body = ; // User | Created user object

try {
    $api_instance->createUser($body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->createUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters

Name	Description
body *

Responses

Status: 0 - successful operation

createUsersWithArrayInput

Creates list of users with given input array

/user/createWithArray

Usage and SDK Samples


  curl -X post "http://petstore.swagger.io/v2/user/createWithArray"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        array[User] body = ; // array[User] | List of user object
        try {
            apiInstance.createUsersWithArrayInput(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUsersWithArrayInput");
            e.printStackTrace();
        }
    }
}


  import .UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        array[User] body = ; // array[User] | List of user object
        try {
            apiInstance.createUsersWithArrayInput(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUsersWithArrayInput");
            e.printStackTrace();
        }
    }
}


  
array[User] *body = ; // List of user object

UserApi *apiInstance = [[UserApi alloc] init];

// Creates list of users with given input array
[apiInstance createUsersWithArrayInputWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .UserApi()

var body = ; // {array[User]} List of user object


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUsersWithArrayInput(body, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class createUsersWithArrayInputExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var body = new array[User](); // array[User] | List of user object

            try
            {
                // Creates list of users with given input array
                apiInstance.createUsersWithArrayInput(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.createUsersWithArrayInput: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\UserApi();
$body = ; // array[User] | List of user object

try {
    $api_instance->createUsersWithArrayInput($body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->createUsersWithArrayInput: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters

Name	Description
body *

Responses

Status: 0 - successful operation

createUsersWithListInput

Creates list of users with given input array

/user/createWithList

Usage and SDK Samples


  curl -X post "http://petstore.swagger.io/v2/user/createWithList"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        array[User] body = ; // array[User] | List of user object
        try {
            apiInstance.createUsersWithListInput(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUsersWithListInput");
            e.printStackTrace();
        }
    }
}


  import .UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        array[User] body = ; // array[User] | List of user object
        try {
            apiInstance.createUsersWithListInput(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUsersWithListInput");
            e.printStackTrace();
        }
    }
}


  
array[User] *body = ; // List of user object

UserApi *apiInstance = [[UserApi alloc] init];

// Creates list of users with given input array
[apiInstance createUsersWithListInputWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .UserApi()

var body = ; // {array[User]} List of user object


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUsersWithListInput(body, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class createUsersWithListInputExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var body = new array[User](); // array[User] | List of user object

            try
            {
                // Creates list of users with given input array
                apiInstance.createUsersWithListInput(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.createUsersWithListInput: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\UserApi();
$body = ; // array[User] | List of user object

try {
    $api_instance->createUsersWithListInput($body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->createUsersWithListInput: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters

Name	Description
body *

Responses

Status: 0 - successful operation

deleteUser

Delete user

This can only be done by the logged in user.

/user/{username}

Usage and SDK Samples


  curl -X delete "http://petstore.swagger.io/v2/user/{username}"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | The name that needs to be deleted
        try {
            apiInstance.deleteUser(username);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}


  import .UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | The name that needs to be deleted
        try {
            apiInstance.deleteUser(username);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}


  
String *username = username_example; // The name that needs to be deleted

UserApi *apiInstance = [[UserApi alloc] init];

// Delete user
[apiInstance deleteUserWith:username
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .UserApi()

var username = username_example; // {String} The name that needs to be deleted


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUser(username, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var username = username_example;  // String | The name that needs to be deleted

            try
            {
                // Delete user
                apiInstance.deleteUser(username);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.deleteUser: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\UserApi();
$username = username_example; // String | The name that needs to be deleted

try {
    $api_instance->deleteUser($username);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
username*

Responses

Status: 400 - Invalid username supplied

Status: 404 - User not found

getUserByName

Get user by user name

/user/{username}

Usage and SDK Samples


  curl -X get "http://petstore.swagger.io/v2/user/{username}"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | The name that needs to be fetched. Use user1 for testing. 
        try {
            User result = apiInstance.getUserByName(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserByName");
            e.printStackTrace();
        }
    }
}


  import .UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | The name that needs to be fetched. Use user1 for testing. 
        try {
            User result = apiInstance.getUserByName(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserByName");
            e.printStackTrace();
        }
    }
}


  
String *username = username_example; // The name that needs to be fetched. Use user1 for testing. 

UserApi *apiInstance = [[UserApi alloc] init];

// Get user by user name
[apiInstance getUserByNameWith:username
              completionHandler: ^(User output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .UserApi()

var username = username_example; // {String} The name that needs to be fetched. Use user1 for testing. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserByName(username, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getUserByNameExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var username = username_example;  // String | The name that needs to be fetched. Use user1 for testing. 

            try
            {
                // Get user by user name
                User result = apiInstance.getUserByName(username);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.getUserByName: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\UserApi();
$username = username_example; // String | The name that needs to be fetched. Use user1 for testing. 

try {
    $result = $api_instance->getUserByName($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserByName: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
username*

Responses

Status: 200 - successful operation

Schema

Status: 400 - Invalid username supplied

Status: 404 - User not found

loginUser

Logs user into the system

/user/login

Usage and SDK Samples


  curl -X get "http://petstore.swagger.io/v2/user/login?username=&password="


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | The user name for login
        String password = password_example; // String | The password for login in clear text
        try {
            'String' result = apiInstance.loginUser(username, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#loginUser");
            e.printStackTrace();
        }
    }
}


  import .UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | The user name for login
        String password = password_example; // String | The password for login in clear text
        try {
            'String' result = apiInstance.loginUser(username, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#loginUser");
            e.printStackTrace();
        }
    }
}


  
String *username = username_example; // The user name for login
String *password = password_example; // The password for login in clear text

UserApi *apiInstance = [[UserApi alloc] init];

// Logs user into the system
[apiInstance loginUserWith:username
    password:password
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .UserApi()

var username = username_example; // {String} The user name for login

var password = password_example; // {String} The password for login in clear text


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loginUser(username, password, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class loginUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var username = username_example;  // String | The user name for login
            var password = password_example;  // String | The password for login in clear text

            try
            {
                // Logs user into the system
                'String' result = apiInstance.loginUser(username, password);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.loginUser: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\UserApi();
$username = username_example; // String | The user name for login
$password = password_example; // String | The password for login in clear text

try {
    $result = $api_instance->loginUser($username, $password);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->loginUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Query parameters

Name	Description
username*
password*

Responses

Status: 200 - successful operation

Schema

Status: 400 - Invalid username/password supplied

logoutUser

Logs out current logged in user session

/user/logout

Usage and SDK Samples


  curl -X get "http://petstore.swagger.io/v2/user/logout"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        try {
            apiInstance.logoutUser();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#logoutUser");
            e.printStackTrace();
        }
    }
}


  import .UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        try {
            apiInstance.logoutUser();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#logoutUser");
            e.printStackTrace();
        }
    }
}


  

UserApi *apiInstance = [[UserApi alloc] init];

// Logs out current logged in user session
[apiInstance logoutUserWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .UserApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.logoutUser(callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class logoutUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();

            try
            {
                // Logs out current logged in user session
                apiInstance.logoutUser();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.logoutUser: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\UserApi();

try {
    $api_instance->logoutUser();
} catch (Exception $e) {
    echo 'Exception when calling UserApi->logoutUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Responses

Status: 0 - successful operation

updateUser

Updated user

This can only be done by the logged in user.

/user/{username}

Usage and SDK Samples


  curl -X put "http://petstore.swagger.io/v2/user/{username}"


  import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {

    public static void main(String[] args) {
        
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | name that need to be deleted
        User body = ; // User | Updated user object
        try {
            apiInstance.updateUser(username, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}


  import .UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String username = username_example; // String | name that need to be deleted
        User body = ; // User | Updated user object
        try {
            apiInstance.updateUser(username, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}


  
String *username = username_example; // name that need to be deleted
User *body = ; // Updated user object

UserApi *apiInstance = [[UserApi alloc] init];

// Updated user
[apiInstance updateUserWith:username
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];


  var  = require('');

var api = new .UserApi()

var username = username_example; // {String} name that need to be deleted

var body = ; // {User} Updated user object


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUser(username, body, callback);


  using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserApi();
            var username = username_example;  // String | name that need to be deleted
            var body = new User(); // User | Updated user object

            try
            {
                // Updated user
                apiInstance.updateUser(username, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.updateUser: " + e.Message );
            }
        }
    }
}


  
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\UserApi();
$username = username_example; // String | name that need to be deleted
$body = ; // User | Updated user object

try {
    $api_instance->updateUser($username, $body);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters

Name	Description
username*

Body parameters

Name	Description
body *

Responses

Status: 400 - Invalid user supplied

Status: 404 - User not found

Generated 2017-04-06T03:19:44.348Z

Swagger Petstore

API and SDK Documentation

Pet

addPet

Usage and SDK Samples

Parameters

Responses

Status: 405 - Invalid input

deletePet

Usage and SDK Samples

Parameters

Responses

Status: 400 - Invalid pet value

findPetsByStatus

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

Status: 400 - Invalid status value

findPetsByTags

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

Status: 400 - Invalid tag value

getPetById

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

Status: 400 - Invalid ID supplied

Status: 404 - Pet not found

updatePet

Usage and SDK Samples

Parameters

Responses

Status: 400 - Invalid ID supplied

Status: 404 - Pet not found

Status: 405 - Validation exception

updatePetWithForm

Usage and SDK Samples

Parameters

Responses

Status: 405 - Invalid input

uploadFile

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

Store

deleteOrder

Usage and SDK Samples

Parameters

Responses

Status: 400 - Invalid ID supplied

Status: 404 - Order not found

getInventory

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

getOrderById

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

Status: 400 - Invalid ID supplied

Status: 404 - Order not found

placeOrder

Usage and SDK Samples

Parameters

Responses

Status: 200 - successful operation

Status: 400 - Invalid Order

User

createUser

Usage and SDK Samples

Parameters

Responses

Status: 0 - successful operation