Open Field

Api

createConversationCode


/api/v1/conversation-codes/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/conversation-codes/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        ConversationCode body = ; // ConversationCode | 
        try {
            ConversationCode result = apiInstance.createConversationCode(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createConversationCode");
            e.printStackTrace();
        }
    }
}
ConversationCode *body = ; //  (optional)

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

[apiInstance createConversationCodeWith:body
              completionHandler: ^(ConversationCode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{ConversationCode}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConversationCode(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new ConversationCode(); // ConversationCode |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // ConversationCode | 

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

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

eval { 
    my $result = $api_instance->createConversationCode(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createConversationCode: [email protected]\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.ApiApi()
body =  # ConversationCode |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
code
String
created_at
Date (date-time)
created_by
String
description
String
org
String
script
Integer
targets
Integer
expires
Date (date-time)
conversation_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST
start_time
String
end_time
String
status
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST Processing, Active, After Hours, Expired, Deactivated
attempt_goal
Integer
reg_goal
Integer
vbm_goal
Integer
id
Integer
code
String
created_at
Date (date-time)
created_by
String
description
String
org
String
script
Integer
targets
Integer
expires
Date (date-time)
conversation_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST Processing, Active, After Hours, Expired, Deactivated VK, PK, VR, PR, VC, PC, VD, PD, ST
start_time
String
end_time
String
status
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST Processing, Active, After Hours, Expired, Deactivated VK, PK, VR, PR, VC, PC, VD, PD, ST Processing, Active, After Hours, Expired, Deactivated
attempt_goal
Integer
reg_goal
Integer
vbm_goal
Integer

Responses

Status: 201 -


createConversations


/api/v1/conversations/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/conversations/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Conversations body = ; // Conversations | 
        try {
            Conversations result = apiInstance.createConversations(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createConversations");
            e.printStackTrace();
        }
    }
}
Conversations *body = ; //  (optional)

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

[apiInstance createConversationsWith:body
              completionHandler: ^(Conversations output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{Conversations}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConversations(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new Conversations(); // Conversations |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // Conversations | 

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

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

eval { 
    my $result = $api_instance->createConversations(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createConversations: [email protected]\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.ApiApi()
body =  # Conversations |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
canvasser
Integer
contacted_id
Integer
conversation_time
Date (date-time)
conversation_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST
contact_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL
contact
Boolean
conversation_code
Integer
contact_script
Integer
contacted_national_address_id
Integer
contacted_phone
String
relationship_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R
languages_of_conversation
Integer
id
Integer
canvasser
Integer
contacted_id
Integer
conversation_time
Date (date-time)
conversation_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R VK, PK, VR, PR, VC, PC, VD, PD, ST
contact_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL
contact
Boolean
conversation_code
Integer
contact_script
Integer
contacted_national_address_id
Integer
contacted_phone
String
relationship_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R
languages_of_conversation
Integer

Responses

Status: 201 -


createLabel


/api/v1/labels/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/labels/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Label body = ; // Label | 
        try {
            Label result = apiInstance.createLabel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createLabel");
            e.printStackTrace();
        }
    }
}
Label *body = ; //  (optional)

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

[apiInstance createLabelWith:body
              completionHandler: ^(Label output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{Label}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createLabel(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new Label(); // Label |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // Label | 

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

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

eval { 
    my $result = $api_instance->createLabel(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createLabel: [email protected]\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.ApiApi()
body =  # Label |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
name
String
description
String
id
Integer
name
String
description
String

Responses

Status: 201 -


createLanguage


/api/v1/languages/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/languages/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Language body = ; // Language | 
        try {
            Language result = apiInstance.createLanguage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createLanguage");
            e.printStackTrace();
        }
    }
}
Language *body = ; //  (optional)

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

[apiInstance createLanguageWith:body
              completionHandler: ^(Language output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{Language}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createLanguage(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new Language(); // Language |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // Language | 

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

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

eval { 
    my $result = $api_instance->createLanguage(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createLanguage: [email protected]\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.ApiApi()
body =  # Language |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
isocode
String
name
String
sorting
Integer
id
Integer
isocode
String
name
String
sorting
Integer

Responses

Status: 201 -


createLogin

Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework Accept the following POST parameters: username, password Return the REST Framework Token Object's key.


/api/v1/auth/login/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/auth/login/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Login body = ; // Login | 
        try {
            Login result = apiInstance.createLogin(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createLogin");
            e.printStackTrace();
        }
    }
}
Login *body = ; //  (optional)

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

[apiInstance createLoginWith:body
              completionHandler: ^(Login output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{Login}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createLogin(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new Login(); // Login |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // Login | 

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

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

eval { 
    my $result = $api_instance->createLogin(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createLogin: [email protected]\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.ApiApi()
body =  # Login |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
email
String (email)
password
String
email
String (email)
password
String

Responses

Status: 201 -


createLogout

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.


/api/v1/auth/logout/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/auth/logout/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance createLogoutWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

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

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

            var apiInstance = new ApiApi();
            var body = new (); //  |  (optional) 

            try
            {
                apiInstance.createLogout(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.createLogout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; //  | 

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

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

eval { 
    $api_instance->createLogout(body => $body);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createLogout: [email protected]\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.ApiApi()
body =  #  |  (optional)

try: 
    api_instance.create_logout(body=body)
except ApiException as e:
    print("Exception when calling ApiApi->createLogout: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 -


createNationalAddress


/api/v1/national-addresses/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/national-addresses/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        NationalAddress body = ; // NationalAddress | 
        try {
            NationalAddress result = apiInstance.createNationalAddress(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createNationalAddress");
            e.printStackTrace();
        }
    }
}
NationalAddress *body = ; //  (optional)

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

[apiInstance createNationalAddressWith:body
              completionHandler: ^(NationalAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{NationalAddress}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNationalAddress(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new NationalAddress(); // NationalAddress |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // NationalAddress | 

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

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

eval { 
    my $result = $api_instance->createNationalAddress(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createNationalAddress: [email protected]\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.ApiApi()
body =  # NationalAddress |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
national_address_id
Integer
os_naid_hash
String
dot_guid
String
full_address
String
has_units
Boolean
building_id
String
address12
String
address1
String
address2
String
street_number
String
street_name
String
building
String
unit
String
p_city
String
p_state
String
p_county
String
p_zip_5
String
p_zip_4
String
country
String
even_or_odd
String
Enum: E, O, S
precinct_name
String
precinct_number
String
polling_location
String
polling_location_address
String
municipality
String
ward
String
citydistrict
String
lower_state_leg
String
upper_state_leg
String
congressional
String
raw_lat_long
String
raw_lat
BigDecimal
raw_long
BigDecimal
geom
String
labels
array[Integer]
local_door_notes
String
census_block
Integer
national_address_id
Integer
os_naid_hash
String
dot_guid
String
full_address
String
has_units
Boolean
building_id
String
address12
String
address1
String
address2
String
street_number
String
street_name
String
building
String
unit
String
p_city
String
p_state
String
p_county
String
p_zip_5
String
p_zip_4
String
country
String
even_or_odd
String
Enum: E, O, S E, O, S
precinct_name
String
precinct_number
String
polling_location
String
polling_location_address
String
municipality
String
ward
String
citydistrict
String
lower_state_leg
String
upper_state_leg
String
congressional
String
raw_lat_long
String
raw_lat
BigDecimal
raw_long
BigDecimal
geom
String
labels
array[Integer]
local_door_notes
String
census_block
Integer

Responses

Status: 201 -


createPasswordChange

Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.


/api/v1/auth/password/change/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/auth/password/change/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        PasswordChange body = ; // PasswordChange | 
        try {
            PasswordChange result = apiInstance.createPasswordChange(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createPasswordChange");
            e.printStackTrace();
        }
    }
}
PasswordChange *body = ; //  (optional)

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

[apiInstance createPasswordChangeWith:body
              completionHandler: ^(PasswordChange output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{PasswordChange}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPasswordChange(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new PasswordChange(); // PasswordChange |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // PasswordChange | 

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

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

eval { 
    my $result = $api_instance->createPasswordChange(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createPasswordChange: [email protected]\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.ApiApi()
body =  # PasswordChange |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
new_password1
String
new_password2
String
new_password1
String
new_password2
String

Responses

Status: 201 -


createPasswordReset

Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.


/api/v1/auth/password/reset/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/auth/password/reset/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        PasswordReset body = ; // PasswordReset | 
        try {
            PasswordReset result = apiInstance.createPasswordReset(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createPasswordReset");
            e.printStackTrace();
        }
    }
}
PasswordReset *body = ; //  (optional)

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

[apiInstance createPasswordResetWith:body
              completionHandler: ^(PasswordReset output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{PasswordReset}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPasswordReset(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new PasswordReset(); // PasswordReset |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // PasswordReset | 

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

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

eval { 
    my $result = $api_instance->createPasswordReset(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createPasswordReset: [email protected]\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.ApiApi()
body =  # PasswordReset |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
email
String (email)
email
String (email)

Responses

Status: 201 -


createPasswordResetConfirm

Password reset e-mail link is confirmed, therefore this resets the user's password. Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.


/api/v1/auth/password/reset/confirm/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/auth/password/reset/confirm/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        PasswordResetConfirm body = ; // PasswordResetConfirm | 
        try {
            PasswordResetConfirm result = apiInstance.createPasswordResetConfirm(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createPasswordResetConfirm");
            e.printStackTrace();
        }
    }
}
PasswordResetConfirm *body = ; //  (optional)

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

[apiInstance createPasswordResetConfirmWith:body
              completionHandler: ^(PasswordResetConfirm output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{PasswordResetConfirm}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPasswordResetConfirm(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new PasswordResetConfirm(); // PasswordResetConfirm |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // PasswordResetConfirm | 

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

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

eval { 
    my $result = $api_instance->createPasswordResetConfirm(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createPasswordResetConfirm: [email protected]\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.ApiApi()
body =  # PasswordResetConfirm |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
new_password1
String
new_password2
String
uid
String
token
String
new_password1
String
new_password2
String
uid
String
token
String

Responses

Status: 201 -


createPeople


/api/v1/people/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/people/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        People body = ; // People | 
        try {
            People result = apiInstance.createPeople(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createPeople");
            e.printStackTrace();
        }
    }
}
People *body = ; //  (optional)

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

[apiInstance createPeopleWith:body
              completionHandler: ^(People output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{People}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPeople(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new People(); // People |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // People | 

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

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

eval { 
    my $result = $api_instance->createPeople(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createPeople: [email protected]\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.ApiApi()
body =  # People |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
created_date
Date (date-time)
state_file_id
String
county_file_id
String
action_network_id
String
of_voter_file_id
String
other_voter_file_id
String
alloy_uuid
String
vr_status
String
Enum: OF Form Submitted, OF Form Mailed, OF Form Arrived, OF Return Mailed, Active, Challenged, Not Eligible, Denied, Inactive, Pending, Confirmation, Removed, Preregistered, Rejected, Unregistered, Verify, Cancelled, Incomplete, Purged
full_name
String
honorarium
String
first_name
String
middle_name
String
last_name
String
suffix
String
preferred_name
String
sex
String
age
Integer
dob
date (date)
gender_identity
String
pronouns
array[Integer]
languages_spoken
array[Integer]
phone1
String
phone_opt_in1
Boolean
phone2
String
phone_opt_in2
Boolean
email1
String (email)
email_opt_in1
Boolean
email2
String (email)
email_opt_in2
Boolean
provided_national_address_id
Integer
prov_full_address
String
prov_address1
String
prov_address2
String
prov_city
String
prov_state
String
prov_zip_5
String
p_raw_lat_long
String
p_raw_lat
BigDecimal
p_raw_long
BigDecimal
p_geom
String
contacted_national_address_id
Integer
contacted_full_address
String
lives_at_contacted
Boolean
registered_national_address_id
Integer
reg_full_address
String
reg_address1
String
reg_address2
String
reg_city
String
reg_county
String
reg_state
String
reg_zip_5
String
r_raw_lat_long
String
r_raw_lat
BigDecimal
r_raw_long
BigDecimal
r_geom
String
mailing_national_address_id
Integer
mail_full_address
String
mail_address1
String
mail_address2
String
mail_city
String
mail_state
String
mail_zip_5
String
m_raw_lat_long
String
m_raw_lat
BigDecimal
m_raw_long
BigDecimal
m_geom
String
early_voted
Boolean
labels
array[Integer]
id
Integer
created_date
Date (date-time)
state_file_id
String
county_file_id
String
action_network_id
String
of_voter_file_id
String
other_voter_file_id
String
alloy_uuid
String
vr_status
String
Enum: OF Form Submitted, OF Form Mailed, OF Form Arrived, OF Return Mailed, Active, Challenged, Not Eligible, Denied, Inactive, Pending, Confirmation, Removed, Preregistered, Rejected, Unregistered, Verify, Cancelled, Incomplete, Purged OF Form Submitted, OF Form Mailed, OF Form Arrived, OF Return Mailed, Active, Challenged, Not Eligible, Denied, Inactive, Pending, Confirmation, Removed, Preregistered, Rejected, Unregistered, Verify, Cancelled, Incomplete, Purged
full_name
String
honorarium
String
first_name
String
middle_name
String
last_name
String
suffix
String
preferred_name
String
sex
String
age
Integer
dob
date (date)
gender_identity
String
pronouns
array[Integer]
languages_spoken
array[Integer]
phone1
String
phone_opt_in1
Boolean
phone2
String
phone_opt_in2
Boolean
email1
String (email)
email_opt_in1
Boolean
email2
String (email)
email_opt_in2
Boolean
provided_national_address_id
Integer
prov_full_address
String
prov_address1
String
prov_address2
String
prov_city
String
prov_state
String
prov_zip_5
String
p_raw_lat_long
String
p_raw_lat
BigDecimal
p_raw_long
BigDecimal
p_geom
String
contacted_national_address_id
Integer
contacted_full_address
String
lives_at_contacted
Boolean
registered_national_address_id
Integer
reg_full_address
String
reg_address1
String
reg_address2
String
reg_city
String
reg_county
String
reg_state
String
reg_zip_5
String
r_raw_lat_long
String
r_raw_lat
BigDecimal
r_raw_long
BigDecimal
r_geom
String
mailing_national_address_id
Integer
mail_full_address
String
mail_address1
String
mail_address2
String
mail_city
String
mail_state
String
mail_zip_5
String
m_raw_lat_long
String
m_raw_lat
BigDecimal
m_raw_long
BigDecimal
m_geom
String
early_voted
Boolean
labels
array[Integer]

Responses

Status: 201 -


createPronoun


/api/v1/pronouns/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/pronouns/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Pronoun body = ; // Pronoun | 
        try {
            Pronoun result = apiInstance.createPronoun(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createPronoun");
            e.printStackTrace();
        }
    }
}
Pronoun *body = ; //  (optional)

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

[apiInstance createPronounWith:body
              completionHandler: ^(Pronoun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{Pronoun}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPronoun(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new Pronoun(); // Pronoun |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // Pronoun | 

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

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

eval { 
    my $result = $api_instance->createPronoun(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createPronoun: [email protected]\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.ApiApi()
body =  # Pronoun |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
subj_pronoun
String
obj_pronoun
String
poss_pronoun
String
id
Integer
subj_pronoun
String
obj_pronoun
String
poss_pronoun
String

Responses

Status: 201 -


createQuestionsPolymorphic


/api/v1/questions/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/questions/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        QuestionsPolymorphic body = ; // QuestionsPolymorphic | 
        try {
            QuestionsPolymorphic result = apiInstance.createQuestionsPolymorphic(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createQuestionsPolymorphic");
            e.printStackTrace();
        }
    }
}
QuestionsPolymorphic *body = ; //  (optional)

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

[apiInstance createQuestionsPolymorphicWith:body
              completionHandler: ^(QuestionsPolymorphic output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{QuestionsPolymorphic}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createQuestionsPolymorphic(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new QuestionsPolymorphic(); // QuestionsPolymorphic |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // QuestionsPolymorphic | 

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

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

eval { 
    my $result = $api_instance->createQuestionsPolymorphic(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createQuestionsPolymorphic: [email protected]\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.ApiApi()
body =  # QuestionsPolymorphic |  (optional)

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

Parameters

Body parameters
Name Description
body

Responses

Status: 201 -


createRegister


/api/v1/registration/registration/register/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/registration/registration/register/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Register body = ; // Register | 
        try {
            Register result = apiInstance.createRegister(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createRegister");
            e.printStackTrace();
        }
    }
}
Register *body = ; //  (optional)

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

[apiInstance createRegisterWith:body
              completionHandler: ^(Register output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{Register}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRegister(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new Register(); // Register |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // Register | 

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

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

eval { 
    my $result = $api_instance->createRegister(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createRegister: [email protected]\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.ApiApi()
body =  # Register |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
email
String (email)
password1
String
password2
String
email
String (email)
password1
String
password2
String

Responses

Status: 201 -


createScript


/api/v1/scripts/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/scripts/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Script body = ; // Script | 
        try {
            Script result = apiInstance.createScript(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createScript");
            e.printStackTrace();
        }
    }
}
Script *body = ; //  (optional)

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

[apiInstance createScriptWith:body
              completionHandler: ^(Script output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{Script}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createScript(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new Script(); // Script |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // Script | 

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

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

eval { 
    my $result = $api_instance->createScript(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createScript: [email protected]\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.ApiApi()
body =  # Script |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
created_at
Date (date-time)
name
String
description
String
s_questions
array[String]
id
Integer
created_at
Date (date-time)
name
String
description
String
s_questions
array[String]

Responses

Status: 201 -


createScriptQuestion


/api/v1/script-questions/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/script-questions/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        ScriptQuestion body = ; // ScriptQuestion | 
        try {
            ScriptQuestion result = apiInstance.createScriptQuestion(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createScriptQuestion");
            e.printStackTrace();
        }
    }
}
ScriptQuestion *body = ; //  (optional)

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

[apiInstance createScriptQuestionWith:body
              completionHandler: ^(ScriptQuestion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{ScriptQuestion}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createScriptQuestion(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new ScriptQuestion(); // ScriptQuestion |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // ScriptQuestion | 

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

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

eval { 
    my $result = $api_instance->createScriptQuestion(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createScriptQuestion: [email protected]\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.ApiApi()
body =  # ScriptQuestion |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
script
Integer
question
Integer
q_order
Integer
id
Integer
script
Integer
question
Integer
q_order
Integer

Responses

Status: 201 -


createVerifyEmail


/api/v1/registration/verify-email/

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/registration/verify-email/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        VerifyEmail body = ; // VerifyEmail | 
        try {
            VerifyEmail result = apiInstance.createVerifyEmail(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#createVerifyEmail");
            e.printStackTrace();
        }
    }
}
VerifyEmail *body = ; //  (optional)

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

[apiInstance createVerifyEmailWith:body
              completionHandler: ^(VerifyEmail output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{VerifyEmail}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createVerifyEmail(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new VerifyEmail(); // VerifyEmail |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // VerifyEmail | 

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

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

eval { 
    my $result = $api_instance->createVerifyEmail(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->createVerifyEmail: [email protected]\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.ApiApi()
body =  # VerifyEmail |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
key
String
key
String

Responses

Status: 201 -


destroyConversationCode


/api/v1/conversation-codes/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/conversation-codes/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyConversationCodeWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyConversationCode(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyConversationCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyConversationCode(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyConversationCode: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_conversation_code(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyConversationCode: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


destroyConversations


/api/v1/conversations/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/conversations/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyConversationsWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyConversations(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyConversations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyConversations(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyConversations: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_conversations(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyConversations: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


destroyLabel


/api/v1/labels/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/labels/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyLabelWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyLabel(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyLabel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyLabel(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyLabel: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_label(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyLabel: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


destroyLanguage


/api/v1/languages/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/languages/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyLanguageWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyLanguage(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyLanguage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyLanguage(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyLanguage: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_language(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyLanguage: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


destroyNationalAddress


/api/v1/national-addresses/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/national-addresses/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyNationalAddressWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyNationalAddress(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyNationalAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyNationalAddress(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyNationalAddress: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_national_address(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyNationalAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


destroyPeople


/api/v1/people/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/people/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyPeopleWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyPeople(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyPeople: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyPeople(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyPeople: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_people(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyPeople: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


destroyPronoun


/api/v1/pronouns/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/pronouns/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyPronounWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyPronoun(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyPronoun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyPronoun(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyPronoun: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_pronoun(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyPronoun: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


destroyQuestionsPolymorphic


/api/v1/questions/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/questions/{id}/?polymorphic_ctype="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        String polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype
        try {
            apiInstance.destroyQuestionsPolymorphic(id, polymorphicCtype);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#destroyQuestionsPolymorphic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        String polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype
        try {
            apiInstance.destroyQuestionsPolymorphic(id, polymorphicCtype);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#destroyQuestionsPolymorphic");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
String *polymorphicCtype = polymorphicCtype_example; // polymorphic_ctype (optional)

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

[apiInstance destroyQuestionsPolymorphicWith:id
    polymorphicCtype:polymorphicCtype
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'polymorphicCtype': polymorphicCtype_example // {{String}} polymorphic_ctype
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.destroyQuestionsPolymorphic(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var polymorphicCtype = polymorphicCtype_example;  // String | polymorphic_ctype (optional) 

            try
            {
                apiInstance.destroyQuestionsPolymorphic(id, polymorphicCtype);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyQuestionsPolymorphic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $polymorphicCtype = polymorphicCtype_example; # String | polymorphic_ctype

eval { 
    $api_instance->destroyQuestionsPolymorphic(id => $id, polymorphicCtype => $polymorphicCtype);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyQuestionsPolymorphic: [email protected]\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.ApiApi()
id = id_example # String | 
polymorphicCtype = polymorphicCtype_example # String | polymorphic_ctype (optional)

try: 
    api_instance.destroy_questions_polymorphic(id, polymorphicCtype=polymorphicCtype)
except ApiException as e:
    print("Exception when calling ApiApi->destroyQuestionsPolymorphic: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Query parameters
Name Description
polymorphic_ctype
String
polymorphic_ctype

Responses

Status: 204 -


destroyScript


/api/v1/scripts/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/scripts/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyScriptWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyScript(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyScript: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyScript(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyScript: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_script(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyScript: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


destroyScriptQuestion


/api/v1/script-questions/{id}/

Usage and SDK Samples

curl -X DELETE\
"//api/v1/script-questions/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance destroyScriptQuestionWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

            try
            {
                apiInstance.destroyScriptQuestion(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.destroyScriptQuestion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    $api_instance->destroyScriptQuestion(id => $id);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->destroyScriptQuestion: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_instance.destroy_script_question(id)
except ApiException as e:
    print("Exception when calling ApiApi->destroyScriptQuestion: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 204 -


listConversationCodes


/api/v1/conversation-codes/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/conversation-codes/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200 result = apiInstance.listConversationCodes(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listConversationCodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200 result = apiInstance.listConversationCodes(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listConversationCodes");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listConversationCodesWith:page
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listConversationCodes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listConversationCodes(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listConversationCodes: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_conversation_codes(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listConversationCodes: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listConversations


/api/v1/conversations/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/conversations/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_1 result = apiInstance.listConversations(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listConversations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_1 result = apiInstance.listConversations(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listConversations");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listConversationsWith:page
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listConversations(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listConversations(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listConversations: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_conversations(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listConversations: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listLabels


/api/v1/labels/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/labels/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_2 result = apiInstance.listLabels(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listLabels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_2 result = apiInstance.listLabels(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listLabels");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listLabelsWith:page
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listLabels(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listLabels(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listLabels: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_labels(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listLabels: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listLanguages


/api/v1/languages/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/languages/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_3 result = apiInstance.listLanguages(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listLanguages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_3 result = apiInstance.listLanguages(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listLanguages");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listLanguagesWith:page
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listLanguages(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listLanguages(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listLanguages: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_languages(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listLanguages: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listLogouts

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.


/api/v1/auth/logout/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/auth/logout/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

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

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

[apiInstance listLogoutsWithCompletionHandler: 
              ^(NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

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

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

            var apiInstance = new ApiApi();

            try
            {
                array[null] result = apiInstance.listLogouts();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.listLogouts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    my $result = $api_instance->listLogouts();
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listLogouts: [email protected]\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.ApiApi()

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

Parameters

Responses

Status: 200 -


listNationalAddress


/api/v1/national-addresses/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/national-addresses/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_4 result = apiInstance.listNationalAddress(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listNationalAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_4 result = apiInstance.listNationalAddress(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listNationalAddress");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listNationalAddressWith:page
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listNationalAddress(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listNationalAddress(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listNationalAddress: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_national_address(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listNationalAddress: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listPeoples


/api/v1/people/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/people/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_5 result = apiInstance.listPeoples(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listPeoples");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_5 result = apiInstance.listPeoples(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listPeoples");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listPeoplesWith:page
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPeoples(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listPeoples(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listPeoples: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_peoples(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listPeoples: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listPronouns


/api/v1/pronouns/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/pronouns/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_6 result = apiInstance.listPronouns(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listPronouns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_6 result = apiInstance.listPronouns(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listPronouns");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listPronounsWith:page
              completionHandler: ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPronouns(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listPronouns(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listPronouns: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_pronouns(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listPronouns: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listQuestionsPolymorphics


/api/v1/questions/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/questions/?page=&polymorphic_ctype="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        String polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype
        try {
            inline_response_200_7 result = apiInstance.listQuestionsPolymorphics(page, polymorphicCtype);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listQuestionsPolymorphics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        String polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype
        try {
            inline_response_200_7 result = apiInstance.listQuestionsPolymorphics(page, polymorphicCtype);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listQuestionsPolymorphics");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)
String *polymorphicCtype = polymorphicCtype_example; // polymorphic_ctype (optional)

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

[apiInstance listQuestionsPolymorphicsWith:page
    polymorphicCtype:polymorphicCtype
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56, // {{Integer}} A page number within the paginated result set.
  'polymorphicCtype': polymorphicCtype_example // {{String}} polymorphic_ctype
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listQuestionsPolymorphics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 
            var polymorphicCtype = polymorphicCtype_example;  // String | polymorphic_ctype (optional) 

            try
            {
                inline_response_200_7 result = apiInstance.listQuestionsPolymorphics(page, polymorphicCtype);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.listQuestionsPolymorphics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.
$polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.
my $polymorphicCtype = polymorphicCtype_example; # String | polymorphic_ctype

eval { 
    my $result = $api_instance->listQuestionsPolymorphics(page => $page, polymorphicCtype => $polymorphicCtype);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listQuestionsPolymorphics: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)
polymorphicCtype = polymorphicCtype_example # String | polymorphic_ctype (optional)

try: 
    api_response = api_instance.list_questions_polymorphics(page=page, polymorphicCtype=polymorphicCtype)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listQuestionsPolymorphics: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.
polymorphic_ctype
String
polymorphic_ctype

Responses

Status: 200 -


listScriptQuestions


/api/v1/script-questions/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/script-questions/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_8 result = apiInstance.listScriptQuestions(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listScriptQuestions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_8 result = apiInstance.listScriptQuestions(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listScriptQuestions");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listScriptQuestionsWith:page
              completionHandler: ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listScriptQuestions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listScriptQuestions(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listScriptQuestions: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_script_questions(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listScriptQuestions: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listScripts


/api/v1/scripts/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/scripts/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_9 result = apiInstance.listScripts(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listScripts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_9 result = apiInstance.listScripts(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listScripts");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listScriptsWith:page
              completionHandler: ^(inline_response_200_9 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listScripts(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listScripts(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listScripts: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_scripts(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listScripts: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


listUsers


/api/v1/users/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/users/?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_10 result = apiInstance.listUsers(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        Integer page = 56; // Integer | A page number within the paginated result set.
        try {
            inline_response_200_10 result = apiInstance.listUsers(page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#listUsers");
            e.printStackTrace();
        }
    }
}
Integer *page = 56; // A page number within the paginated result set. (optional)

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

[apiInstance listUsersWith:page
              completionHandler: ^(inline_response_200_10 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'page': 56 // {{Integer}} A page number within the paginated result set.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUsers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var page = 56;  // Integer | A page number within the paginated result set. (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$page = 56; // Integer | A page number within the paginated result set.

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $page = 56; # Integer | A page number within the paginated result set.

eval { 
    my $result = $api_instance->listUsers(page => $page);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->listUsers: [email protected]\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.ApiApi()
page = 56 # Integer | A page number within the paginated result set. (optional)

try: 
    api_response = api_instance.list_users(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->listUsers: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer
A page number within the paginated result set.

Responses

Status: 200 -


partialUpdateConversationCode


/api/v1/conversation-codes/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/conversation-codes/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        ConversationCode body = ; // ConversationCode | 
        try {
            ConversationCode result = apiInstance.partialUpdateConversationCode(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateConversationCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        ConversationCode body = ; // ConversationCode | 
        try {
            ConversationCode result = apiInstance.partialUpdateConversationCode(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateConversationCode");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
ConversationCode *body = ; //  (optional)

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

[apiInstance partialUpdateConversationCodeWith:id
    body:body
              completionHandler: ^(ConversationCode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{ConversationCode}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateConversationCode(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new ConversationCode(); // ConversationCode |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // ConversationCode | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::ConversationCode->new(); # ConversationCode | 

eval { 
    my $result = $api_instance->partialUpdateConversationCode(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateConversationCode: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # ConversationCode |  (optional)

try: 
    api_response = api_instance.partial_update_conversation_code(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdateConversationCode: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
code
String
created_at
Date (date-time)
created_by
String
description
String
org
String
script
Integer
targets
Integer
expires
Date (date-time)
conversation_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST
start_time
String
end_time
String
status
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST Processing, Active, After Hours, Expired, Deactivated
attempt_goal
Integer
reg_goal
Integer
vbm_goal
Integer
id
Integer
code
String
created_at
Date (date-time)
created_by
String
description
String
org
String
script
Integer
targets
Integer
expires
Date (date-time)
conversation_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST Processing, Active, After Hours, Expired, Deactivated VK, PK, VR, PR, VC, PC, VD, PD, ST
start_time
String
end_time
String
status
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST Processing, Active, After Hours, Expired, Deactivated VK, PK, VR, PR, VC, PC, VD, PD, ST Processing, Active, After Hours, Expired, Deactivated
attempt_goal
Integer
reg_goal
Integer
vbm_goal
Integer

Responses

Status: 200 -


partialUpdateConversations


/api/v1/conversations/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/conversations/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Conversations body = ; // Conversations | 
        try {
            Conversations result = apiInstance.partialUpdateConversations(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateConversations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Conversations body = ; // Conversations | 
        try {
            Conversations result = apiInstance.partialUpdateConversations(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateConversations");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
Conversations *body = ; //  (optional)

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

[apiInstance partialUpdateConversationsWith:id
    body:body
              completionHandler: ^(Conversations output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{Conversations}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateConversations(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new Conversations(); // Conversations |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // Conversations | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::Conversations->new(); # Conversations | 

eval { 
    my $result = $api_instance->partialUpdateConversations(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateConversations: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # Conversations |  (optional)

try: 
    api_response = api_instance.partial_update_conversations(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdateConversations: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
canvasser
Integer
contacted_id
Integer
conversation_time
Date (date-time)
conversation_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST
contact_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL
contact
Boolean
conversation_code
Integer
contact_script
Integer
contacted_national_address_id
Integer
contacted_phone
String
relationship_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R
languages_of_conversation
Integer
id
Integer
canvasser
Integer
contacted_id
Integer
conversation_time
Date (date-time)
conversation_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R VK, PK, VR, PR, VC, PC, VD, PD, ST
contact_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL
contact
Boolean
conversation_code
Integer
contact_script
Integer
contacted_national_address_id
Integer
contacted_phone
String
relationship_type
String
Enum: VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R VK, PK, VR, PR, VC, PC, VD, PD, ST NH, WN, LM, RF, HS, DC, MV, IA, OL 0R, 1R, 2R, 3R
languages_of_conversation
Integer

Responses

Status: 200 -


partialUpdateLabel


/api/v1/labels/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/labels/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Label body = ; // Label | 
        try {
            Label result = apiInstance.partialUpdateLabel(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateLabel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Label body = ; // Label | 
        try {
            Label result = apiInstance.partialUpdateLabel(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateLabel");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
Label *body = ; //  (optional)

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

[apiInstance partialUpdateLabelWith:id
    body:body
              completionHandler: ^(Label output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{Label}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateLabel(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new Label(); // Label |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // Label | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::Label->new(); # Label | 

eval { 
    my $result = $api_instance->partialUpdateLabel(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateLabel: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # Label |  (optional)

try: 
    api_response = api_instance.partial_update_label(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdateLabel: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
name
String
description
String
id
Integer
name
String
description
String

Responses

Status: 200 -


partialUpdateLanguage


/api/v1/languages/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/languages/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Language body = ; // Language | 
        try {
            Language result = apiInstance.partialUpdateLanguage(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateLanguage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Language body = ; // Language | 
        try {
            Language result = apiInstance.partialUpdateLanguage(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateLanguage");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
Language *body = ; //  (optional)

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

[apiInstance partialUpdateLanguageWith:id
    body:body
              completionHandler: ^(Language output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{Language}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateLanguage(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new Language(); // Language |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // Language | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::Language->new(); # Language | 

eval { 
    my $result = $api_instance->partialUpdateLanguage(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateLanguage: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # Language |  (optional)

try: 
    api_response = api_instance.partial_update_language(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdateLanguage: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
isocode
String
name
String
sorting
Integer
id
Integer
isocode
String
name
String
sorting
Integer

Responses

Status: 200 -


partialUpdateNationalAddress


/api/v1/national-addresses/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/national-addresses/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        NationalAddress body = ; // NationalAddress | 
        try {
            NationalAddress result = apiInstance.partialUpdateNationalAddress(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateNationalAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        NationalAddress body = ; // NationalAddress | 
        try {
            NationalAddress result = apiInstance.partialUpdateNationalAddress(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateNationalAddress");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
NationalAddress *body = ; //  (optional)

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

[apiInstance partialUpdateNationalAddressWith:id
    body:body
              completionHandler: ^(NationalAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{NationalAddress}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateNationalAddress(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new NationalAddress(); // NationalAddress |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // NationalAddress | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::NationalAddress->new(); # NationalAddress | 

eval { 
    my $result = $api_instance->partialUpdateNationalAddress(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateNationalAddress: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # NationalAddress |  (optional)

try: 
    api_response = api_instance.partial_update_national_address(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdateNationalAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
national_address_id
Integer
os_naid_hash
String
dot_guid
String
full_address
String
has_units
Boolean
building_id
String
address12
String
address1
String
address2
String
street_number
String
street_name
String
building
String
unit
String
p_city
String
p_state
String
p_county
String
p_zip_5
String
p_zip_4
String
country
String
even_or_odd
String
Enum: E, O, S
precinct_name
String
precinct_number
String
polling_location
String
polling_location_address
String
municipality
String
ward
String
citydistrict
String
lower_state_leg
String
upper_state_leg
String
congressional
String
raw_lat_long
String
raw_lat
BigDecimal
raw_long
BigDecimal
geom
String
labels
array[Integer]
local_door_notes
String
census_block
Integer
national_address_id
Integer
os_naid_hash
String
dot_guid
String
full_address
String
has_units
Boolean
building_id
String
address12
String
address1
String
address2
String
street_number
String
street_name
String
building
String
unit
String
p_city
String
p_state
String
p_county
String
p_zip_5
String
p_zip_4
String
country
String
even_or_odd
String
Enum: E, O, S E, O, S
precinct_name
String
precinct_number
String
polling_location
String
polling_location_address
String
municipality
String
ward
String
citydistrict
String
lower_state_leg
String
upper_state_leg
String
congressional
String
raw_lat_long
String
raw_lat
BigDecimal
raw_long
BigDecimal
geom
String
labels
array[Integer]
local_door_notes
String
census_block
Integer

Responses

Status: 200 -


partialUpdatePeople


/api/v1/people/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/people/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        People body = ; // People | 
        try {
            People result = apiInstance.partialUpdatePeople(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdatePeople");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        People body = ; // People | 
        try {
            People result = apiInstance.partialUpdatePeople(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdatePeople");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
People *body = ; //  (optional)

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

[apiInstance partialUpdatePeopleWith:id
    body:body
              completionHandler: ^(People output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{People}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdatePeople(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new People(); // People |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // People | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::People->new(); # People | 

eval { 
    my $result = $api_instance->partialUpdatePeople(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdatePeople: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # People |  (optional)

try: 
    api_response = api_instance.partial_update_people(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdatePeople: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
created_date
Date (date-time)
state_file_id
String
county_file_id
String
action_network_id
String
of_voter_file_id
String
other_voter_file_id
String
alloy_uuid
String
vr_status
String
Enum: OF Form Submitted, OF Form Mailed, OF Form Arrived, OF Return Mailed, Active, Challenged, Not Eligible, Denied, Inactive, Pending, Confirmation, Removed, Preregistered, Rejected, Unregistered, Verify, Cancelled, Incomplete, Purged
full_name
String
honorarium
String
first_name
String
middle_name
String
last_name
String
suffix
String
preferred_name
String
sex
String
age
Integer
dob
date (date)
gender_identity
String
pronouns
array[Integer]
languages_spoken
array[Integer]
phone1
String
phone_opt_in1
Boolean
phone2
String
phone_opt_in2
Boolean
email1
String (email)
email_opt_in1
Boolean
email2
String (email)
email_opt_in2
Boolean
provided_national_address_id
Integer
prov_full_address
String
prov_address1
String
prov_address2
String
prov_city
String
prov_state
String
prov_zip_5
String
p_raw_lat_long
String
p_raw_lat
BigDecimal
p_raw_long
BigDecimal
p_geom
String
contacted_national_address_id
Integer
contacted_full_address
String
lives_at_contacted
Boolean
registered_national_address_id
Integer
reg_full_address
String
reg_address1
String
reg_address2
String
reg_city
String
reg_county
String
reg_state
String
reg_zip_5
String
r_raw_lat_long
String
r_raw_lat
BigDecimal
r_raw_long
BigDecimal
r_geom
String
mailing_national_address_id
Integer
mail_full_address
String
mail_address1
String
mail_address2
String
mail_city
String
mail_state
String
mail_zip_5
String
m_raw_lat_long
String
m_raw_lat
BigDecimal
m_raw_long
BigDecimal
m_geom
String
early_voted
Boolean
labels
array[Integer]
id
Integer
created_date
Date (date-time)
state_file_id
String
county_file_id
String
action_network_id
String
of_voter_file_id
String
other_voter_file_id
String
alloy_uuid
String
vr_status
String
Enum: OF Form Submitted, OF Form Mailed, OF Form Arrived, OF Return Mailed, Active, Challenged, Not Eligible, Denied, Inactive, Pending, Confirmation, Removed, Preregistered, Rejected, Unregistered, Verify, Cancelled, Incomplete, Purged OF Form Submitted, OF Form Mailed, OF Form Arrived, OF Return Mailed, Active, Challenged, Not Eligible, Denied, Inactive, Pending, Confirmation, Removed, Preregistered, Rejected, Unregistered, Verify, Cancelled, Incomplete, Purged
full_name
String
honorarium
String
first_name
String
middle_name
String
last_name
String
suffix
String
preferred_name
String
sex
String
age
Integer
dob
date (date)
gender_identity
String
pronouns
array[Integer]
languages_spoken
array[Integer]
phone1
String
phone_opt_in1
Boolean
phone2
String
phone_opt_in2
Boolean
email1
String (email)
email_opt_in1
Boolean
email2
String (email)
email_opt_in2
Boolean
provided_national_address_id
Integer
prov_full_address
String
prov_address1
String
prov_address2
String
prov_city
String
prov_state
String
prov_zip_5
String
p_raw_lat_long
String
p_raw_lat
BigDecimal
p_raw_long
BigDecimal
p_geom
String
contacted_national_address_id
Integer
contacted_full_address
String
lives_at_contacted
Boolean
registered_national_address_id
Integer
reg_full_address
String
reg_address1
String
reg_address2
String
reg_city
String
reg_county
String
reg_state
String
reg_zip_5
String
r_raw_lat_long
String
r_raw_lat
BigDecimal
r_raw_long
BigDecimal
r_geom
String
mailing_national_address_id
Integer
mail_full_address
String
mail_address1
String
mail_address2
String
mail_city
String
mail_state
String
mail_zip_5
String
m_raw_lat_long
String
m_raw_lat
BigDecimal
m_raw_long
BigDecimal
m_geom
String
early_voted
Boolean
labels
array[Integer]

Responses

Status: 200 -


partialUpdatePronoun


/api/v1/pronouns/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/pronouns/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Pronoun body = ; // Pronoun | 
        try {
            Pronoun result = apiInstance.partialUpdatePronoun(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdatePronoun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Pronoun body = ; // Pronoun | 
        try {
            Pronoun result = apiInstance.partialUpdatePronoun(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdatePronoun");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
Pronoun *body = ; //  (optional)

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

[apiInstance partialUpdatePronounWith:id
    body:body
              completionHandler: ^(Pronoun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{Pronoun}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdatePronoun(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new Pronoun(); // Pronoun |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // Pronoun | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::Pronoun->new(); # Pronoun | 

eval { 
    my $result = $api_instance->partialUpdatePronoun(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdatePronoun: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # Pronoun |  (optional)

try: 
    api_response = api_instance.partial_update_pronoun(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdatePronoun: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
subj_pronoun
String
obj_pronoun
String
poss_pronoun
String
id
Integer
subj_pronoun
String
obj_pronoun
String
poss_pronoun
String

Responses

Status: 200 -


partialUpdateQuestionsPolymorphic


/api/v1/questions/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/questions/{id}/?polymorphic_ctype="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        QuestionsPolymorphic body = ; // QuestionsPolymorphic | 
        String polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype
        try {
            QuestionsPolymorphic result = apiInstance.partialUpdateQuestionsPolymorphic(id, body, polymorphicCtype);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateQuestionsPolymorphic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        QuestionsPolymorphic body = ; // QuestionsPolymorphic | 
        String polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype
        try {
            QuestionsPolymorphic result = apiInstance.partialUpdateQuestionsPolymorphic(id, body, polymorphicCtype);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateQuestionsPolymorphic");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
QuestionsPolymorphic *body = ; //  (optional)
String *polymorphicCtype = polymorphicCtype_example; // polymorphic_ctype (optional)

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

[apiInstance partialUpdateQuestionsPolymorphicWith:id
    body:body
    polymorphicCtype:polymorphicCtype
              completionHandler: ^(QuestionsPolymorphic output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{QuestionsPolymorphic}} 
  'polymorphicCtype': polymorphicCtype_example // {{String}} polymorphic_ctype
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateQuestionsPolymorphic(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new QuestionsPolymorphic(); // QuestionsPolymorphic |  (optional) 
            var polymorphicCtype = polymorphicCtype_example;  // String | polymorphic_ctype (optional) 

            try
            {
                QuestionsPolymorphic result = apiInstance.partialUpdateQuestionsPolymorphic(id, body, polymorphicCtype);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiApi.partialUpdateQuestionsPolymorphic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // QuestionsPolymorphic | 
$polymorphicCtype = polymorphicCtype_example; // String | polymorphic_ctype

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::QuestionsPolymorphic->new(); # QuestionsPolymorphic | 
my $polymorphicCtype = polymorphicCtype_example; # String | polymorphic_ctype

eval { 
    my $result = $api_instance->partialUpdateQuestionsPolymorphic(id => $id, body => $body, polymorphicCtype => $polymorphicCtype);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateQuestionsPolymorphic: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # QuestionsPolymorphic |  (optional)
polymorphicCtype = polymorphicCtype_example # String | polymorphic_ctype (optional)

try: 
    api_response = api_instance.partial_update_questions_polymorphic(id, body=body, polymorphicCtype=polymorphicCtype)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdateQuestionsPolymorphic: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Query parameters
Name Description
polymorphic_ctype
String
polymorphic_ctype

Responses

Status: 200 -


partialUpdateScript


/api/v1/scripts/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/scripts/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Script body = ; // Script | 
        try {
            Script result = apiInstance.partialUpdateScript(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateScript");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        Script body = ; // Script | 
        try {
            Script result = apiInstance.partialUpdateScript(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateScript");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
Script *body = ; //  (optional)

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

[apiInstance partialUpdateScriptWith:id
    body:body
              completionHandler: ^(Script output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{Script}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateScript(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new Script(); // Script |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // Script | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::Script->new(); # Script | 

eval { 
    my $result = $api_instance->partialUpdateScript(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateScript: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # Script |  (optional)

try: 
    api_response = api_instance.partial_update_script(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdateScript: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
created_at
Date (date-time)
name
String
description
String
s_questions
array[String]
id
Integer
created_at
Date (date-time)
name
String
description
String
s_questions
array[String]

Responses

Status: 200 -


partialUpdateScriptQuestion


/api/v1/script-questions/{id}/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/script-questions/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        ScriptQuestion body = ; // ScriptQuestion | 
        try {
            ScriptQuestion result = apiInstance.partialUpdateScriptQuestion(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateScriptQuestion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        ScriptQuestion body = ; // ScriptQuestion | 
        try {
            ScriptQuestion result = apiInstance.partialUpdateScriptQuestion(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateScriptQuestion");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
ScriptQuestion *body = ; //  (optional)

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

[apiInstance partialUpdateScriptQuestionWith:id
    body:body
              completionHandler: ^(ScriptQuestion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{ScriptQuestion}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateScriptQuestion(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 
            var body = new ScriptQuestion(); // ScriptQuestion |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 
$body = ; // ScriptQuestion | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::ScriptQuestion->new(); # ScriptQuestion | 

eval { 
    my $result = $api_instance->partialUpdateScriptQuestion(id => $id, body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateScriptQuestion: [email protected]\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.ApiApi()
id = id_example # String | 
body =  # ScriptQuestion |  (optional)

try: 
    api_response = api_instance.partial_update_script_question(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->partialUpdateScriptQuestion: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body
Form parameters
Name Description
id
Integer
script
Integer
question
Integer
q_order
Integer
id
Integer
script
Integer
question
Integer
q_order
Integer

Responses

Status: 200 -


partialUpdateUserDetails

Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields.


/api/v1/auth/user/

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json,application/x-www-form-urlencoded,multipart/form-data"\
"//api/v1/auth/user/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

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

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        UserDetails body = ; // UserDetails | 
        try {
            UserDetails result = apiInstance.partialUpdateUserDetails(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#partialUpdateUserDetails");
            e.printStackTrace();
        }
    }
}
UserDetails *body = ; //  (optional)

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

[apiInstance partialUpdateUserDetailsWith:body
              completionHandler: ^(UserDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var opts = { 
  'body':  // {{UserDetails}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.partialUpdateUserDetails(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApiApi();
            var body = new UserDetails(); // UserDetails |  (optional) 

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

$api_instance = new Swagger\Client\ApiApiApi();
$body = ; // UserDetails | 

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

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

eval { 
    my $result = $api_instance->partialUpdateUserDetails(body => $body);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->partialUpdateUserDetails: [email protected]\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.ApiApi()
body =  # UserDetails |  (optional)

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

Parameters

Body parameters
Name Description
body
Form parameters
Name Description
pk
Integer
email
String (email)
first_name
String
last_name
String
pk
Integer
email
String (email)
first_name
String
last_name
String

Responses

Status: 200 -


retrieveConversationCode


/api/v1/conversation-codes/{id}/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/conversation-codes/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            ConversationCode result = apiInstance.retrieveConversationCode(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveConversationCode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            ConversationCode result = apiInstance.retrieveConversationCode(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveConversationCode");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 

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

[apiInstance retrieveConversationCodeWith:id
              completionHandler: ^(ConversationCode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->retrieveConversationCode(id => $id);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->retrieveConversationCode: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_response = api_instance.retrieve_conversation_code(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieveConversationCode: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 -


retrieveConversations


/api/v1/conversations/{id}/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/conversations/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            Conversations result = apiInstance.retrieveConversations(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveConversations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            Conversations result = apiInstance.retrieveConversations(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveConversations");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 

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

[apiInstance retrieveConversationsWith:id
              completionHandler: ^(Conversations output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->retrieveConversations(id => $id);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->retrieveConversations: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_response = api_instance.retrieve_conversations(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieveConversations: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 -


retrieveLabel


/api/v1/labels/{id}/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/labels/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            Label result = apiInstance.retrieveLabel(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveLabel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            Label result = apiInstance.retrieveLabel(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveLabel");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 

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

[apiInstance retrieveLabelWith:id
              completionHandler: ^(Label output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->retrieveLabel(id => $id);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->retrieveLabel: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_response = api_instance.retrieve_label(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieveLabel: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 -


retrieveLanguage


/api/v1/languages/{id}/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/languages/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            Language result = apiInstance.retrieveLanguage(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveLanguage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            Language result = apiInstance.retrieveLanguage(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveLanguage");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 

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

[apiInstance retrieveLanguageWith:id
              completionHandler: ^(Language output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->retrieveLanguage(id => $id);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->retrieveLanguage: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_response = api_instance.retrieve_language(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieveLanguage: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 -


retrieveNationalAddress


/api/v1/national-addresses/{id}/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/national-addresses/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            NationalAddress result = apiInstance.retrieveNationalAddress(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveNationalAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            NationalAddress result = apiInstance.retrieveNationalAddress(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrieveNationalAddress");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 

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

[apiInstance retrieveNationalAddressWith:id
              completionHandler: ^(NationalAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->retrieveNationalAddress(id => $id);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->retrieveNationalAddress: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_response = api_instance.retrieve_national_address(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrieveNationalAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 -


retrievePeople


/api/v1/people/{id}/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/people/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            People result = apiInstance.retrievePeople(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrievePeople");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            People result = apiInstance.retrievePeople(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrievePeople");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 

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

[apiInstance retrievePeopleWith:id
              completionHandler: ^(People output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->retrievePeople(id => $id);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->retrievePeople: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_response = api_instance.retrieve_people(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrievePeople: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 -


retrievePronoun


/api/v1/pronouns/{id}/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/pronouns/{id}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiApi;

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

public class ApiApiExample {

    public static void main(String[] args) {
        
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            Pronoun result = apiInstance.retrievePronoun(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrievePronoun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiApi;

public class ApiApiExample {

    public static void main(String[] args) {
        ApiApi apiInstance = new ApiApi();
        String id = id_example; // String | 
        try {
            Pronoun result = apiInstance.retrievePronoun(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiApi#retrievePronoun");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 

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

[apiInstance retrievePronounWith:id
              completionHandler: ^(Pronoun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenField = require('open_field');

var api = new OpenField.ApiApi()
var id = id_example; // {{String}} 

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

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

            var apiInstance = new ApiApi();
            var id = id_example;  // String | 

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

$api_instance = new Swagger\Client\ApiApiApi();
$id = id_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ApiApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->retrievePronoun(id => $id);
    print Dumper($result);
};
if ([email protected]) {
    warn "Exception when calling ApiApi->retrievePronoun: [email protected]\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.ApiApi()
id = id_example # String | 

try: 
    api_response = api_instance.retrieve_pronoun(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiApi->retrievePronoun: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 -