Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 4 KB

ItemtypesApi.md

File metadata and controls

130 lines (93 loc) · 4 KB
Raw

ItemtypesApi

Method HTTP request Description
getItem GET /itemtypes/{itemTypeId} Get the item type with the specified ID
getItemTypes GET /itemtypes Get all item types

getItem

ItemTypeDataWrapper getItem(itemTypeId, include)

Get the item type with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemtypesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemtypesApi apiInstance = new ItemtypesApi();
Integer itemTypeId = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemTypeDataWrapper result = apiInstance.getItem(itemTypeId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemtypesApi#getItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
itemTypeId Integer
include List<String> Links to include as full objects in the linked map [optional]

Return type

ItemTypeDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getItemTypes

ItemTypeDataListWrapper getItemTypes(startAt, maxResults, include)

Get all item types

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.ItemtypesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

ItemtypesApi apiInstance = new ItemtypesApi();
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    ItemTypeDataListWrapper result = apiInstance.getItemTypes(startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ItemtypesApi#getItemTypes");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
startAt Integer [optional]
maxResults Integer If not set, this defaults to 20. This cannot be larger than 50 [optional]
include List<String> Links to include as full objects in the linked map [optional]

Return type

ItemTypeDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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