Skip to content

Latest commit

 

History

History
251 lines (178 loc) · 6.43 KB

AddressesApi.md

File metadata and controls

251 lines (178 loc) · 6.43 KB
Raw

AddressesApi

All URIs are relative to http://localhost:8000

Method HTTP request Description
addAddress POST /addresses Add one address.
deleteAddress DELETE /addresses/{id} Delete one address.
editAddress PUT /addresses Edit one address.
getAddressById GET /addresses/{id} Get one address.
getAddresses GET /addresses Get all addresses.

addAddress

Addresses addAddress(body)

Add one address.

Add one address.

Example

// Import classes:
//import com.ravimoshark.apis.client.ApiException;
//import com.ravimoshark.apis.client.calls.AddressesApi;


AddressesApi apiInstance = new AddressesApi();
Addresses body = new Addresses(); // Addresses | 
try {
    Addresses result = apiInstance.addAddress(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#addAddress");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Addresses

Return type

Addresses

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteAddress

IdInteger deleteAddress(id)

Delete one address.

Delete one address.

Example

// Import classes:
//import com.ravimoshark.apis.client.ApiException;
//import com.ravimoshark.apis.client.calls.AddressesApi;


AddressesApi apiInstance = new AddressesApi();
Long id = 789L; // Long | id to delete or search
try {
    IdInteger result = apiInstance.deleteAddress(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#deleteAddress");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Long id to delete or search

Return type

IdInteger

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

editAddress

Addresses editAddress(body)

Edit one address.

Edit one address.

Example

// Import classes:
//import com.ravimoshark.apis.client.ApiException;
//import com.ravimoshark.apis.client.calls.AddressesApi;


AddressesApi apiInstance = new AddressesApi();
Addresses body = new Addresses(); // Addresses | 
try {
    Addresses result = apiInstance.editAddress(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#editAddress");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Addresses

Return type

Addresses

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getAddressById

Addresses getAddressById(id, deleted)

Get one address.

Get one address.

Example

// Import classes:
//import com.ravimoshark.apis.client.ApiException;
//import com.ravimoshark.apis.client.calls.AddressesApi;


AddressesApi apiInstance = new AddressesApi();
Long id = 789L; // Long | id to delete or search
Deleted deleted = new Deleted(); // Deleted | Get all, deleted, not deleted data. Default not deleted.
try {
    Addresses result = apiInstance.getAddressById(id, deleted);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#getAddressById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Long id to delete or search
deleted Deleted Get all, deleted, not deleted data. Default not deleted. [optional]

Return type

Addresses

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAddresses

InlineResponse200 getAddresses(skip, limit, orderBy, filterBy, deleted, metadata, refClient)

Get all addresses.

Get all addresses.

Example

// Import classes:
//import com.ravimoshark.apis.client.ApiException;
//import com.ravimoshark.apis.client.calls.AddressesApi;


AddressesApi apiInstance = new AddressesApi();
Integer skip = 56; // Integer | number of item to skip
Integer limit = 56; // Integer | max records to return
String orderBy = "orderBy_example"; // String | order by property.
String filterBy = "filterBy_example"; // String | filter data.
Deleted deleted = new Deleted(); // Deleted | Get all, deleted, not deleted data. Default not deleted.
Boolean metadata = true; // Boolean | If metadata is needed (for pagination controls)
String refClient = "refClient_example"; // String | Data from a desired client
try {
    InlineResponse200 result = apiInstance.getAddresses(skip, limit, orderBy, filterBy, deleted, metadata, refClient);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#getAddresses");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
skip Integer number of item to skip [optional]
limit Integer max records to return [optional]
orderBy String order by property. [optional]
filterBy String filter data. [optional]
deleted Deleted Get all, deleted, not deleted data. Default not deleted. [optional]
metadata Boolean If metadata is needed (for pagination controls) [optional]
refClient String Data from a desired client [optional]

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json