RegionsApi.md

RegionsApi

All URIs are relative to http://localhost/

Method	HTTP request	Description
list	PUT api/v2/regions.json_api	Get a list of Regions
show	GET api/v2/regions/{id}.json_api	Show a single Region

list

PaginatedCollection list(filter, page)

Get a list of Regions

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.RegionsApi;


RegionsApi apiInstance = new RegionsApi();
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, code, name] Matching Searchable Attributes: [code, name] Limited Searchable Attribute: [provider_eq]  Searchable Association: [suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.list(filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegionsApi#list");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
filter	Map<String, String>	Filter Params for Searching. Equality Searchable Attributes: [id, code, name] Matching Searchable Attributes: [code, name] Limited Searchable Attribute: [provider_eq] Searchable Association: [suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.	[optional]
page	String	Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page.	[optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

show

Region show(id)

Show a single Region

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.RegionsApi;


RegionsApi apiInstance = new RegionsApi();
Integer id = 56; // Integer | Region ID
try {
    Region result = apiInstance.show(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegionsApi#show");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer	Region ID

Return type

Region

Authorization

No authorization required

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json