GeneralMerchantsApi JAVA
Tuesday, October 29, 2019 2:53 PMGeneralMerchantsApi
All URIs are relative to https://connect-testing.secupay-ag.de/api/v2
Method | HTTP request | Description |
---|---|---|
getAll | GET /General/Merchants | GET General/Merchants |
getOne | GET /General/Merchants/{generalMerchantId} | GET General/Merchants/{generalMerchantId} |
updateMerchant | PUT /General/Merchants/{generalMerchantId} | PUT General/Merchants/{generalMerchantId} |
getAll
GeneralMerchantsList getAll(count, offset, fields, q, sort)
GET General/Merchants
Get a list of general merchants
Example
// Import classes:
//import io.secuconnect.client.ApiClient;
//import io.secuconnect.client.ApiException;
//import io.secuconnect.client.Configuration;
//import io.secuconnect.client.auth.*;
//import io.secuconnect.client.api.GeneralMerchantsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: oauth_token
OAuth oauth_token = (OAuth) defaultClient.getAuthentication("oauth_token");
oauth_token.setAccessToken("YOUR ACCESS TOKEN");
GeneralMerchantsApi apiInstance = new GeneralMerchantsApi();
Integer count = 56; // Integer | The number of items to return.
Integer offset = 56; // Integer | The position within the whole result set to start returning items (First element is at 0).
String fields = "fields_example"; // String | List of fields to include in the result. Nested properties can be accessed with this notation: prop1.prop2 Example: prop3,prop1.prop2
String q = "q_example"; // String | A query string to restrict the returned items to given conditions. The query string must consist of any combination of single expressions in the form property:condition. * A condition may contain: * - wildcard \"*\" for any number of characters * - wildcard \"?\" for one character * - ranges in the form [value TO value] * * Single expressions may combined by 'AND', 'OR', 'NOT' operators and parenthesis '(', ')' for grouping. * Property names can be nested like \"prop1.prop2\". * Example: (NOT customer.name:meier*) AND (customer.age:[30 TO 40] OR customer.age:[50 TO 60]) *
String sort = "sort_example"; // String | String with comma separated pairs of field:order (e.g. contact.surname:asc,contact.comapnyname:desc). Result set will be sorted by included fields, in ascending 'asc', or descending 'dsc' order.
try {
GeneralMerchantsList result = apiInstance.getAll(count, offset, fields, q, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GeneralMerchantsApi#getAll");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
count | Integer | The number of items to return. | [optional] |
offset | Integer | The position within the whole result set to start returning items (First element is at 0). | [optional] |
fields | String | List of fields to include in the result. Nested properties can be accessed with this notation: prop1.prop2 Example: prop3,prop1.prop2 | [optional] |
q | String | A query string to restrict the returned items to given conditions. The query string must consist of any combination of single expressions in the form property:condition. A condition may contain: - wildcard \"\" for any number of characters - wildcard \"?\" for one character - ranges in the form [value TO value] Single expressions may combined by 'AND', 'OR', 'NOT' operators and parenthesis '(', ')' for grouping. Property names can be nested like \"prop1.prop2\". Example: (NOT customer.name:meier) AND (customer.age:[30 TO 40] OR customer.age:[50 TO 60]) * | [optional] |
sort | String | String with comma separated pairs of field:order (e.g. contact.surname:asc,contact.comapnyname:desc). Result set will be sorted by included fields, in ascending 'asc', or descending 'dsc' order. | [optional] |
Return type
GeneralMerchantsList
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
getOne
GeneralMerchantsProductModel getOne(generalMerchantId)
GET General/Merchants/{generalMerchantId}
Get one general merchant for a specific id
Example
// Import classes:
//import io.secuconnect.client.ApiClient;
//import io.secuconnect.client.ApiException;
//import io.secuconnect.client.Configuration;
//import io.secuconnect.client.auth.*;
//import io.secuconnect.client.api.GeneralMerchantsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: oauth_token
OAuth oauth_token = (OAuth) defaultClient.getAuthentication("oauth_token");
oauth_token.setAccessToken("YOUR ACCESS TOKEN");
GeneralMerchantsApi apiInstance = new GeneralMerchantsApi();
String generalMerchantId = "generalMerchantId_example"; // String | General merchant id
try {
GeneralMerchantsProductModel result = apiInstance.getOne(generalMerchantId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GeneralMerchantsApi#getOne");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
generalMerchantId | String | General merchant id |
Return type
GeneralMerchantsProductModel
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
updateMerchant
GeneralMerchantsProductModel updateMerchant(generalMerchantId, body)
PUT General/Merchants/{generalMerchantId}
Update general merchant
Example
// Import classes:
//import io.secuconnect.client.ApiClient;
//import io.secuconnect.client.ApiException;
//import io.secuconnect.client.Configuration;
//import io.secuconnect.client.auth.*;
//import io.secuconnect.client.api.GeneralMerchantsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: oauth_token
OAuth oauth_token = (OAuth) defaultClient.getAuthentication("oauth_token");
oauth_token.setAccessToken("YOUR ACCESS TOKEN");
GeneralMerchantsApi apiInstance = new GeneralMerchantsApi();
String generalMerchantId = "generalMerchantId_example"; // String | General merchant id
GeneralMerchantsDTO body = new GeneralMerchantsDTO(); // GeneralMerchantsDTO | General merchant properties
try {
GeneralMerchantsProductModel result = apiInstance.updateMerchant(generalMerchantId, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GeneralMerchantsApi#updateMerchant");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
generalMerchantId | String | General merchant id | |
body | GeneralMerchantsDTO | General merchant properties |
Return type
GeneralMerchantsProductModel
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined