Skip to content

LocationApi.md

Latest commit

 

History

History
271 lines (188 loc) · 6.42 KB

LocationApi.md

File metadata and controls

271 lines (188 loc) · 6.42 KB
Raw

LocationApi

All URIs are relative to https://app.statflo.com

Method HTTP request Description
locationDelete DELETE /v4/api/location/{id}
locationGet GET /v4/api/location/{id}
locationSearch GET /v4/api/location
locationUpdate PUT /v4/api/location/{id}
postV4ApiLocationSearch POST /v4/api/location

locationDelete

locationDelete(id)

Remove a location.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationApi apiInstance = new LocationApi();
String id = "id_example"; // String | 
try {
    apiInstance.locationDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationApi#locationDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

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

locationGet

Location locationGet(id)

Retrieve a location.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationApi apiInstance = new LocationApi();
String id = "id_example"; // String | 
try {
    Location result = apiInstance.locationGet(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationApi#locationGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

Location

Authorization

Bearer

HTTP request headers

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

locationSearch

LocationPaginationResponse locationSearch(filter, query, page, perPage, sort)

Search locations.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationApi apiInstance = new LocationApi();
java.util.HashMap filter = new java.util.HashMap(); // java.util.HashMap | 
String query = "query_example"; // String | 
Integer page = 56; // Integer | 
Integer perPage = 56; // Integer | 
String sort = "sort_example"; // String | 
try {
    LocationPaginationResponse result = apiInstance.locationSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationApi#locationSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter java.util.HashMap [optional]
query String [optional]
page Integer [optional]
perPage Integer [optional]
sort String [optional]

Return type

LocationPaginationResponse

Authorization

Bearer

HTTP request headers

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

locationUpdate

Location locationUpdate(id, body)

Update a location.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationApi apiInstance = new LocationApi();
String id = "id_example"; // String | 
LocationUpdate body = new LocationUpdate(); // LocationUpdate | 
try {
    Location result = apiInstance.locationUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationApi#locationUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body LocationUpdate [optional]

Return type

Location

Authorization

Bearer

HTTP request headers

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

postV4ApiLocationSearch

Location postV4ApiLocationSearch(body)

Create a location.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.LocationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


LocationApi apiInstance = new LocationApi();
LocationCreate body = new LocationCreate(); // LocationCreate | 
try {
    Location result = apiInstance.postV4ApiLocationSearch(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LocationApi#postV4ApiLocationSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body LocationCreate [optional]

Return type

Location

Authorization

Bearer

HTTP request headers

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