Franklin Flood API

Application

getApplication

Get an existing application


/application/{AppID}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://api.franklinflood.com/v1/application/{AppID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationApi;

import java.io.File;
import java.util.*;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ApplicationApi apiInstance = new ApplicationApi();
        String appID = appID_example; // String | Application ID returned in the response from the POST /application
        try {
            inline_response_200 result = apiInstance.getApplication(appID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#getApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationApi;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApplicationApi apiInstance = new ApplicationApi();
        String appID = appID_example; // String | Application ID returned in the response from the POST /application
        try {
            inline_response_200 result = apiInstance.getApplication(appID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#getApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *appID = appID_example; // Application ID returned in the response from the POST /application

ApplicationApi *apiInstance = [[ApplicationApi alloc] init];

// Get an existing application
[apiInstance getApplicationWith:appID
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FranklinFloodApi = require('franklin_flood_api');
var defaultClient = FranklinFloodApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new FranklinFloodApi.ApplicationApi()
var appID = appID_example; // {{String}} Application ID returned in the response from the POST /application

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplication(appID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationApi();
            var appID = appID_example;  // String | Application ID returned in the response from the POST /application

            try
            {
                // Get an existing application
                inline_response_200 result = apiInstance.getApplication(appID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationApi.getApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApplicationApi();
$appID = appID_example; // String | Application ID returned in the response from the POST /application

try {
    $result = $api_instance->getApplication($appID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationApi->getApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationApi->new();
my $appID = appID_example; # String | Application ID returned in the response from the POST /application

eval { 
    my $result = $api_instance->getApplication(appID => $appID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationApi->getApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationApi()
appID = appID_example # String | Application ID returned in the response from the POST /application

try: 
    # Get an existing application
    api_response = api_instance.get_application(appID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationApi->getApplication: %s\n" % e)

Parameters

Path parameters
Name Description
AppID*
String
Application ID returned in the response from the POST /application
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 429 - Too many requests

Status: 500 - Internal server error. Try again using an exponential backoff.


getApplicationQuote

Get the quote details


/application/{AppID}/quote

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://api.franklinflood.com/v1/application/{AppID}/quote"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationApi;

import java.io.File;
import java.util.*;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ApplicationApi apiInstance = new ApplicationApi();
        String appID = appID_example; // String | Application ID returned in the response from the POST /application
        try {
            inline_response_200_2 result = apiInstance.getApplicationQuote(appID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#getApplicationQuote");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationApi;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApplicationApi apiInstance = new ApplicationApi();
        String appID = appID_example; // String | Application ID returned in the response from the POST /application
        try {
            inline_response_200_2 result = apiInstance.getApplicationQuote(appID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#getApplicationQuote");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *appID = appID_example; // Application ID returned in the response from the POST /application

ApplicationApi *apiInstance = [[ApplicationApi alloc] init];

// Get the quote details
[apiInstance getApplicationQuoteWith:appID
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FranklinFloodApi = require('franklin_flood_api');
var defaultClient = FranklinFloodApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new FranklinFloodApi.ApplicationApi()
var appID = appID_example; // {{String}} Application ID returned in the response from the POST /application

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplicationQuote(appID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationQuoteExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationApi();
            var appID = appID_example;  // String | Application ID returned in the response from the POST /application

            try
            {
                // Get the quote details
                inline_response_200_2 result = apiInstance.getApplicationQuote(appID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationApi.getApplicationQuote: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApplicationApi();
$appID = appID_example; // String | Application ID returned in the response from the POST /application

try {
    $result = $api_instance->getApplicationQuote($appID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationApi->getApplicationQuote: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationApi->new();
my $appID = appID_example; # String | Application ID returned in the response from the POST /application

eval { 
    my $result = $api_instance->getApplicationQuote(appID => $appID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationApi->getApplicationQuote: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationApi()
appID = appID_example # String | Application ID returned in the response from the POST /application

try: 
    # Get the quote details
    api_response = api_instance.get_application_quote(appID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationApi->getApplicationQuote: %s\n" % e)

Parameters

Path parameters
Name Description
AppID*
String
Application ID returned in the response from the POST /application
Required

Responses

Status: 200 - An application was successfully submitted for quoting. This application is valid for 30 days. After that time, the application will no longer be available to view.

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 410 - Application has expired. Please submit a new quote.

Status: 429 - Too many requests

Status: 460 - Application status is not "Completed"

Status: 500 - Internal server error. Try again using an exponential backoff.


getApplicationStatus

Get the status of the application


/application/{AppID}/status

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://api.franklinflood.com/v1/application/{AppID}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationApi;

import java.io.File;
import java.util.*;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ApplicationApi apiInstance = new ApplicationApi();
        String appID = appID_example; // String | Application ID returned in the response from the POST /application
        try {
            inline_response_200_1 result = apiInstance.getApplicationStatus(appID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#getApplicationStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationApi;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApplicationApi apiInstance = new ApplicationApi();
        String appID = appID_example; // String | Application ID returned in the response from the POST /application
        try {
            inline_response_200_1 result = apiInstance.getApplicationStatus(appID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#getApplicationStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *appID = appID_example; // Application ID returned in the response from the POST /application

ApplicationApi *apiInstance = [[ApplicationApi alloc] init];

// Get the status of the application
[apiInstance getApplicationStatusWith:appID
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FranklinFloodApi = require('franklin_flood_api');
var defaultClient = FranklinFloodApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new FranklinFloodApi.ApplicationApi()
var appID = appID_example; // {{String}} Application ID returned in the response from the POST /application

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplicationStatus(appID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApplicationStatusExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationApi();
            var appID = appID_example;  // String | Application ID returned in the response from the POST /application

            try
            {
                // Get the status of the application
                inline_response_200_1 result = apiInstance.getApplicationStatus(appID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationApi.getApplicationStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApplicationApi();
$appID = appID_example; // String | Application ID returned in the response from the POST /application

try {
    $result = $api_instance->getApplicationStatus($appID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationApi->getApplicationStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationApi->new();
my $appID = appID_example; # String | Application ID returned in the response from the POST /application

eval { 
    my $result = $api_instance->getApplicationStatus(appID => $appID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationApi->getApplicationStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationApi()
appID = appID_example # String | Application ID returned in the response from the POST /application

try: 
    # Get the status of the application
    api_response = api_instance.get_application_status(appID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationApi->getApplicationStatus: %s\n" % e)

Parameters

Path parameters
Name Description
AppID*
String
Application ID returned in the response from the POST /application
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 429 - Too many requests

Status: 500 - Internal server error. Try again using an exponential backoff.


postApplication


/application

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.franklinflood.com/v1/application"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationApi;

import java.io.File;
import java.util.*;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ApplicationApi apiInstance = new ApplicationApi();
        Application body = {
  "basic" : {
    "summary" : "A sample request body",
    "value" : {
      "AgentID" : "12345678",
      "AgentFirstName" : "John",
      "AgentLastName" : "Smith",
      "AgentEmail" : "agent@example.com",
      "AgentPhoneNumber" : "123-567-8901",
      "AgencyName" : "Sample Agency",
      "InsuredFirstName" : "Alex",
      "InsuredLastName" : "Williams",
      "InsuredEmail" : "client@example.com",
      "InsuredPhoneNumber" : "567-890-1234",
      "PolicyType" : "Residential",
      "PremiumPayor" : "Insured",
      "PropertyAddress" : "1234 Something St",
      "PropertyAddress2" : "",
      "PropertyCity" : "Nowhere",
      "PropertyState" : "PA",
      "PropertyZipcode" : "12345",
      "PropertyZipcode4" : "6789",
      "PropertyLatitude" : 1.1,
      "PropertyLongitude" : 1.1,
      "PropertyType" : "Single Family",
      "PropertyDescription" : "Primary",
      "PropertyStories" : 2,
      "PropertyYearBuilt" : 1995,
      "PropertySquareFeet" : 1977,
      "PropertyConstructionType" : "Frame",
      "PropertyFoundationType" : "Basement",
      "PropertyHasPreviousLossesOrFlooding" : false,
      "PropertyOverWater" : "Entirely",
      "PropertyInFloodZone" : false,
      "PropertyHeightAboveGround" : 1,
      "CoverageForLoanClosing" : true,
      "CoverageEffectiveDate" : "2023-06-30",
      "CoverageDeductible" : 5000,
      "CoverageReplacementCost" : 300000,
      "CoverageTotalBuildingsValue" : 250000,
      "CoverageTotalContentsValue" : 0
    }
  }
}; // Application | 
        try {
            inline_response_201 result = apiInstance.postApplication(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#postApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationApi;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApplicationApi apiInstance = new ApplicationApi();
        Application body = {
  "basic" : {
    "summary" : "A sample request body",
    "value" : {
      "AgentID" : "12345678",
      "AgentFirstName" : "John",
      "AgentLastName" : "Smith",
      "AgentEmail" : "agent@example.com",
      "AgentPhoneNumber" : "123-567-8901",
      "AgencyName" : "Sample Agency",
      "InsuredFirstName" : "Alex",
      "InsuredLastName" : "Williams",
      "InsuredEmail" : "client@example.com",
      "InsuredPhoneNumber" : "567-890-1234",
      "PolicyType" : "Residential",
      "PremiumPayor" : "Insured",
      "PropertyAddress" : "1234 Something St",
      "PropertyAddress2" : "",
      "PropertyCity" : "Nowhere",
      "PropertyState" : "PA",
      "PropertyZipcode" : "12345",
      "PropertyZipcode4" : "6789",
      "PropertyLatitude" : 1.1,
      "PropertyLongitude" : 1.1,
      "PropertyType" : "Single Family",
      "PropertyDescription" : "Primary",
      "PropertyStories" : 2,
      "PropertyYearBuilt" : 1995,
      "PropertySquareFeet" : 1977,
      "PropertyConstructionType" : "Frame",
      "PropertyFoundationType" : "Basement",
      "PropertyHasPreviousLossesOrFlooding" : false,
      "PropertyOverWater" : "Entirely",
      "PropertyInFloodZone" : false,
      "PropertyHeightAboveGround" : 1,
      "CoverageForLoanClosing" : true,
      "CoverageEffectiveDate" : "2023-06-30",
      "CoverageDeductible" : 5000,
      "CoverageReplacementCost" : 300000,
      "CoverageTotalBuildingsValue" : 250000,
      "CoverageTotalContentsValue" : 0
    }
  }
}; // Application | 
        try {
            inline_response_201 result = apiInstance.postApplication(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#postApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Application *body = {
  "basic" : {
    "summary" : "A sample request body",
    "value" : {
      "AgentID" : "12345678",
      "AgentFirstName" : "John",
      "AgentLastName" : "Smith",
      "AgentEmail" : "agent@example.com",
      "AgentPhoneNumber" : "123-567-8901",
      "AgencyName" : "Sample Agency",
      "InsuredFirstName" : "Alex",
      "InsuredLastName" : "Williams",
      "InsuredEmail" : "client@example.com",
      "InsuredPhoneNumber" : "567-890-1234",
      "PolicyType" : "Residential",
      "PremiumPayor" : "Insured",
      "PropertyAddress" : "1234 Something St",
      "PropertyAddress2" : "",
      "PropertyCity" : "Nowhere",
      "PropertyState" : "PA",
      "PropertyZipcode" : "12345",
      "PropertyZipcode4" : "6789",
      "PropertyLatitude" : 1.1,
      "PropertyLongitude" : 1.1,
      "PropertyType" : "Single Family",
      "PropertyDescription" : "Primary",
      "PropertyStories" : 2,
      "PropertyYearBuilt" : 1995,
      "PropertySquareFeet" : 1977,
      "PropertyConstructionType" : "Frame",
      "PropertyFoundationType" : "Basement",
      "PropertyHasPreviousLossesOrFlooding" : false,
      "PropertyOverWater" : "Entirely",
      "PropertyInFloodZone" : false,
      "PropertyHeightAboveGround" : 1,
      "CoverageForLoanClosing" : true,
      "CoverageEffectiveDate" : "2023-06-30",
      "CoverageDeductible" : 5000,
      "CoverageReplacementCost" : 300000,
      "CoverageTotalBuildingsValue" : 250000,
      "CoverageTotalContentsValue" : 0
    }
  }
}; //  (optional)

ApplicationApi *apiInstance = [[ApplicationApi alloc] init];

[apiInstance postApplicationWith:body
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FranklinFloodApi = require('franklin_flood_api');
var defaultClient = FranklinFloodApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new FranklinFloodApi.ApplicationApi()
var opts = { 
  'body': {
  "basic" : {
    "summary" : "A sample request body",
    "value" : {
      "AgentID" : "12345678",
      "AgentFirstName" : "John",
      "AgentLastName" : "Smith",
      "AgentEmail" : "agent@example.com",
      "AgentPhoneNumber" : "123-567-8901",
      "AgencyName" : "Sample Agency",
      "InsuredFirstName" : "Alex",
      "InsuredLastName" : "Williams",
      "InsuredEmail" : "client@example.com",
      "InsuredPhoneNumber" : "567-890-1234",
      "PolicyType" : "Residential",
      "PremiumPayor" : "Insured",
      "PropertyAddress" : "1234 Something St",
      "PropertyAddress2" : "",
      "PropertyCity" : "Nowhere",
      "PropertyState" : "PA",
      "PropertyZipcode" : "12345",
      "PropertyZipcode4" : "6789",
      "PropertyLatitude" : 1.1,
      "PropertyLongitude" : 1.1,
      "PropertyType" : "Single Family",
      "PropertyDescription" : "Primary",
      "PropertyStories" : 2,
      "PropertyYearBuilt" : 1995,
      "PropertySquareFeet" : 1977,
      "PropertyConstructionType" : "Frame",
      "PropertyFoundationType" : "Basement",
      "PropertyHasPreviousLossesOrFlooding" : false,
      "PropertyOverWater" : "Entirely",
      "PropertyInFloodZone" : false,
      "PropertyHeightAboveGround" : 1,
      "CoverageForLoanClosing" : true,
      "CoverageEffectiveDate" : "2023-06-30",
      "CoverageDeductible" : 5000,
      "CoverageReplacementCost" : 300000,
      "CoverageTotalBuildingsValue" : 250000,
      "CoverageTotalContentsValue" : 0
    }
  }
} // {{Application}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postApplication(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postApplicationExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationApi();
            var body = new Application(); // Application |  (optional) 

            try
            {
                inline_response_201 result = apiInstance.postApplication(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationApi.postApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApplicationApi();
$body = {
  "basic" : {
    "summary" : "A sample request body",
    "value" : {
      "AgentID" : "12345678",
      "AgentFirstName" : "John",
      "AgentLastName" : "Smith",
      "AgentEmail" : "agent@example.com",
      "AgentPhoneNumber" : "123-567-8901",
      "AgencyName" : "Sample Agency",
      "InsuredFirstName" : "Alex",
      "InsuredLastName" : "Williams",
      "InsuredEmail" : "client@example.com",
      "InsuredPhoneNumber" : "567-890-1234",
      "PolicyType" : "Residential",
      "PremiumPayor" : "Insured",
      "PropertyAddress" : "1234 Something St",
      "PropertyAddress2" : "",
      "PropertyCity" : "Nowhere",
      "PropertyState" : "PA",
      "PropertyZipcode" : "12345",
      "PropertyZipcode4" : "6789",
      "PropertyLatitude" : 1.1,
      "PropertyLongitude" : 1.1,
      "PropertyType" : "Single Family",
      "PropertyDescription" : "Primary",
      "PropertyStories" : 2,
      "PropertyYearBuilt" : 1995,
      "PropertySquareFeet" : 1977,
      "PropertyConstructionType" : "Frame",
      "PropertyFoundationType" : "Basement",
      "PropertyHasPreviousLossesOrFlooding" : false,
      "PropertyOverWater" : "Entirely",
      "PropertyInFloodZone" : false,
      "PropertyHeightAboveGround" : 1,
      "CoverageForLoanClosing" : true,
      "CoverageEffectiveDate" : "2023-06-30",
      "CoverageDeductible" : 5000,
      "CoverageReplacementCost" : 300000,
      "CoverageTotalBuildingsValue" : 250000,
      "CoverageTotalContentsValue" : 0
    }
  }
}; // Application | 

try {
    $result = $api_instance->postApplication($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationApi->postApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationApi->new();
my $body = WWW::SwaggerClient::Object::Application->new(); # Application | 

eval { 
    my $result = $api_instance->postApplication(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationApi->postApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationApi()
body = {
  "basic" : {
    "summary" : "A sample request body",
    "value" : {
      "AgentID" : "12345678",
      "AgentFirstName" : "John",
      "AgentLastName" : "Smith",
      "AgentEmail" : "agent@example.com",
      "AgentPhoneNumber" : "123-567-8901",
      "AgencyName" : "Sample Agency",
      "InsuredFirstName" : "Alex",
      "InsuredLastName" : "Williams",
      "InsuredEmail" : "client@example.com",
      "InsuredPhoneNumber" : "567-890-1234",
      "PolicyType" : "Residential",
      "PremiumPayor" : "Insured",
      "PropertyAddress" : "1234 Something St",
      "PropertyAddress2" : "",
      "PropertyCity" : "Nowhere",
      "PropertyState" : "PA",
      "PropertyZipcode" : "12345",
      "PropertyZipcode4" : "6789",
      "PropertyLatitude" : 1.1,
      "PropertyLongitude" : 1.1,
      "PropertyType" : "Single Family",
      "PropertyDescription" : "Primary",
      "PropertyStories" : 2,
      "PropertyYearBuilt" : 1995,
      "PropertySquareFeet" : 1977,
      "PropertyConstructionType" : "Frame",
      "PropertyFoundationType" : "Basement",
      "PropertyHasPreviousLossesOrFlooding" : false,
      "PropertyOverWater" : "Entirely",
      "PropertyInFloodZone" : false,
      "PropertyHeightAboveGround" : 1,
      "CoverageForLoanClosing" : true,
      "CoverageEffectiveDate" : "2023-06-30",
      "CoverageDeductible" : 5000,
      "CoverageReplacementCost" : 300000,
      "CoverageTotalBuildingsValue" : 250000,
      "CoverageTotalContentsValue" : 0
    }
  }
} # Application |  (optional)

try: 
    api_response = api_instance.post_application(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationApi->postApplication: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 429 - Too many requests

Status: 500 - Internal server error. Try again using an exponential backoff.


putApplication

Update an existing application


/application/{AppID}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://api.franklinflood.com/v1/application/{AppID}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationApi;

import java.io.File;
import java.util.*;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        ApplicationApi apiInstance = new ApplicationApi();
        String appID = appID_example; // String | Application ID returned in the response from the POST /application
        Application_AppID_body body = ; // Application_AppID_body | 
        try {
            apiInstance.putApplication(appID, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#putApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationApi;

public class ApplicationApiExample {

    public static void main(String[] args) {
        ApplicationApi apiInstance = new ApplicationApi();
        String appID = appID_example; // String | Application ID returned in the response from the POST /application
        Application_AppID_body body = ; // Application_AppID_body | 
        try {
            apiInstance.putApplication(appID, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationApi#putApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *appID = appID_example; // Application ID returned in the response from the POST /application
Application_AppID_body *body = ; //  (optional)

ApplicationApi *apiInstance = [[ApplicationApi alloc] init];

// Update an existing application
[apiInstance putApplicationWith:appID
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FranklinFloodApi = require('franklin_flood_api');
var defaultClient = FranklinFloodApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new FranklinFloodApi.ApplicationApi()
var appID = appID_example; // {{String}} Application ID returned in the response from the POST /application
var opts = { 
  'body':  // {{Application_AppID_body}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putApplication(appID, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class putApplicationExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationApi();
            var appID = appID_example;  // String | Application ID returned in the response from the POST /application
            var body = new Application_AppID_body(); // Application_AppID_body |  (optional) 

            try
            {
                // Update an existing application
                apiInstance.putApplication(appID, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationApi.putApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApplicationApi();
$appID = appID_example; // String | Application ID returned in the response from the POST /application
$body = ; // Application_AppID_body | 

try {
    $api_instance->putApplication($appID, $body);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationApi->putApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationApi->new();
my $appID = appID_example; # String | Application ID returned in the response from the POST /application
my $body = WWW::SwaggerClient::Object::Application_AppID_body->new(); # Application_AppID_body | 

eval { 
    $api_instance->putApplication(appID => $appID, body => $body);
};
if ($@) {
    warn "Exception when calling ApplicationApi->putApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationApi()
appID = appID_example # String | Application ID returned in the response from the POST /application
body =  # Application_AppID_body |  (optional)

try: 
    # Update an existing application
    api_instance.put_application(appID, body=body)
except ApiException as e:
    print("Exception when calling ApplicationApi->putApplication: %s\n" % e)

Parameters

Path parameters
Name Description
AppID*
String
Application ID returned in the response from the POST /application
Required
Body parameters
Name Description
body

Responses

Status: 200 - Update successful

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 412 - Bind coverage already requested

Status: 429 - Too many requests

Status: 500 - Internal server error. Try again using an exponential backoff.


System

getVersion

Current API version

Current version of the Franklin Flood API. This API follows [SemVer](https://semver.org/).


/version

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
"https://api.franklinflood.com/v1/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemApi;

import java.io.File;
import java.util.*;

public class SystemApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        SystemApi apiInstance = new SystemApi();
        try {
            apiInstance.getVersion();
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#getVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemApi;

public class SystemApiExample {

    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        try {
            apiInstance.getVersion();
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#getVersion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Bearer)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

SystemApi *apiInstance = [[SystemApi alloc] init];

// Current API version
[apiInstance getVersionWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FranklinFloodApi = require('franklin_flood_api');
var defaultClient = FranklinFloodApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new FranklinFloodApi.SystemApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getVersion(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVersionExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new SystemApi();

            try
            {
                // Current API version
                apiInstance.getVersion();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemApi.getVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Bearer
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiSystemApi();

try {
    $api_instance->getVersion();
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->getVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SystemApi->new();

eval { 
    $api_instance->getVersion();
};
if ($@) {
    warn "Exception when calling SystemApi->getVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SystemApi()

try: 
    # Current API version
    api_instance.get_version()
except ApiException as e:
    print("Exception when calling SystemApi->getVersion: %s\n" % e)

Parameters

Responses

Status: 200 - The version of the API

Status: 401 - Unauthorized