Api Documentation

Code

findCode

find codes or options by id, e.g. GENDER (male, female)


/rest/v1/co/code/{codeHdrId}

Usage and SDK Samples

curl -X GET "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/code/{codeHdrId}?codeGrp=&orderBySeq=&desc=&locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CodeApi;

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

public class CodeApiExample {

    public static void main(String[] args) {
        
        CodeApi apiInstance = new CodeApi();
        String codeHdrId = codeHdrId_example; // String | id of the code list, e.g. GENDER
        String codeGrp = codeGrp_example; // String | specific group of the code
        Boolean orderBySeq = true; // Boolean | is order/sort by sequence
        Boolean desc = true; // Boolean | is descending order
        String locale = locale_example; // String | locale
        try {
            array[CodeDescDisplay] result = apiInstance.findCode(codeHdrId, codeGrp, orderBySeq, desc, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#findCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CodeApi;

public class CodeApiExample {

    public static void main(String[] args) {
        CodeApi apiInstance = new CodeApi();
        String codeHdrId = codeHdrId_example; // String | id of the code list, e.g. GENDER
        String codeGrp = codeGrp_example; // String | specific group of the code
        Boolean orderBySeq = true; // Boolean | is order/sort by sequence
        Boolean desc = true; // Boolean | is descending order
        String locale = locale_example; // String | locale
        try {
            array[CodeDescDisplay] result = apiInstance.findCode(codeHdrId, codeGrp, orderBySeq, desc, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CodeApi#findCode");
            e.printStackTrace();
        }
    }
}
String *codeHdrId = codeHdrId_example; // id of the code list, e.g. GENDER
String *codeGrp = codeGrp_example; // specific group of the code (optional)
Boolean *orderBySeq = true; // is order/sort by sequence (optional)
Boolean *desc = true; // is descending order (optional)
String *locale = locale_example; // locale (optional)

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

// find codes or options by id, e.g. GENDER (male, female)
[apiInstance findCodeWith:codeHdrId
    codeGrp:codeGrp
    orderBySeq:orderBySeq
    desc:desc
    locale:locale
              completionHandler: ^(array[CodeDescDisplay] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.CodeApi()

var codeHdrId = codeHdrId_example; // {String} id of the code list, e.g. GENDER

var opts = { 
  'codeGrp': codeGrp_example, // {String} specific group of the code
  'orderBySeq': true, // {Boolean} is order/sort by sequence
  'desc': true, // {Boolean} is descending order
  'locale': locale_example // {String} locale
};

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

namespace Example
{
    public class findCodeExample
    {
        public void main()
        {
            
            var apiInstance = new CodeApi();
            var codeHdrId = codeHdrId_example;  // String | id of the code list, e.g. GENDER
            var codeGrp = codeGrp_example;  // String | specific group of the code (optional) 
            var orderBySeq = true;  // Boolean | is order/sort by sequence (optional) 
            var desc = true;  // Boolean | is descending order (optional) 
            var locale = locale_example;  // String | locale (optional) 

            try
            {
                // find codes or options by id, e.g. GENDER (male, female)
                array[CodeDescDisplay] result = apiInstance.findCode(codeHdrId, codeGrp, orderBySeq, desc, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CodeApi.findCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CodeApi();
$codeHdrId = codeHdrId_example; // String | id of the code list, e.g. GENDER
$codeGrp = codeGrp_example; // String | specific group of the code
$orderBySeq = true; // Boolean | is order/sort by sequence
$desc = true; // Boolean | is descending order
$locale = locale_example; // String | locale

try {
    $result = $api_instance->findCode($codeHdrId, $codeGrp, $orderBySeq, $desc, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CodeApi->findCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CodeApi;

my $api_instance = WWW::SwaggerClient::CodeApi->new();
my $codeHdrId = codeHdrId_example; # String | id of the code list, e.g. GENDER
my $codeGrp = codeGrp_example; # String | specific group of the code
my $orderBySeq = true; # Boolean | is order/sort by sequence
my $desc = true; # Boolean | is descending order
my $locale = locale_example; # String | locale

eval { 
    my $result = $api_instance->findCode(codeHdrId => $codeHdrId, codeGrp => $codeGrp, orderBySeq => $orderBySeq, desc => $desc, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CodeApi->findCode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CodeApi()
codeHdrId = codeHdrId_example # String | id of the code list, e.g. GENDER
codeGrp = codeGrp_example # String | specific group of the code (optional)
orderBySeq = true # Boolean | is order/sort by sequence (optional)
desc = true # Boolean | is descending order (optional)
locale = locale_example # String | locale (optional)

try: 
    # find codes or options by id, e.g. GENDER (male, female)
    api_response = api_instance.find_code(codeHdrId, codeGrp=codeGrp, orderBySeq=orderBySeq, desc=desc, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CodeApi->findCode: %s\n" % e)

Parameters

Path parameters
Name Description
codeHdrId*
String
id of the code list, e.g. GENDER
Required
Query parameters
Name Description
codeGrp
String
specific group of the code
orderBySeq
Boolean
is order/sort by sequence
desc
Boolean
is descending order
locale
String
locale

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


Form

createForm

create new form. Start at Form Section 0: Financial Planning Type


/rest/v1/co/form/create

Usage and SDK Samples

curl -X POST "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/form/create"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

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

public class FormApiExample {

    public static void main(String[] args) {
        
        FormApi apiInstance = new FormApi();
        OnboardingCreateForm form = ; // OnboardingCreateForm | form
        try {
            OnboardingCreateResponse result = apiInstance.createForm(form);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#createForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        OnboardingCreateForm form = ; // OnboardingCreateForm | form
        try {
            OnboardingCreateResponse result = apiInstance.createForm(form);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#createForm");
            e.printStackTrace();
        }
    }
}
OnboardingCreateForm *form = ; // form

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

// create new form. Start at Form Section 0: Financial Planning Type
[apiInstance createFormWith:form
              completionHandler: ^(OnboardingCreateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.FormApi()

var form = ; // {OnboardingCreateForm} form


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

namespace Example
{
    public class createFormExample
    {
        public void main()
        {
            
            var apiInstance = new FormApi();
            var form = new OnboardingCreateForm(); // OnboardingCreateForm | form

            try
            {
                // create new form. Start at Form Section 0: Financial Planning Type
                OnboardingCreateResponse result = apiInstance.createForm(form);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.createForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FormApi();
$form = ; // OnboardingCreateForm | form

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

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $form = WWW::SwaggerClient::Object::OnboardingCreateForm->new(); # OnboardingCreateForm | form

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

# create an instance of the API class
api_instance = swagger_client.FormApi()
form =  # OnboardingCreateForm | form

try: 
    # create new form. Start at Form Section 0: Financial Planning Type
    api_response = api_instance.create_form(form)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormApi->createForm: %s\n" % e)

Parameters

Body parameters
Name Description
form *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


deleteForm

delete form record


/rest/v1/co/form/delete/{id}

Usage and SDK Samples

curl -X DELETE "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/form/delete/{id}?key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

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

public class FormApiExample {

    public static void main(String[] args) {
        
        FormApi apiInstance = new FormApi();
        String id = id_example; // String | id of the form record
        String key = key_example; // String | key to access form without login
        try {
            apiInstance.deleteForm(id, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#deleteForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        String id = id_example; // String | id of the form record
        String key = key_example; // String | key to access form without login
        try {
            apiInstance.deleteForm(id, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#deleteForm");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // id of the form record
String *key = key_example; // key to access form without login (optional)

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

// delete form record
[apiInstance deleteFormWith:id
    key:key
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.FormApi()

var id = id_example; // {String} id of the form record

var opts = { 
  'key': key_example // {String} key to access form without login
};

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

namespace Example
{
    public class deleteFormExample
    {
        public void main()
        {
            
            var apiInstance = new FormApi();
            var id = id_example;  // String | id of the form record
            var key = key_example;  // String | key to access form without login (optional) 

            try
            {
                // delete form record
                apiInstance.deleteForm(id, key);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.deleteForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FormApi();
$id = id_example; // String | id of the form record
$key = key_example; // String | key to access form without login

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

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $id = id_example; # String | id of the form record
my $key = key_example; # String | key to access form without login

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

# create an instance of the API class
api_instance = swagger_client.FormApi()
id = id_example # String | id of the form record
key = key_example # String | key to access form without login (optional)

try: 
    # delete form record
    api_instance.delete_form(id, key=key)
except ApiException as e:
    print("Exception when calling FormApi->deleteForm: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
id of the form record
Required
Query parameters
Name Description
key
String
key to access form without login

Responses

Status: 200 - OK

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden


financialFreedomCalculation

To calculate the amount of money needed to reach financial freedom based on the desired monthly income


/rest/v1/co/form/calculate-financial-freedom

Usage and SDK Samples

curl -X POST "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/form/calculate-financial-freedom"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

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

public class FormApiExample {

    public static void main(String[] args) {
        
        FormApi apiInstance = new FormApi();
        OnboardingDesiredMonthlyIncomeForm form = ; // OnboardingDesiredMonthlyIncomeForm | form
        try {
            array[CoFutureDesiredIncomeDisplay] result = apiInstance.financialFreedomCalculation(form);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#financialFreedomCalculation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        OnboardingDesiredMonthlyIncomeForm form = ; // OnboardingDesiredMonthlyIncomeForm | form
        try {
            array[CoFutureDesiredIncomeDisplay] result = apiInstance.financialFreedomCalculation(form);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#financialFreedomCalculation");
            e.printStackTrace();
        }
    }
}
OnboardingDesiredMonthlyIncomeForm *form = ; // form

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

// To calculate the amount of money needed to reach financial freedom based on the desired monthly income
[apiInstance financialFreedomCalculationWith:form
              completionHandler: ^(array[CoFutureDesiredIncomeDisplay] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.FormApi()

var form = ; // {OnboardingDesiredMonthlyIncomeForm} form


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

namespace Example
{
    public class financialFreedomCalculationExample
    {
        public void main()
        {
            
            var apiInstance = new FormApi();
            var form = new OnboardingDesiredMonthlyIncomeForm(); // OnboardingDesiredMonthlyIncomeForm | form

            try
            {
                // To calculate the amount of money needed to reach financial freedom based on the desired monthly income
                array[CoFutureDesiredIncomeDisplay] result = apiInstance.financialFreedomCalculation(form);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.financialFreedomCalculation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FormApi();
$form = ; // OnboardingDesiredMonthlyIncomeForm | form

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

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $form = WWW::SwaggerClient::Object::OnboardingDesiredMonthlyIncomeForm->new(); # OnboardingDesiredMonthlyIncomeForm | form

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

# create an instance of the API class
api_instance = swagger_client.FormApi()
form =  # OnboardingDesiredMonthlyIncomeForm | form

try: 
    # To calculate the amount of money needed to reach financial freedom based on the desired monthly income
    api_response = api_instance.financial_freedom_calculation(form)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormApi->financialFreedomCalculation: %s\n" % e)

Parameters

Body parameters
Name Description
form *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


findForm

find list of form record


/rest/v1/co/form/get

Usage and SDK Samples

curl -X GET "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/form/get"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

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

public class FormApiExample {

    public static void main(String[] args) {
        
        FormApi apiInstance = new FormApi();
        try {
            array[OnboardingFormVo] result = apiInstance.findForm();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#findForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        try {
            array[OnboardingFormVo] result = apiInstance.findForm();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#findForm");
            e.printStackTrace();
        }
    }
}

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

// find list of form record
[apiInstance findFormWithCompletionHandler: 
              ^(array[OnboardingFormVo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.FormApi()

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

namespace Example
{
    public class findFormExample
    {
        public void main()
        {
            
            var apiInstance = new FormApi();

            try
            {
                // find list of form record
                array[OnboardingFormVo] result = apiInstance.findForm();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.findForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FormApi();

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

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

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

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

try: 
    # find list of form record
    api_response = api_instance.find_form()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormApi->findForm: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


getFormById

get form data by id


/rest/v1/co/form/get/{id}

Usage and SDK Samples

curl -X GET "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/form/get/{id}?section=&key=&showPolicy="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

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

public class FormApiExample {

    public static void main(String[] args) {
        
        FormApi apiInstance = new FormApi();
        String id = id_example; // String | id of the form record
        String section = section_example; // String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
        String key = key_example; // String | key to access form without login
        String showPolicy = showPolicy_example; // String | show policy
        try {
            OnboardingForm result = apiInstance.getFormById(id, section, key, showPolicy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#getFormById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        String id = id_example; // String | id of the form record
        String section = section_example; // String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
        String key = key_example; // String | key to access form without login
        String showPolicy = showPolicy_example; // String | show policy
        try {
            OnboardingForm result = apiInstance.getFormById(id, section, key, showPolicy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#getFormById");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // id of the form record
String *section = section_example; // section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj (optional)
String *key = key_example; // key to access form without login (optional)
String *showPolicy = showPolicy_example; // show policy (optional)

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

// get form data by id
[apiInstance getFormByIdWith:id
    section:section
    key:key
    showPolicy:showPolicy
              completionHandler: ^(OnboardingForm output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.FormApi()

var id = id_example; // {String} id of the form record

var opts = { 
  'section': section_example, // {String} section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
  'key': key_example, // {String} key to access form without login
  'showPolicy': showPolicy_example // {String} show policy
};

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

namespace Example
{
    public class getFormByIdExample
    {
        public void main()
        {
            
            var apiInstance = new FormApi();
            var id = id_example;  // String | id of the form record
            var section = section_example;  // String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj (optional) 
            var key = key_example;  // String | key to access form without login (optional) 
            var showPolicy = showPolicy_example;  // String | show policy (optional) 

            try
            {
                // get form data by id
                OnboardingForm result = apiInstance.getFormById(id, section, key, showPolicy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.getFormById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FormApi();
$id = id_example; // String | id of the form record
$section = section_example; // String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
$key = key_example; // String | key to access form without login
$showPolicy = showPolicy_example; // String | show policy

try {
    $result = $api_instance->getFormById($id, $section, $key, $showPolicy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FormApi->getFormById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FormApi;

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $id = id_example; # String | id of the form record
my $section = section_example; # String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
my $key = key_example; # String | key to access form without login
my $showPolicy = showPolicy_example; # String | show policy

eval { 
    my $result = $api_instance->getFormById(id => $id, section => $section, key => $key, showPolicy => $showPolicy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FormApi->getFormById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FormApi()
id = id_example # String | id of the form record
section = section_example # String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj (optional)
key = key_example # String | key to access form without login (optional)
showPolicy = showPolicy_example # String | show policy (optional)

try: 
    # get form data by id
    api_response = api_instance.get_form_by_id(id, section=section, key=key, showPolicy=showPolicy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FormApi->getFormById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
id of the form record
Required
Query parameters
Name Description
section
String
section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
key
String
key to access form without login
showPolicy
String
show policy

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


resetForm

reset form data for each section.


/rest/v1/co/form/reset/{id}

Usage and SDK Samples

curl -X POST "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/form/reset/{id}?section=&key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

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

public class FormApiExample {

    public static void main(String[] args) {
        
        FormApi apiInstance = new FormApi();
        String id = id_example; // String | id of the form record
        String section = section_example; // String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
        String key = key_example; // String | key to access form without login
        try {
            apiInstance.resetForm(id, section, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#resetForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        String id = id_example; // String | id of the form record
        String section = section_example; // String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
        String key = key_example; // String | key to access form without login
        try {
            apiInstance.resetForm(id, section, key);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#resetForm");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // id of the form record
String *section = section_example; // section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj (optional)
String *key = key_example; // key to access form without login (optional)

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

// reset form data for each section.
[apiInstance resetFormWith:id
    section:section
    key:key
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.FormApi()

var id = id_example; // {String} id of the form record

var opts = { 
  'section': section_example, // {String} section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
  'key': key_example // {String} key to access form without login
};

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

namespace Example
{
    public class resetFormExample
    {
        public void main()
        {
            
            var apiInstance = new FormApi();
            var id = id_example;  // String | id of the form record
            var section = section_example;  // String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj (optional) 
            var key = key_example;  // String | key to access form without login (optional) 

            try
            {
                // reset form data for each section.
                apiInstance.resetForm(id, section, key);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.resetForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FormApi();
$id = id_example; // String | id of the form record
$section = section_example; // String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
$key = key_example; // String | key to access form without login

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

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $id = id_example; # String | id of the form record
my $section = section_example; # String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
my $key = key_example; # String | key to access form without login

eval { 
    $api_instance->resetForm(id => $id, section => $section, key => $key);
};
if ($@) {
    warn "Exception when calling FormApi->resetForm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FormApi()
id = id_example # String | id of the form record
section = section_example # String | section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj (optional)
key = key_example # String | key to access form without login (optional)

try: 
    # reset form data for each section.
    api_instance.reset_form(id, section=section, key=key)
except ApiException as e:
    print("Exception when calling FormApi->resetForm: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
id of the form record
Required
Query parameters
Name Description
section
String
section id, e.g. intro, lp, irp, al, ls, ff, cpn, pc, fpj
key
String
key to access form without login

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


updateForm

update/save form data for each section. Recommended to update at the end of each section.


/rest/v1/co/form/save

Usage and SDK Samples

curl -X POST "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/form/save"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

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

public class FormApiExample {

    public static void main(String[] args) {
        
        FormApi apiInstance = new FormApi();
        OnboardingForm form = ; // OnboardingForm | form
        try {
            apiInstance.updateForm(form);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#updateForm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        OnboardingForm form = ; // OnboardingForm | form
        try {
            apiInstance.updateForm(form);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#updateForm");
            e.printStackTrace();
        }
    }
}
OnboardingForm *form = ; // form

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

// update/save form data for each section. Recommended to update at the end of each section.
[apiInstance updateFormWith:form
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.FormApi()

var form = ; // {OnboardingForm} form


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

namespace Example
{
    public class updateFormExample
    {
        public void main()
        {
            
            var apiInstance = new FormApi();
            var form = new OnboardingForm(); // OnboardingForm | form

            try
            {
                // update/save form data for each section. Recommended to update at the end of each section.
                apiInstance.updateForm(form);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.updateForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FormApi();
$form = ; // OnboardingForm | form

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

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $form = WWW::SwaggerClient::Object::OnboardingForm->new(); # OnboardingForm | form

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

# create an instance of the API class
api_instance = swagger_client.FormApi()
form =  # OnboardingForm | form

try: 
    # update/save form data for each section. Recommended to update at the end of each section.
    api_instance.update_form(form)
except ApiException as e:
    print("Exception when calling FormApi->updateForm: %s\n" % e)

Parameters

Body parameters
Name Description
form *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


updateFormWithFile

update/save form data for each section with multipart/form-data. Recommended to update at the end of each section.


/rest/v1/co/form/save-with-file

Usage and SDK Samples

curl -X POST "https://trial-advancingfreedom.azurewebsites.net/rest/v1/co/form/save-with-file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FormApi;

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

public class FormApiExample {

    public static void main(String[] args) {
        
        FormApi apiInstance = new FormApi();
        OnboardingForm form = ; // OnboardingForm | form data
        File attachments = /path/to/file.txt; // File | attachments in multipart/form-data. e.g. policy attachment
        try {
            apiInstance.updateFormWithFile(form, attachments);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#updateFormWithFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FormApi;

public class FormApiExample {

    public static void main(String[] args) {
        FormApi apiInstance = new FormApi();
        OnboardingForm form = ; // OnboardingForm | form data
        File attachments = /path/to/file.txt; // File | attachments in multipart/form-data. e.g. policy attachment
        try {
            apiInstance.updateFormWithFile(form, attachments);
        } catch (ApiException e) {
            System.err.println("Exception when calling FormApi#updateFormWithFile");
            e.printStackTrace();
        }
    }
}
OnboardingForm *form = ; // form data (optional)
File *attachments = /path/to/file.txt; // attachments in multipart/form-data. e.g. policy attachment (optional)

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

// update/save form data for each section with multipart/form-data. Recommended to update at the end of each section.
[apiInstance updateFormWithFileWith:form
    attachments:attachments
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.FormApi()

var opts = { 
  'form': , // {OnboardingForm} form data
  'attachments': /path/to/file.txt // {File} attachments in multipart/form-data. e.g. policy attachment
};

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

namespace Example
{
    public class updateFormWithFileExample
    {
        public void main()
        {
            
            var apiInstance = new FormApi();
            var form = new OnboardingForm(); // OnboardingForm | form data (optional) 
            var attachments = new File(); // File | attachments in multipart/form-data. e.g. policy attachment (optional) 

            try
            {
                // update/save form data for each section with multipart/form-data. Recommended to update at the end of each section.
                apiInstance.updateFormWithFile(form, attachments);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FormApi.updateFormWithFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FormApi();
$form = ; // OnboardingForm | form data
$attachments = /path/to/file.txt; // File | attachments in multipart/form-data. e.g. policy attachment

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

my $api_instance = WWW::SwaggerClient::FormApi->new();
my $form = WWW::SwaggerClient::Object::OnboardingForm->new(); # OnboardingForm | form data
my $attachments = /path/to/file.txt; # File | attachments in multipart/form-data. e.g. policy attachment

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

# create an instance of the API class
api_instance = swagger_client.FormApi()
form =  # OnboardingForm | form data (optional)
attachments = /path/to/file.txt # File | attachments in multipart/form-data. e.g. policy attachment (optional)

try: 
    # update/save form data for each section with multipart/form-data. Recommended to update at the end of each section.
    api_instance.update_form_with_file(form=form, attachments=attachments)
except ApiException as e:
    print("Exception when calling FormApi->updateFormWithFile: %s\n" % e)

Parameters

Body parameters
Name Description
form
Form parameters
Name Description
attachments
File
attachments in multipart/form-data. e.g. policy attachment

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


Login

login

login


/rest/security/login-dev-only

Usage and SDK Samples

curl -X POST "https://trial-advancingfreedom.azurewebsites.net/rest/security/login-dev-only"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoginApi;

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

public class LoginApiExample {

    public static void main(String[] args) {
        
        LoginApi apiInstance = new LoginApi();
        LoginDevForm loginDataForm = ; // LoginDevForm | loginDataForm
        try {
            Object result = apiInstance.login(loginDataForm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#login");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LoginApi;

public class LoginApiExample {

    public static void main(String[] args) {
        LoginApi apiInstance = new LoginApi();
        LoginDevForm loginDataForm = ; // LoginDevForm | loginDataForm
        try {
            Object result = apiInstance.login(loginDataForm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#login");
            e.printStackTrace();
        }
    }
}
LoginDevForm *loginDataForm = ; // loginDataForm

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

// login
[apiInstance loginWith:loginDataForm
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.LoginApi()

var loginDataForm = ; // {LoginDevForm} loginDataForm


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

namespace Example
{
    public class loginExample
    {
        public void main()
        {
            
            var apiInstance = new LoginApi();
            var loginDataForm = new LoginDevForm(); // LoginDevForm | loginDataForm

            try
            {
                // login
                Object result = apiInstance.login(loginDataForm);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoginApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LoginApi();
$loginDataForm = ; // LoginDevForm | loginDataForm

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

my $api_instance = WWW::SwaggerClient::LoginApi->new();
my $loginDataForm = WWW::SwaggerClient::Object::LoginDevForm->new(); # LoginDevForm | loginDataForm

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

# create an instance of the API class
api_instance = swagger_client.LoginApi()
loginDataForm =  # LoginDevForm | loginDataForm

try: 
    # login
    api_response = api_instance.login(loginDataForm)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoginApi->login: %s\n" % e)

Parameters

Body parameters
Name Description
loginDataForm *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden


logout

logout


/rest/security/logout

Usage and SDK Samples

curl -X POST "https://trial-advancingfreedom.azurewebsites.net/rest/security/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoginApi;

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

public class LoginApiExample {

    public static void main(String[] args) {
        
        LoginApi apiInstance = new LoginApi();
        try {
            Object result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#logout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LoginApi;

public class LoginApiExample {

    public static void main(String[] args) {
        LoginApi apiInstance = new LoginApi();
        try {
            Object result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#logout");
            e.printStackTrace();
        }
    }
}

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

// logout
[apiInstance logoutWithCompletionHandler: 
              ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiDocumentation = require('api_documentation');

var api = new ApiDocumentation.LoginApi()

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

namespace Example
{
    public class logoutExample
    {
        public void main()
        {
            
            var apiInstance = new LoginApi();

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

$api_instance = new Swagger\Client\Api\LoginApi();

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

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

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

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

try: 
    # logout
    api_response = api_instance.logout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoginApi->logout: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden