Skip to content

DistrictApi.md

Latest commit

 

History

History
271 lines (188 loc) · 6.42 KB

DistrictApi.md

File metadata and controls

271 lines (188 loc) · 6.42 KB
Raw

DistrictApi

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

Method HTTP request Description
districtDelete DELETE /v4/api/district/{id}
districtGet GET /v4/api/district/{id}
districtSearch GET /v4/api/district
districtUpdate PUT /v4/api/district/{id}
postV4ApiDistrictSearch POST /v4/api/district

districtDelete

districtDelete(id)

Remove 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.DistrictApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

districtGet

District districtGet(id)

Retrieve 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.DistrictApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

District

Authorization

Bearer

HTTP request headers

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

districtSearch

DistrictPaginationResponse districtSearch(filter, query, page, perPage, sort)

Search districts.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

DistrictPaginationResponse

Authorization

Bearer

HTTP request headers

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

districtUpdate

District districtUpdate(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.DistrictApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


DistrictApi apiInstance = new DistrictApi();
String id = "id_example"; // String | 
DistrictUpdate body = new DistrictUpdate(); // DistrictUpdate | 
try {
    District result = apiInstance.districtUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DistrictApi#districtUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body DistrictUpdate [optional]

Return type

District

Authorization

Bearer

HTTP request headers

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

postV4ApiDistrictSearch

District postV4ApiDistrictSearch(body)

Create 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.DistrictApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


DistrictApi apiInstance = new DistrictApi();
DistrictCreate body = new DistrictCreate(); // DistrictCreate | 
try {
    District result = apiInstance.postV4ApiDistrictSearch(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DistrictApi#postV4ApiDistrictSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body DistrictCreate [optional]

Return type

District

Authorization

Bearer

HTTP request headers

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