PlansApi.md

PlansApi

All URIs are relative to http://localhost/

Method	HTTP request	Description
list	GET api/v2/plans.json_api	Get a list of Plans
show	GET api/v2/plans/{id}.json_api	Show a single Plan

list

PaginatedCollection list(page)

Get a list of Plans

Example

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


PlansApi apiInstance = new PlansApi();
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(page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PlansApi#list");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
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

Plan show(id)

Show a single Plan

Example

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


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

Parameters

Name	Type	Description	Notes
id	Integer	Plan ID

Return type

Plan

Authorization

No authorization required

HTTP request headers

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