Skip to content

RegionApi.md

Latest commit

 

History

History
271 lines (188 loc) · 6.23 KB

RegionApi.md

File metadata and controls

271 lines (188 loc) · 6.23 KB
Raw

RegionApi

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

Method HTTP request Description
postV4ApiRegionSearch POST /v4/api/region
regionDelete DELETE /v4/api/region/{id}
regionGet GET /v4/api/region/{id}
regionSearch GET /v4/api/region
regionUpdate PUT /v4/api/region/{id}

postV4ApiRegionSearch

Region postV4ApiRegionSearch(body)

Create a region.

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.RegionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


RegionApi apiInstance = new RegionApi();
RegionCreate body = new RegionCreate(); // RegionCreate | 
try {
    Region result = apiInstance.postV4ApiRegionSearch(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegionApi#postV4ApiRegionSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RegionCreate [optional]

Return type

Region

Authorization

Bearer

HTTP request headers

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

regionDelete

regionDelete(id)

Remove a region.

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.RegionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


RegionApi apiInstance = new RegionApi();
String id = "id_example"; // String | 
try {
    apiInstance.regionDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling RegionApi#regionDelete");
    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

regionGet

Region regionGet(id)

Retrieve a region.

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.RegionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

Region

Authorization

Bearer

HTTP request headers

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

regionSearch

RegionPaginationResponse regionSearch(filter, query, page, perPage, sort)

Search regions.

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.RegionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


RegionApi apiInstance = new RegionApi();
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 {
    RegionPaginationResponse result = apiInstance.regionSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegionApi#regionSearch");
    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

RegionPaginationResponse

Authorization

Bearer

HTTP request headers

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

regionUpdate

Region regionUpdate(id, body)

Update a district.

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.RegionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


RegionApi apiInstance = new RegionApi();
String id = "id_example"; // String | 
RegionUpdate body = new RegionUpdate(); // RegionUpdate | 
try {
    Region result = apiInstance.regionUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegionApi#regionUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body RegionUpdate [optional]

Return type

Region

Authorization

Bearer

HTTP request headers

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