cybersource-rest-client
Version:
Node.js SDK for the CyberSource REST API
103 lines (66 loc) • 3.01 kB
Markdown
# CyberSource.DeviceSearchApi
All URIs are relative to *https://apitest.cybersource.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**postSearchQuery**](DeviceSearchApi.md#postSearchQuery) | **POST** /dms/v2/devices/search | Retrieve List of Devices for a given search query V2
[**postSearchQueryV3**](DeviceSearchApi.md#postSearchQueryV3) | **POST** /dms/v3/devices/search | Retrieve List of Devices for a given search query
<a name="postSearchQuery"></a>
# **postSearchQuery**
> InlineResponse2006 postSearchQuery(postDeviceSearchRequest)
Retrieve List of Devices for a given search query V2
Retrieves list of terminals in paginated format.
### Example
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.DeviceSearchApi();
var postDeviceSearchRequest = new CyberSource.PostDeviceSearchRequest(); // PostDeviceSearchRequest |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.postSearchQuery(postDeviceSearchRequest, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**postDeviceSearchRequest** | [**PostDeviceSearchRequest**](PostDeviceSearchRequest.md)| |
### Return type
[**InlineResponse2006**](InlineResponse2006.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json;charset=UTF-8
- **Accept**: application/json;charset=UTF-8
<a name="postSearchQueryV3"></a>
# **postSearchQueryV3**
> InlineResponse2008 postSearchQueryV3(postDeviceSearchRequestV3)
Retrieve List of Devices for a given search query
Search for devices matching a given search query. The search query supports serialNumber, readerId, terminalId, status, statusChangeReason or organizationId Matching results are paginated.
### Example
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.DeviceSearchApi();
var postDeviceSearchRequestV3 = new CyberSource.PostDeviceSearchRequestV3(); // PostDeviceSearchRequestV3 |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.postSearchQueryV3(postDeviceSearchRequestV3, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**postDeviceSearchRequestV3** | [**PostDeviceSearchRequestV3**](PostDeviceSearchRequestV3.md)| |
### Return type
[**InlineResponse2008**](InlineResponse2008.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json;charset=UTF-8
- **Accept**: application/json;charset=UTF-8