Skip to content

ObjectFranchisereferalincomeApi.md

Latest commit

 

History

History
79 lines (59 loc) · 3.33 KB

ObjectFranchisereferalincomeApi.md

File metadata and controls

79 lines (59 loc) · 3.33 KB

ObjectFranchisereferalincomeApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
franchisereferalincomeCreateObjectV2 POST /2/object/franchisereferalincome Create a new Franchisereferalincome

franchisereferalincomeCreateObjectV2

FranchisereferalincomeCreateObjectV2Response franchisereferalincomeCreateObjectV2(franchisereferalincomeCreateObjectV2Request)

Create a new Franchisereferalincome

The endpoint allows to create one or many elements at once.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectFranchisereferalincomeApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectFranchisereferalincomeApi apiInstance = new ObjectFranchisereferalincomeApi(defaultClient);
    FranchisereferalincomeCreateObjectV2Request franchisereferalincomeCreateObjectV2Request = new FranchisereferalincomeCreateObjectV2Request(); // FranchisereferalincomeCreateObjectV2Request | 
    try {
      FranchisereferalincomeCreateObjectV2Response result = apiInstance.franchisereferalincomeCreateObjectV2(franchisereferalincomeCreateObjectV2Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectFranchisereferalincomeApi#franchisereferalincomeCreateObjectV2");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
franchisereferalincomeCreateObjectV2Request FranchisereferalincomeCreateObjectV2Request

Return type

FranchisereferalincomeCreateObjectV2Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Successful response -
422 The request was syntactically valid but failed because of this Franchisebroker is not in this Franchiseoffice. fkiFranchiseofficeID contains the id of Franchiseoffice where the Franchisebroker is located on the dtFranchisereferalincomeDisbursed. -