ChronoSheets API

AggregateClientProjects

aggregateClientProjectsGetAggregateClientProjects

Get client and project information, aggregated. Requires the 'SubmitTimesheets' or 'ManageClientsAndProjects' permissions.


/AggregateClientProjects/GetAggregateClientProjects

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/AggregateClientProjects/GetAggregateClientProjects"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AggregateClientProjectsApi;

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

public class AggregateClientProjectsApiExample {

    public static void main(String[] args) {
        
        AggregateClientProjectsApi apiInstance = new AggregateClientProjectsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[AggregateClient]] result = apiInstance.aggregateClientProjectsGetAggregateClientProjects(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregateClientProjectsApi#aggregateClientProjectsGetAggregateClientProjects");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AggregateClientProjectsApi;

public class AggregateClientProjectsApiExample {

    public static void main(String[] args) {
        AggregateClientProjectsApi apiInstance = new AggregateClientProjectsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[AggregateClient]] result = apiInstance.aggregateClientProjectsGetAggregateClientProjects(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregateClientProjectsApi#aggregateClientProjectsGetAggregateClientProjects");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get client and project information, aggregated.  
Requires the 'SubmitTimesheets' or 'ManageClientsAndProjects' permissions.
[apiInstance aggregateClientProjectsGetAggregateClientProjectsWith:xChronosheetsAuth
              completionHandler: ^(ApiResponse[List[AggregateClient]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.AggregateClientProjectsApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class aggregateClientProjectsGetAggregateClientProjectsExample
    {
        public void main()
        {
            
            var apiInstance = new AggregateClientProjectsApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get client and project information, aggregated.  
Requires the 'SubmitTimesheets' or 'ManageClientsAndProjects' permissions.
                ApiResponse[List[AggregateClient]] result = apiInstance.aggregateClientProjectsGetAggregateClientProjects(xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregateClientProjectsApi.aggregateClientProjectsGetAggregateClientProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\AggregateClientProjectsApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->aggregateClientProjectsGetAggregateClientProjects($xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregateClientProjectsApi->aggregateClientProjectsGetAggregateClientProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::AggregateClientProjectsApi;

my $api_instance = ChronoSheetsAPI::AggregateClientProjectsApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

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

# create an instance of the API class
api_instance = ChronoSheetsAPI.AggregateClientProjectsApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get client and project information, aggregated.  
Requires the 'SubmitTimesheets' or 'ManageClientsAndProjects' permissions.
    api_response = api_instance.aggregate_client_projects_get_aggregate_client_projects(xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregateClientProjectsApi->aggregateClientProjectsGetAggregateClientProjects: %s\n" % e)
extern crate AggregateClientProjectsApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = AggregateClientProjectsApi::Context::default();
    let result = client.aggregateClientProjectsGetAggregateClientProjects(xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required

Responses


AggregateJobTasks

aggregateJobTasksGetAggregateJobTasks

Get jobs and tasks information, aggregated. Requires the 'SubmitTimesheets' or 'ManageJobsAndTask' permissions.


/AggregateJobTasks/GetAggregateJobTasks

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/AggregateJobTasks/GetAggregateJobTasks"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AggregateJobTasksApi;

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

public class AggregateJobTasksApiExample {

    public static void main(String[] args) {
        
        AggregateJobTasksApi apiInstance = new AggregateJobTasksApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[AggregateJobCode]] result = apiInstance.aggregateJobTasksGetAggregateJobTasks(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregateJobTasksApi#aggregateJobTasksGetAggregateJobTasks");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AggregateJobTasksApi;

public class AggregateJobTasksApiExample {

    public static void main(String[] args) {
        AggregateJobTasksApi apiInstance = new AggregateJobTasksApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[AggregateJobCode]] result = apiInstance.aggregateJobTasksGetAggregateJobTasks(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregateJobTasksApi#aggregateJobTasksGetAggregateJobTasks");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get jobs and tasks information, aggregated.  
Requires the 'SubmitTimesheets' or 'ManageJobsAndTask' permissions.
[apiInstance aggregateJobTasksGetAggregateJobTasksWith:xChronosheetsAuth
              completionHandler: ^(ApiResponse[List[AggregateJobCode]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.AggregateJobTasksApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class aggregateJobTasksGetAggregateJobTasksExample
    {
        public void main()
        {
            
            var apiInstance = new AggregateJobTasksApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get jobs and tasks information, aggregated.  
Requires the 'SubmitTimesheets' or 'ManageJobsAndTask' permissions.
                ApiResponse[List[AggregateJobCode]] result = apiInstance.aggregateJobTasksGetAggregateJobTasks(xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregateJobTasksApi.aggregateJobTasksGetAggregateJobTasks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\AggregateJobTasksApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->aggregateJobTasksGetAggregateJobTasks($xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregateJobTasksApi->aggregateJobTasksGetAggregateJobTasks: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::AggregateJobTasksApi;

my $api_instance = ChronoSheetsAPI::AggregateJobTasksApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

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

# create an instance of the API class
api_instance = ChronoSheetsAPI.AggregateJobTasksApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get jobs and tasks information, aggregated.  
Requires the 'SubmitTimesheets' or 'ManageJobsAndTask' permissions.
    api_response = api_instance.aggregate_job_tasks_get_aggregate_job_tasks(xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregateJobTasksApi->aggregateJobTasksGetAggregateJobTasks: %s\n" % e)
extern crate AggregateJobTasksApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = AggregateJobTasksApi::Context::default();
    let result = client.aggregateJobTasksGetAggregateJobTasks(xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required

Responses


Clients

clientsCreateClient

Create a client. Requires the 'ManageClientsAndProjects' permission.


/Clients/CreateClient

Usage and SDK Samples

curl -X POST "https://api.chronosheets.com/Clients/CreateClient"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientsApi;

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

public class ClientsApiExample {

    public static void main(String[] args) {
        
        ClientsApi apiInstance = new ClientsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        InsertClientRequest request = ; // InsertClientRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.clientsCreateClient(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#clientsCreateClient");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClientsApi;

public class ClientsApiExample {

    public static void main(String[] args) {
        ClientsApi apiInstance = new ClientsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        InsertClientRequest request = ; // InsertClientRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.clientsCreateClient(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#clientsCreateClient");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
InsertClientRequest *request = ; // 

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

// Create a client.  
Requires the 'ManageClientsAndProjects' permission.
[apiInstance clientsCreateClientWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse[Int32] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.ClientsApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {InsertClientRequest} 

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

namespace Example
{
    public class clientsCreateClientExample
    {
        public void main()
        {
            
            var apiInstance = new ClientsApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new InsertClientRequest(); // InsertClientRequest | 

            try
            {
                // Create a client.  
Requires the 'ManageClientsAndProjects' permission.
                ApiResponse[Int32] result = apiInstance.clientsCreateClient(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClientsApi.clientsCreateClient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\ClientsApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // InsertClientRequest | 

try {
    $result = $api_instance->clientsCreateClient($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientsApi->clientsCreateClient: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::ClientsApi;

my $api_instance = ChronoSheetsAPI::ClientsApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::InsertClientRequest->new(); # InsertClientRequest | 

eval { 
    my $result = $api_instance->clientsCreateClient(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientsApi->clientsCreateClient: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.ClientsApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # InsertClientRequest | 

try: 
    # Create a client.  
Requires the 'ManageClientsAndProjects' permission.
    api_response = api_instance.clients_create_client(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientsApi->clientsCreateClient: %s\n" % e)
extern crate ClientsApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // InsertClientRequest

    let mut context = ClientsApi::Context::default();
    let result = client.clientsCreateClient(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

An Insert Client Request object containing values for the new Client to create

Responses


clientsGetClient

Get a particular client. Requires the 'ManageClientsAndProjects' or 'ManageJobsAndTask' permissions.


/Clients/GetClient

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/Clients/GetClient?ClientId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientsApi;

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

public class ClientsApiExample {

    public static void main(String[] args) {
        
        ClientsApi apiInstance = new ClientsApi();
        Integer clientId = 56; // Integer | The ID of the Client you want to get
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[Client] result = apiInstance.clientsGetClient(clientId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#clientsGetClient");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClientsApi;

public class ClientsApiExample {

    public static void main(String[] args) {
        ClientsApi apiInstance = new ClientsApi();
        Integer clientId = 56; // Integer | The ID of the Client you want to get
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[Client] result = apiInstance.clientsGetClient(clientId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#clientsGetClient");
            e.printStackTrace();
        }
    }
}
Integer *clientId = 56; // The ID of the Client you want to get (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a particular client.  
Requires the 'ManageClientsAndProjects' or 'ManageJobsAndTask' permissions.
[apiInstance clientsGetClientWith:clientId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse[Client] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.ClientsApi()
var clientId = 56; // {Integer} The ID of the Client you want to get
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class clientsGetClientExample
    {
        public void main()
        {
            
            var apiInstance = new ClientsApi();
            var clientId = 56;  // Integer | The ID of the Client you want to get (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a particular client.  
Requires the 'ManageClientsAndProjects' or 'ManageJobsAndTask' permissions.
                ApiResponse[Client] result = apiInstance.clientsGetClient(clientId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClientsApi.clientsGetClient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\ClientsApi();
$clientId = 56; // Integer | The ID of the Client you want to get
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->clientsGetClient($clientId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientsApi->clientsGetClient: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::ClientsApi;

my $api_instance = ChronoSheetsAPI::ClientsApi->new();
my $clientId = 56; # Integer | The ID of the Client you want to get
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->clientsGetClient(clientId => $clientId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientsApi->clientsGetClient: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.ClientsApi()
clientId = 56 # Integer | The ID of the Client you want to get (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a particular client.  
Requires the 'ManageClientsAndProjects' or 'ManageJobsAndTask' permissions.
    api_response = api_instance.clients_get_client(clientId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientsApi->clientsGetClient: %s\n" % e)
extern crate ClientsApi;

pub fn main() {
    let clientId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = ClientsApi::Context::default();
    let result = client.clientsGetClient(clientId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
ClientId*
Integer (int32)
The ID of the Client you want to get
Required

Responses


clientsGetClients

Get a collection of clients that are under your organisation. Requires the 'ManageClientsAndProjects' or 'ManageJobsAndTask' permissions.


/Clients/GetClients

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/Clients/GetClients"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientsApi;

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

public class ClientsApiExample {

    public static void main(String[] args) {
        
        ClientsApi apiInstance = new ClientsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[Client]] result = apiInstance.clientsGetClients(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#clientsGetClients");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClientsApi;

public class ClientsApiExample {

    public static void main(String[] args) {
        ClientsApi apiInstance = new ClientsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[Client]] result = apiInstance.clientsGetClients(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#clientsGetClients");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a collection of clients that are under your organisation.  
Requires the 'ManageClientsAndProjects' or 'ManageJobsAndTask' permissions.
[apiInstance clientsGetClientsWith:xChronosheetsAuth
              completionHandler: ^(ApiResponse[List[Client]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.ClientsApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class clientsGetClientsExample
    {
        public void main()
        {
            
            var apiInstance = new ClientsApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a collection of clients that are under your organisation.  
Requires the 'ManageClientsAndProjects' or 'ManageJobsAndTask' permissions.
                ApiResponse[List[Client]] result = apiInstance.clientsGetClients(xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClientsApi.clientsGetClients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\ClientsApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->clientsGetClients($xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientsApi->clientsGetClients: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::ClientsApi;

my $api_instance = ChronoSheetsAPI::ClientsApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

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

# create an instance of the API class
api_instance = ChronoSheetsAPI.ClientsApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a collection of clients that are under your organisation.  
Requires the 'ManageClientsAndProjects' or 'ManageJobsAndTask' permissions.
    api_response = api_instance.clients_get_clients(xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientsApi->clientsGetClients: %s\n" % e)
extern crate ClientsApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = ClientsApi::Context::default();
    let result = client.clientsGetClients(xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required

Responses


clientsUpdateClient

Update a client. Requires the 'ManageClientsAndProjects' permission.


/Clients/UpdateClient

Usage and SDK Samples

curl -X PUT "https://api.chronosheets.com/Clients/UpdateClient"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClientsApi;

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

public class ClientsApiExample {

    public static void main(String[] args) {
        
        ClientsApi apiInstance = new ClientsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        SaveClientRequest request = ; // SaveClientRequest | 
        try {
            ApiResponse['Boolean'] result = apiInstance.clientsUpdateClient(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#clientsUpdateClient");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ClientsApi;

public class ClientsApiExample {

    public static void main(String[] args) {
        ClientsApi apiInstance = new ClientsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        SaveClientRequest request = ; // SaveClientRequest | 
        try {
            ApiResponse['Boolean'] result = apiInstance.clientsUpdateClient(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClientsApi#clientsUpdateClient");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
SaveClientRequest *request = ; // 

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

// Update a client.  
Requires the 'ManageClientsAndProjects' permission.
[apiInstance clientsUpdateClientWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse['Boolean'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.ClientsApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {SaveClientRequest} 

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

namespace Example
{
    public class clientsUpdateClientExample
    {
        public void main()
        {
            
            var apiInstance = new ClientsApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new SaveClientRequest(); // SaveClientRequest | 

            try
            {
                // Update a client.  
Requires the 'ManageClientsAndProjects' permission.
                ApiResponse['Boolean'] result = apiInstance.clientsUpdateClient(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClientsApi.clientsUpdateClient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\ClientsApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // SaveClientRequest | 

try {
    $result = $api_instance->clientsUpdateClient($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClientsApi->clientsUpdateClient: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::ClientsApi;

my $api_instance = ChronoSheetsAPI::ClientsApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::SaveClientRequest->new(); # SaveClientRequest | 

eval { 
    my $result = $api_instance->clientsUpdateClient(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClientsApi->clientsUpdateClient: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.ClientsApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # SaveClientRequest | 

try: 
    # Update a client.  
Requires the 'ManageClientsAndProjects' permission.
    api_response = api_instance.clients_update_client(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClientsApi->clientsUpdateClient: %s\n" % e)
extern crate ClientsApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // SaveClientRequest

    let mut context = ClientsApi::Context::default();
    let result = client.clientsUpdateClient(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

A Save Client Request object containing updated fields. Make sure to specify the Client Id in the request object so that ChronoSheets knows which Client to update

Responses


FileAttachments

fileAttachmentsDeleteTimesheetFileAttachment

Delete a particular timesheet file attachment Requires the 'SubmitTimesheets' permission.


/FileAttachments/DeleteTimesheetFileAttachment

Usage and SDK Samples

curl -X DELETE "https://api.chronosheets.com/FileAttachments/DeleteTimesheetFileAttachment?FileAttachmentId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FileAttachmentsApi;

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

public class FileAttachmentsApiExample {

    public static void main(String[] args) {
        
        FileAttachmentsApi apiInstance = new FileAttachmentsApi();
        Integer fileAttachmentId = 56; // Integer | The Id of the file attachment to delete
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse['Boolean'] result = apiInstance.fileAttachmentsDeleteTimesheetFileAttachment(fileAttachmentId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileAttachmentsApi#fileAttachmentsDeleteTimesheetFileAttachment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FileAttachmentsApi;

public class FileAttachmentsApiExample {

    public static void main(String[] args) {
        FileAttachmentsApi apiInstance = new FileAttachmentsApi();
        Integer fileAttachmentId = 56; // Integer | The Id of the file attachment to delete
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse['Boolean'] result = apiInstance.fileAttachmentsDeleteTimesheetFileAttachment(fileAttachmentId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileAttachmentsApi#fileAttachmentsDeleteTimesheetFileAttachment");
            e.printStackTrace();
        }
    }
}
Integer *fileAttachmentId = 56; // The Id of the file attachment to delete (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Delete a particular timesheet file attachment
Requires the 'SubmitTimesheets' permission.
[apiInstance fileAttachmentsDeleteTimesheetFileAttachmentWith:fileAttachmentId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse['Boolean'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.FileAttachmentsApi()
var fileAttachmentId = 56; // {Integer} The Id of the file attachment to delete
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class fileAttachmentsDeleteTimesheetFileAttachmentExample
    {
        public void main()
        {
            
            var apiInstance = new FileAttachmentsApi();
            var fileAttachmentId = 56;  // Integer | The Id of the file attachment to delete (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Delete a particular timesheet file attachment
Requires the 'SubmitTimesheets' permission.
                ApiResponse['Boolean'] result = apiInstance.fileAttachmentsDeleteTimesheetFileAttachment(fileAttachmentId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileAttachmentsApi.fileAttachmentsDeleteTimesheetFileAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\FileAttachmentsApi();
$fileAttachmentId = 56; // Integer | The Id of the file attachment to delete
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->fileAttachmentsDeleteTimesheetFileAttachment($fileAttachmentId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileAttachmentsApi->fileAttachmentsDeleteTimesheetFileAttachment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::FileAttachmentsApi;

my $api_instance = ChronoSheetsAPI::FileAttachmentsApi->new();
my $fileAttachmentId = 56; # Integer | The Id of the file attachment to delete
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->fileAttachmentsDeleteTimesheetFileAttachment(fileAttachmentId => $fileAttachmentId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileAttachmentsApi->fileAttachmentsDeleteTimesheetFileAttachment: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.FileAttachmentsApi()
fileAttachmentId = 56 # Integer | The Id of the file attachment to delete (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Delete a particular timesheet file attachment
Requires the 'SubmitTimesheets' permission.
    api_response = api_instance.file_attachments_delete_timesheet_file_attachment(fileAttachmentId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileAttachmentsApi->fileAttachmentsDeleteTimesheetFileAttachment: %s\n" % e)
extern crate FileAttachmentsApi;

pub fn main() {
    let fileAttachmentId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = FileAttachmentsApi::Context::default();
    let result = client.fileAttachmentsDeleteTimesheetFileAttachment(fileAttachmentId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
FileAttachmentId*
Integer (int32)
The Id of the file attachment to delete
Required

Responses


fileAttachmentsGetFileAttachmentById

Get a particular file attachment by ID. User must own the file attachment for access.


/FileAttachments/GetFileAttachmentById

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/FileAttachments/GetFileAttachmentById?FileAttachmentId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FileAttachmentsApi;

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

public class FileAttachmentsApiExample {

    public static void main(String[] args) {
        
        FileAttachmentsApi apiInstance = new FileAttachmentsApi();
        Integer fileAttachmentId = 56; // Integer | The ID of the file attachment
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[TimesheetFileAttachment] result = apiInstance.fileAttachmentsGetFileAttachmentById(fileAttachmentId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileAttachmentsApi#fileAttachmentsGetFileAttachmentById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FileAttachmentsApi;

public class FileAttachmentsApiExample {

    public static void main(String[] args) {
        FileAttachmentsApi apiInstance = new FileAttachmentsApi();
        Integer fileAttachmentId = 56; // Integer | The ID of the file attachment
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[TimesheetFileAttachment] result = apiInstance.fileAttachmentsGetFileAttachmentById(fileAttachmentId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileAttachmentsApi#fileAttachmentsGetFileAttachmentById");
            e.printStackTrace();
        }
    }
}
Integer *fileAttachmentId = 56; // The ID of the file attachment (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a particular file attachment by ID.  User must own the file attachment for access.
[apiInstance fileAttachmentsGetFileAttachmentByIdWith:fileAttachmentId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse[TimesheetFileAttachment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.FileAttachmentsApi()
var fileAttachmentId = 56; // {Integer} The ID of the file attachment
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class fileAttachmentsGetFileAttachmentByIdExample
    {
        public void main()
        {
            
            var apiInstance = new FileAttachmentsApi();
            var fileAttachmentId = 56;  // Integer | The ID of the file attachment (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a particular file attachment by ID.  User must own the file attachment for access.
                ApiResponse[TimesheetFileAttachment] result = apiInstance.fileAttachmentsGetFileAttachmentById(fileAttachmentId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileAttachmentsApi.fileAttachmentsGetFileAttachmentById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\FileAttachmentsApi();
$fileAttachmentId = 56; // Integer | The ID of the file attachment
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->fileAttachmentsGetFileAttachmentById($fileAttachmentId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileAttachmentsApi->fileAttachmentsGetFileAttachmentById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::FileAttachmentsApi;

my $api_instance = ChronoSheetsAPI::FileAttachmentsApi->new();
my $fileAttachmentId = 56; # Integer | The ID of the file attachment
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->fileAttachmentsGetFileAttachmentById(fileAttachmentId => $fileAttachmentId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileAttachmentsApi->fileAttachmentsGetFileAttachmentById: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.FileAttachmentsApi()
fileAttachmentId = 56 # Integer | The ID of the file attachment (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a particular file attachment by ID.  User must own the file attachment for access.
    api_response = api_instance.file_attachments_get_file_attachment_by_id(fileAttachmentId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileAttachmentsApi->fileAttachmentsGetFileAttachmentById: %s\n" % e)
extern crate FileAttachmentsApi;

pub fn main() {
    let fileAttachmentId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = FileAttachmentsApi::Context::default();
    let result = client.fileAttachmentsGetFileAttachmentById(fileAttachmentId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
FileAttachmentId*
Integer (int32)
The ID of the file attachment
Required

Responses


fileAttachmentsGetMyFileAttachments

Get my file attachments. Get files you've attached to timesheets.


/FileAttachments/GetMyFileAttachments

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/FileAttachments/GetMyFileAttachments?StartDate=&EndDate=&Skip=&Take="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FileAttachmentsApi;

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

public class FileAttachmentsApiExample {

    public static void main(String[] args) {
        
        FileAttachmentsApi apiInstance = new FileAttachmentsApi();
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The Start date of the date range.  File attachments after this date will be obtained.
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The End date of the date range.  File attachments before this date will be obtained.
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        Integer skip = 56; // Integer | Skip this many File attachments
        Integer take = 56; // Integer | Take this many File attachments
        try {
            ApiResponseForPaginated[List[TimesheetFileAttachment]] result = apiInstance.fileAttachmentsGetMyFileAttachments(startDate, endDate, xChronosheetsAuth, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileAttachmentsApi#fileAttachmentsGetMyFileAttachments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FileAttachmentsApi;

public class FileAttachmentsApiExample {

    public static void main(String[] args) {
        FileAttachmentsApi apiInstance = new FileAttachmentsApi();
        Date startDate = 2013-10-20T19:20:30+01:00; // Date | The Start date of the date range.  File attachments after this date will be obtained.
        Date endDate = 2013-10-20T19:20:30+01:00; // Date | The End date of the date range.  File attachments before this date will be obtained.
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        Integer skip = 56; // Integer | Skip this many File attachments
        Integer take = 56; // Integer | Take this many File attachments
        try {
            ApiResponseForPaginated[List[TimesheetFileAttachment]] result = apiInstance.fileAttachmentsGetMyFileAttachments(startDate, endDate, xChronosheetsAuth, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileAttachmentsApi#fileAttachmentsGetMyFileAttachments");
            e.printStackTrace();
        }
    }
}
Date *startDate = 2013-10-20T19:20:30+01:00; // The Start date of the date range.  File attachments after this date will be obtained. (default to null)
Date *endDate = 2013-10-20T19:20:30+01:00; // The End date of the date range.  File attachments before this date will be obtained. (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
Integer *skip = 56; // Skip this many File attachments (optional) (default to null)
Integer *take = 56; // Take this many File attachments (optional) (default to null)

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

// Get my file attachments.  Get files you've attached to timesheets.
[apiInstance fileAttachmentsGetMyFileAttachmentsWith:startDate
    endDate:endDate
    xChronosheetsAuth:xChronosheetsAuth
    skip:skip
    take:take
              completionHandler: ^(ApiResponseForPaginated[List[TimesheetFileAttachment]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.FileAttachmentsApi()
var startDate = 2013-10-20T19:20:30+01:00; // {Date} The Start date of the date range.  File attachments after this date will be obtained.
var endDate = 2013-10-20T19:20:30+01:00; // {Date} The End date of the date range.  File attachments before this date will be obtained.
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var opts = {
  'skip': 56, // {Integer} Skip this many File attachments
  'take': 56 // {Integer} Take this many File attachments
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fileAttachmentsGetMyFileAttachments(startDate, endDate, xChronosheetsAuth, opts, callback);
using System;
using System.Diagnostics;
using ChronoSheetsAPI.Api;
using ChronoSheetsAPI.Client;
using ChronoSheetsAPI.Model;

namespace Example
{
    public class fileAttachmentsGetMyFileAttachmentsExample
    {
        public void main()
        {
            
            var apiInstance = new FileAttachmentsApi();
            var startDate = 2013-10-20T19:20:30+01:00;  // Date | The Start date of the date range.  File attachments after this date will be obtained. (default to null)
            var endDate = 2013-10-20T19:20:30+01:00;  // Date | The End date of the date range.  File attachments before this date will be obtained. (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var skip = 56;  // Integer | Skip this many File attachments (optional)  (default to null)
            var take = 56;  // Integer | Take this many File attachments (optional)  (default to null)

            try
            {
                // Get my file attachments.  Get files you've attached to timesheets.
                ApiResponseForPaginated[List[TimesheetFileAttachment]] result = apiInstance.fileAttachmentsGetMyFileAttachments(startDate, endDate, xChronosheetsAuth, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FileAttachmentsApi.fileAttachmentsGetMyFileAttachments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\FileAttachmentsApi();
$startDate = 2013-10-20T19:20:30+01:00; // Date | The Start date of the date range.  File attachments after this date will be obtained.
$endDate = 2013-10-20T19:20:30+01:00; // Date | The End date of the date range.  File attachments before this date will be obtained.
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$skip = 56; // Integer | Skip this many File attachments
$take = 56; // Integer | Take this many File attachments

try {
    $result = $api_instance->fileAttachmentsGetMyFileAttachments($startDate, $endDate, $xChronosheetsAuth, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FileAttachmentsApi->fileAttachmentsGetMyFileAttachments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::FileAttachmentsApi;

my $api_instance = ChronoSheetsAPI::FileAttachmentsApi->new();
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The Start date of the date range.  File attachments after this date will be obtained.
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The End date of the date range.  File attachments before this date will be obtained.
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $skip = 56; # Integer | Skip this many File attachments
my $take = 56; # Integer | Take this many File attachments

eval { 
    my $result = $api_instance->fileAttachmentsGetMyFileAttachments(startDate => $startDate, endDate => $endDate, xChronosheetsAuth => $xChronosheetsAuth, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FileAttachmentsApi->fileAttachmentsGetMyFileAttachments: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.FileAttachmentsApi()
startDate = 2013-10-20T19:20:30+01:00 # Date | The Start date of the date range.  File attachments after this date will be obtained. (default to null)
endDate = 2013-10-20T19:20:30+01:00 # Date | The End date of the date range.  File attachments before this date will be obtained. (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
skip = 56 # Integer | Skip this many File attachments (optional) (default to null)
take = 56 # Integer | Take this many File attachments (optional) (default to null)

try: 
    # Get my file attachments.  Get files you've attached to timesheets.
    api_response = api_instance.file_attachments_get_my_file_attachments(startDate, endDate, xChronosheetsAuth, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FileAttachmentsApi->fileAttachmentsGetMyFileAttachments: %s\n" % e)
extern crate FileAttachmentsApi;

pub fn main() {
    let startDate = 2013-10-20T19:20:30+01:00; // Date
    let endDate = 2013-10-20T19:20:30+01:00; // Date
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let skip = 56; // Integer
    let take = 56; // Integer

    let mut context = FileAttachmentsApi::Context::default();
    let result = client.fileAttachmentsGetMyFileAttachments(startDate, endDate, xChronosheetsAuth, skip, take, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
StartDate*
Date (date-time)
The Start date of the date range. File attachments after this date will be obtained.
Required
EndDate*
Date (date-time)
The End date of the date range. File attachments before this date will be obtained.
Required
Skip
Integer (int32)
Skip this many File attachments
Take
Integer (int32)
Take this many File attachments

Responses


Fleet

fleetCreateVehicle

Create a vehicle. Requires the 'ManageFleet' permission.


/Fleet/CreateVehicle

Usage and SDK Samples

curl -X POST "https://api.chronosheets.com/Fleet/CreateVehicle"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FleetApi;

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

public class FleetApiExample {

    public static void main(String[] args) {
        
        FleetApi apiInstance = new FleetApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        InsertVehicleRequest request = ; // InsertVehicleRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.fleetCreateVehicle(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetCreateVehicle");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FleetApi;

public class FleetApiExample {

    public static void main(String[] args) {
        FleetApi apiInstance = new FleetApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        InsertVehicleRequest request = ; // InsertVehicleRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.fleetCreateVehicle(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetCreateVehicle");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
InsertVehicleRequest *request = ; // 

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

// Create a vehicle.  
Requires the 'ManageFleet' permission.
[apiInstance fleetCreateVehicleWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse[Int32] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.FleetApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {InsertVehicleRequest} 

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

namespace Example
{
    public class fleetCreateVehicleExample
    {
        public void main()
        {
            
            var apiInstance = new FleetApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new InsertVehicleRequest(); // InsertVehicleRequest | 

            try
            {
                // Create a vehicle.  
Requires the 'ManageFleet' permission.
                ApiResponse[Int32] result = apiInstance.fleetCreateVehicle(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FleetApi.fleetCreateVehicle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\FleetApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // InsertVehicleRequest | 

try {
    $result = $api_instance->fleetCreateVehicle($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FleetApi->fleetCreateVehicle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::FleetApi;

my $api_instance = ChronoSheetsAPI::FleetApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::InsertVehicleRequest->new(); # InsertVehicleRequest | 

eval { 
    my $result = $api_instance->fleetCreateVehicle(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FleetApi->fleetCreateVehicle: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.FleetApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # InsertVehicleRequest | 

try: 
    # Create a vehicle.  
Requires the 'ManageFleet' permission.
    api_response = api_instance.fleet_create_vehicle(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FleetApi->fleetCreateVehicle: %s\n" % e)
extern crate FleetApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // InsertVehicleRequest

    let mut context = FleetApi::Context::default();
    let result = client.fleetCreateVehicle(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

An Insert Vehicle Request object containing values for the new Vehicle to create

Responses


fleetDeleteVehicle

Delete a vehicle from the fleet. Requires the 'ManageFleet' permission.


/Fleet/DeleteVehicle

Usage and SDK Samples

curl -X DELETE "https://api.chronosheets.com/Fleet/DeleteVehicle?VehicleId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FleetApi;

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

public class FleetApiExample {

    public static void main(String[] args) {
        
        FleetApi apiInstance = new FleetApi();
        Integer vehicleId = 56; // Integer | The unique ID of the vehicle you wish to delete
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse['Boolean'] result = apiInstance.fleetDeleteVehicle(vehicleId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetDeleteVehicle");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FleetApi;

public class FleetApiExample {

    public static void main(String[] args) {
        FleetApi apiInstance = new FleetApi();
        Integer vehicleId = 56; // Integer | The unique ID of the vehicle you wish to delete
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse['Boolean'] result = apiInstance.fleetDeleteVehicle(vehicleId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetDeleteVehicle");
            e.printStackTrace();
        }
    }
}
Integer *vehicleId = 56; // The unique ID of the vehicle you wish to delete (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Delete a vehicle from the fleet.
Requires the 'ManageFleet' permission.
[apiInstance fleetDeleteVehicleWith:vehicleId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse['Boolean'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.FleetApi()
var vehicleId = 56; // {Integer} The unique ID of the vehicle you wish to delete
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class fleetDeleteVehicleExample
    {
        public void main()
        {
            
            var apiInstance = new FleetApi();
            var vehicleId = 56;  // Integer | The unique ID of the vehicle you wish to delete (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Delete a vehicle from the fleet.
Requires the 'ManageFleet' permission.
                ApiResponse['Boolean'] result = apiInstance.fleetDeleteVehicle(vehicleId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FleetApi.fleetDeleteVehicle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\FleetApi();
$vehicleId = 56; // Integer | The unique ID of the vehicle you wish to delete
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->fleetDeleteVehicle($vehicleId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FleetApi->fleetDeleteVehicle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::FleetApi;

my $api_instance = ChronoSheetsAPI::FleetApi->new();
my $vehicleId = 56; # Integer | The unique ID of the vehicle you wish to delete
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->fleetDeleteVehicle(vehicleId => $vehicleId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FleetApi->fleetDeleteVehicle: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.FleetApi()
vehicleId = 56 # Integer | The unique ID of the vehicle you wish to delete (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Delete a vehicle from the fleet.
Requires the 'ManageFleet' permission.
    api_response = api_instance.fleet_delete_vehicle(vehicleId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FleetApi->fleetDeleteVehicle: %s\n" % e)
extern crate FleetApi;

pub fn main() {
    let vehicleId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = FleetApi::Context::default();
    let result = client.fleetDeleteVehicle(vehicleId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
VehicleId*
Integer (int32)
The unique ID of the vehicle you wish to delete
Required

Responses


fleetGetVehicleById

Get a particular vehicle. Does not require any special permission.


/Fleet/GetVehicleById

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/Fleet/GetVehicleById?VehicleId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FleetApi;

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

public class FleetApiExample {

    public static void main(String[] args) {
        
        FleetApi apiInstance = new FleetApi();
        Integer vehicleId = 56; // Integer | The ID of the Vehicle you want to get
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[FleetVehicle] result = apiInstance.fleetGetVehicleById(vehicleId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetGetVehicleById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FleetApi;

public class FleetApiExample {

    public static void main(String[] args) {
        FleetApi apiInstance = new FleetApi();
        Integer vehicleId = 56; // Integer | The ID of the Vehicle you want to get
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[FleetVehicle] result = apiInstance.fleetGetVehicleById(vehicleId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetGetVehicleById");
            e.printStackTrace();
        }
    }
}
Integer *vehicleId = 56; // The ID of the Vehicle you want to get (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a particular vehicle.
Does not require any special permission.
[apiInstance fleetGetVehicleByIdWith:vehicleId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse[FleetVehicle] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.FleetApi()
var vehicleId = 56; // {Integer} The ID of the Vehicle you want to get
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class fleetGetVehicleByIdExample
    {
        public void main()
        {
            
            var apiInstance = new FleetApi();
            var vehicleId = 56;  // Integer | The ID of the Vehicle you want to get (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a particular vehicle.
Does not require any special permission.
                ApiResponse[FleetVehicle] result = apiInstance.fleetGetVehicleById(vehicleId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FleetApi.fleetGetVehicleById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\FleetApi();
$vehicleId = 56; // Integer | The ID of the Vehicle you want to get
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->fleetGetVehicleById($vehicleId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FleetApi->fleetGetVehicleById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::FleetApi;

my $api_instance = ChronoSheetsAPI::FleetApi->new();
my $vehicleId = 56; # Integer | The ID of the Vehicle you want to get
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->fleetGetVehicleById(vehicleId => $vehicleId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FleetApi->fleetGetVehicleById: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.FleetApi()
vehicleId = 56 # Integer | The ID of the Vehicle you want to get (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a particular vehicle.
Does not require any special permission.
    api_response = api_instance.fleet_get_vehicle_by_id(vehicleId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FleetApi->fleetGetVehicleById: %s\n" % e)
extern crate FleetApi;

pub fn main() {
    let vehicleId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = FleetApi::Context::default();
    let result = client.fleetGetVehicleById(vehicleId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
VehicleId*
Integer (int32)
The ID of the Vehicle you want to get
Required

Responses


fleetGetVehicles

Get a collection of vehicles that are under your organisation. Does not require any special permission.


/Fleet/GetVehicles

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/Fleet/GetVehicles?IncludeDeleted="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FleetApi;

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

public class FleetApiExample {

    public static void main(String[] args) {
        
        FleetApi apiInstance = new FleetApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        Boolean includeDeleted = true; // Boolean | Whether or not to include deleted vehicles
        try {
            ApiResponse[List[FleetVehicle]] result = apiInstance.fleetGetVehicles(xChronosheetsAuth, includeDeleted);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetGetVehicles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FleetApi;

public class FleetApiExample {

    public static void main(String[] args) {
        FleetApi apiInstance = new FleetApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        Boolean includeDeleted = true; // Boolean | Whether or not to include deleted vehicles
        try {
            ApiResponse[List[FleetVehicle]] result = apiInstance.fleetGetVehicles(xChronosheetsAuth, includeDeleted);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetGetVehicles");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
Boolean *includeDeleted = true; // Whether or not to include deleted vehicles (optional) (default to null)

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

// Get a collection of vehicles that are under your organisation.  
Does not require any special permission.
[apiInstance fleetGetVehiclesWith:xChronosheetsAuth
    includeDeleted:includeDeleted
              completionHandler: ^(ApiResponse[List[FleetVehicle]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.FleetApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var opts = {
  'includeDeleted': true // {Boolean} Whether or not to include deleted vehicles
};

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

namespace Example
{
    public class fleetGetVehiclesExample
    {
        public void main()
        {
            
            var apiInstance = new FleetApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var includeDeleted = true;  // Boolean | Whether or not to include deleted vehicles (optional)  (default to null)

            try
            {
                // Get a collection of vehicles that are under your organisation.  
Does not require any special permission.
                ApiResponse[List[FleetVehicle]] result = apiInstance.fleetGetVehicles(xChronosheetsAuth, includeDeleted);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FleetApi.fleetGetVehicles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\FleetApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$includeDeleted = true; // Boolean | Whether or not to include deleted vehicles

try {
    $result = $api_instance->fleetGetVehicles($xChronosheetsAuth, $includeDeleted);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FleetApi->fleetGetVehicles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::FleetApi;

my $api_instance = ChronoSheetsAPI::FleetApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $includeDeleted = true; # Boolean | Whether or not to include deleted vehicles

eval { 
    my $result = $api_instance->fleetGetVehicles(xChronosheetsAuth => $xChronosheetsAuth, includeDeleted => $includeDeleted);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FleetApi->fleetGetVehicles: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.FleetApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
includeDeleted = true # Boolean | Whether or not to include deleted vehicles (optional) (default to null)

try: 
    # Get a collection of vehicles that are under your organisation.  
Does not require any special permission.
    api_response = api_instance.fleet_get_vehicles(xChronosheetsAuth, includeDeleted=includeDeleted)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FleetApi->fleetGetVehicles: %s\n" % e)
extern crate FleetApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let includeDeleted = true; // Boolean

    let mut context = FleetApi::Context::default();
    let result = client.fleetGetVehicles(xChronosheetsAuth, includeDeleted, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
IncludeDeleted
Boolean
Whether or not to include deleted vehicles

Responses


fleetUpdateVehicle

Update a vehicle. Requires the 'ManageFleet' permission.


/Fleet/UpdateVehicle

Usage and SDK Samples

curl -X PUT "https://api.chronosheets.com/Fleet/UpdateVehicle"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FleetApi;

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

public class FleetApiExample {

    public static void main(String[] args) {
        
        FleetApi apiInstance = new FleetApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        SaveVehicleRequest request = ; // SaveVehicleRequest | 
        try {
            ApiResponse['Boolean'] result = apiInstance.fleetUpdateVehicle(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetUpdateVehicle");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FleetApi;

public class FleetApiExample {

    public static void main(String[] args) {
        FleetApi apiInstance = new FleetApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        SaveVehicleRequest request = ; // SaveVehicleRequest | 
        try {
            ApiResponse['Boolean'] result = apiInstance.fleetUpdateVehicle(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FleetApi#fleetUpdateVehicle");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
SaveVehicleRequest *request = ; // 

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

// Update a vehicle.  
Requires the 'ManageFleet' permission.
[apiInstance fleetUpdateVehicleWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse['Boolean'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.FleetApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {SaveVehicleRequest} 

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

namespace Example
{
    public class fleetUpdateVehicleExample
    {
        public void main()
        {
            
            var apiInstance = new FleetApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new SaveVehicleRequest(); // SaveVehicleRequest | 

            try
            {
                // Update a vehicle.  
Requires the 'ManageFleet' permission.
                ApiResponse['Boolean'] result = apiInstance.fleetUpdateVehicle(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FleetApi.fleetUpdateVehicle: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\FleetApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // SaveVehicleRequest | 

try {
    $result = $api_instance->fleetUpdateVehicle($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FleetApi->fleetUpdateVehicle: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::FleetApi;

my $api_instance = ChronoSheetsAPI::FleetApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::SaveVehicleRequest->new(); # SaveVehicleRequest | 

eval { 
    my $result = $api_instance->fleetUpdateVehicle(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FleetApi->fleetUpdateVehicle: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.FleetApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # SaveVehicleRequest | 

try: 
    # Update a vehicle.  
Requires the 'ManageFleet' permission.
    api_response = api_instance.fleet_update_vehicle(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FleetApi->fleetUpdateVehicle: %s\n" % e)
extern crate FleetApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // SaveVehicleRequest

    let mut context = FleetApi::Context::default();
    let result = client.fleetUpdateVehicle(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

A Save Vehicle Request object containing updated fields. Make sure to specify the Vehicle Id in the request object so that ChronoSheets knows which Vehicle to update

Responses


GeoFencing

geoFencingCreateGeofence

Create a geofencing with rules to be used for clock on/off automation. Requires the 'ManageGeofencing' permission.


/GeoFencing/CreateGeofence

Usage and SDK Samples

curl -X POST "https://api.chronosheets.com/GeoFencing/CreateGeofence"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoFencingApi;

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

public class GeoFencingApiExample {

    public static void main(String[] args) {
        
        GeoFencingApi apiInstance = new GeoFencingApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        CreateGeoFenceRequest request = ; // CreateGeoFenceRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.geoFencingCreateGeofence(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingCreateGeofence");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GeoFencingApi;

public class GeoFencingApiExample {

    public static void main(String[] args) {
        GeoFencingApi apiInstance = new GeoFencingApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        CreateGeoFenceRequest request = ; // CreateGeoFenceRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.geoFencingCreateGeofence(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingCreateGeofence");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
CreateGeoFenceRequest *request = ; // 

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

// Create a geofencing with rules to be used for clock on/off automation.
Requires the 'ManageGeofencing' permission.
[apiInstance geoFencingCreateGeofenceWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse[Int32] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.GeoFencingApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {CreateGeoFenceRequest} 

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

namespace Example
{
    public class geoFencingCreateGeofenceExample
    {
        public void main()
        {
            
            var apiInstance = new GeoFencingApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new CreateGeoFenceRequest(); // CreateGeoFenceRequest | 

            try
            {
                // Create a geofencing with rules to be used for clock on/off automation.
Requires the 'ManageGeofencing' permission.
                ApiResponse[Int32] result = apiInstance.geoFencingCreateGeofence(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeoFencingApi.geoFencingCreateGeofence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\GeoFencingApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // CreateGeoFenceRequest | 

try {
    $result = $api_instance->geoFencingCreateGeofence($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoFencingApi->geoFencingCreateGeofence: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::GeoFencingApi;

my $api_instance = ChronoSheetsAPI::GeoFencingApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::CreateGeoFenceRequest->new(); # CreateGeoFenceRequest | 

eval { 
    my $result = $api_instance->geoFencingCreateGeofence(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeoFencingApi->geoFencingCreateGeofence: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.GeoFencingApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # CreateGeoFenceRequest | 

try: 
    # Create a geofencing with rules to be used for clock on/off automation.
Requires the 'ManageGeofencing' permission.
    api_response = api_instance.geo_fencing_create_geofence(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoFencingApi->geoFencingCreateGeofence: %s\n" % e)
extern crate GeoFencingApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // CreateGeoFenceRequest

    let mut context = GeoFencingApi::Context::default();
    let result = client.geoFencingCreateGeofence(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

Responses


geoFencingDeleteGeofence

Deletes a geofence. Requires the 'ManageGeofencing' permission.


/GeoFencing/DeleteGeofence

Usage and SDK Samples

curl -X DELETE "https://api.chronosheets.com/GeoFencing/DeleteGeofence?GeofenceId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoFencingApi;

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

public class GeoFencingApiExample {

    public static void main(String[] args) {
        
        GeoFencingApi apiInstance = new GeoFencingApi();
        Integer geofenceId = 56; // Integer | Specify the geofence you want to delete with the geofence ID.
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[Geofence] result = apiInstance.geoFencingDeleteGeofence(geofenceId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingDeleteGeofence");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GeoFencingApi;

public class GeoFencingApiExample {

    public static void main(String[] args) {
        GeoFencingApi apiInstance = new GeoFencingApi();
        Integer geofenceId = 56; // Integer | Specify the geofence you want to delete with the geofence ID.
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[Geofence] result = apiInstance.geoFencingDeleteGeofence(geofenceId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingDeleteGeofence");
            e.printStackTrace();
        }
    }
}
Integer *geofenceId = 56; // Specify the geofence you want to delete with the geofence ID. (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Deletes a geofence.
Requires the 'ManageGeofencing' permission.
[apiInstance geoFencingDeleteGeofenceWith:geofenceId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse[Geofence] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.GeoFencingApi()
var geofenceId = 56; // {Integer} Specify the geofence you want to delete with the geofence ID.
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class geoFencingDeleteGeofenceExample
    {
        public void main()
        {
            
            var apiInstance = new GeoFencingApi();
            var geofenceId = 56;  // Integer | Specify the geofence you want to delete with the geofence ID. (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Deletes a geofence.
Requires the 'ManageGeofencing' permission.
                ApiResponse[Geofence] result = apiInstance.geoFencingDeleteGeofence(geofenceId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeoFencingApi.geoFencingDeleteGeofence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\GeoFencingApi();
$geofenceId = 56; // Integer | Specify the geofence you want to delete with the geofence ID.
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->geoFencingDeleteGeofence($geofenceId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoFencingApi->geoFencingDeleteGeofence: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::GeoFencingApi;

my $api_instance = ChronoSheetsAPI::GeoFencingApi->new();
my $geofenceId = 56; # Integer | Specify the geofence you want to delete with the geofence ID.
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->geoFencingDeleteGeofence(geofenceId => $geofenceId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeoFencingApi->geoFencingDeleteGeofence: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.GeoFencingApi()
geofenceId = 56 # Integer | Specify the geofence you want to delete with the geofence ID. (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Deletes a geofence.
Requires the 'ManageGeofencing' permission.
    api_response = api_instance.geo_fencing_delete_geofence(geofenceId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoFencingApi->geoFencingDeleteGeofence: %s\n" % e)
extern crate GeoFencingApi;

pub fn main() {
    let geofenceId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = GeoFencingApi::Context::default();
    let result = client.geoFencingDeleteGeofence(geofenceId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
GeofenceId*
Integer (int32)
Specify the geofence you want to delete with the geofence ID.
Required

Responses


geoFencingGetGeofenceById

Get a geofence by ID Requires the 'SubmitTimesheets' permission.


/GeoFencing/GetGeofenceById

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/GeoFencing/GetGeofenceById?GeofenceId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoFencingApi;

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

public class GeoFencingApiExample {

    public static void main(String[] args) {
        
        GeoFencingApi apiInstance = new GeoFencingApi();
        Integer geofenceId = 56; // Integer | The ID of the geofence you want to obtain
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[Geofence] result = apiInstance.geoFencingGetGeofenceById(geofenceId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingGetGeofenceById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GeoFencingApi;

public class GeoFencingApiExample {

    public static void main(String[] args) {
        GeoFencingApi apiInstance = new GeoFencingApi();
        Integer geofenceId = 56; // Integer | The ID of the geofence you want to obtain
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[Geofence] result = apiInstance.geoFencingGetGeofenceById(geofenceId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingGetGeofenceById");
            e.printStackTrace();
        }
    }
}
Integer *geofenceId = 56; // The ID of the geofence you want to obtain (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a geofence by ID
Requires the 'SubmitTimesheets' permission.
[apiInstance geoFencingGetGeofenceByIdWith:geofenceId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse[Geofence] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.GeoFencingApi()
var geofenceId = 56; // {Integer} The ID of the geofence you want to obtain
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class geoFencingGetGeofenceByIdExample
    {
        public void main()
        {
            
            var apiInstance = new GeoFencingApi();
            var geofenceId = 56;  // Integer | The ID of the geofence you want to obtain (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a geofence by ID
Requires the 'SubmitTimesheets' permission.
                ApiResponse[Geofence] result = apiInstance.geoFencingGetGeofenceById(geofenceId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeoFencingApi.geoFencingGetGeofenceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\GeoFencingApi();
$geofenceId = 56; // Integer | The ID of the geofence you want to obtain
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->geoFencingGetGeofenceById($geofenceId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoFencingApi->geoFencingGetGeofenceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::GeoFencingApi;

my $api_instance = ChronoSheetsAPI::GeoFencingApi->new();
my $geofenceId = 56; # Integer | The ID of the geofence you want to obtain
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->geoFencingGetGeofenceById(geofenceId => $geofenceId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeoFencingApi->geoFencingGetGeofenceById: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.GeoFencingApi()
geofenceId = 56 # Integer | The ID of the geofence you want to obtain (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a geofence by ID
Requires the 'SubmitTimesheets' permission.
    api_response = api_instance.geo_fencing_get_geofence_by_id(geofenceId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoFencingApi->geoFencingGetGeofenceById: %s\n" % e)
extern crate GeoFencingApi;

pub fn main() {
    let geofenceId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = GeoFencingApi::Context::default();
    let result = client.geoFencingGetGeofenceById(geofenceId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
GeofenceId*
Integer (int32)
The ID of the geofence you want to obtain
Required

Responses


geoFencingGetGeofences

Get geofences belonging to your organisation Requires the 'SubmitTimesheets' permission.


/GeoFencing/GetGeofences

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/GeoFencing/GetGeofences?Skip=&Take="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoFencingApi;

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

public class GeoFencingApiExample {

    public static void main(String[] args) {
        
        GeoFencingApi apiInstance = new GeoFencingApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        Integer skip = 56; // Integer | Number of records to skip
        Integer take = 56; // Integer | Number of records to take
        try {
            ApiResponseForPaginated[List[ExtendedGeofence]] result = apiInstance.geoFencingGetGeofences(xChronosheetsAuth, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingGetGeofences");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GeoFencingApi;

public class GeoFencingApiExample {

    public static void main(String[] args) {
        GeoFencingApi apiInstance = new GeoFencingApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        Integer skip = 56; // Integer | Number of records to skip
        Integer take = 56; // Integer | Number of records to take
        try {
            ApiResponseForPaginated[List[ExtendedGeofence]] result = apiInstance.geoFencingGetGeofences(xChronosheetsAuth, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingGetGeofences");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
Integer *skip = 56; // Number of records to skip (optional) (default to null)
Integer *take = 56; // Number of records to take (optional) (default to null)

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

// Get geofences belonging to your organisation
Requires the 'SubmitTimesheets' permission.
[apiInstance geoFencingGetGeofencesWith:xChronosheetsAuth
    skip:skip
    take:take
              completionHandler: ^(ApiResponseForPaginated[List[ExtendedGeofence]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.GeoFencingApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var opts = {
  'skip': 56, // {Integer} Number of records to skip
  'take': 56 // {Integer} Number of records to take
};

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

namespace Example
{
    public class geoFencingGetGeofencesExample
    {
        public void main()
        {
            
            var apiInstance = new GeoFencingApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var skip = 56;  // Integer | Number of records to skip (optional)  (default to null)
            var take = 56;  // Integer | Number of records to take (optional)  (default to null)

            try
            {
                // Get geofences belonging to your organisation
Requires the 'SubmitTimesheets' permission.
                ApiResponseForPaginated[List[ExtendedGeofence]] result = apiInstance.geoFencingGetGeofences(xChronosheetsAuth, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeoFencingApi.geoFencingGetGeofences: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\GeoFencingApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$skip = 56; // Integer | Number of records to skip
$take = 56; // Integer | Number of records to take

try {
    $result = $api_instance->geoFencingGetGeofences($xChronosheetsAuth, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoFencingApi->geoFencingGetGeofences: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::GeoFencingApi;

my $api_instance = ChronoSheetsAPI::GeoFencingApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $skip = 56; # Integer | Number of records to skip
my $take = 56; # Integer | Number of records to take

eval { 
    my $result = $api_instance->geoFencingGetGeofences(xChronosheetsAuth => $xChronosheetsAuth, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeoFencingApi->geoFencingGetGeofences: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.GeoFencingApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
skip = 56 # Integer | Number of records to skip (optional) (default to null)
take = 56 # Integer | Number of records to take (optional) (default to null)

try: 
    # Get geofences belonging to your organisation
Requires the 'SubmitTimesheets' permission.
    api_response = api_instance.geo_fencing_get_geofences(xChronosheetsAuth, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoFencingApi->geoFencingGetGeofences: %s\n" % e)
extern crate GeoFencingApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let skip = 56; // Integer
    let take = 56; // Integer

    let mut context = GeoFencingApi::Context::default();
    let result = client.geoFencingGetGeofences(xChronosheetsAuth, skip, take, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
Skip
Integer (int32)
Number of records to skip
Take
Integer (int32)
Number of records to take

Responses


geoFencingGetGeofencesBasicInfo

Gets a list of all geofences in your organisation, including just the name and ID.


/GeoFencing/GetGeofencesBasicInfo

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/GeoFencing/GetGeofencesBasicInfo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoFencingApi;

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

public class GeoFencingApiExample {

    public static void main(String[] args) {
        
        GeoFencingApi apiInstance = new GeoFencingApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponseForPaginated[List[BasicGeofence]] result = apiInstance.geoFencingGetGeofencesBasicInfo(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingGetGeofencesBasicInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GeoFencingApi;

public class GeoFencingApiExample {

    public static void main(String[] args) {
        GeoFencingApi apiInstance = new GeoFencingApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponseForPaginated[List[BasicGeofence]] result = apiInstance.geoFencingGetGeofencesBasicInfo(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingGetGeofencesBasicInfo");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Gets a list of all geofences in your organisation, including just the name and ID.
[apiInstance geoFencingGetGeofencesBasicInfoWith:xChronosheetsAuth
              completionHandler: ^(ApiResponseForPaginated[List[BasicGeofence]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.GeoFencingApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class geoFencingGetGeofencesBasicInfoExample
    {
        public void main()
        {
            
            var apiInstance = new GeoFencingApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Gets a list of all geofences in your organisation, including just the name and ID.
                ApiResponseForPaginated[List[BasicGeofence]] result = apiInstance.geoFencingGetGeofencesBasicInfo(xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeoFencingApi.geoFencingGetGeofencesBasicInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\GeoFencingApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->geoFencingGetGeofencesBasicInfo($xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoFencingApi->geoFencingGetGeofencesBasicInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::GeoFencingApi;

my $api_instance = ChronoSheetsAPI::GeoFencingApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

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

# create an instance of the API class
api_instance = ChronoSheetsAPI.GeoFencingApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Gets a list of all geofences in your organisation, including just the name and ID.
    api_response = api_instance.geo_fencing_get_geofences_basic_info(xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoFencingApi->geoFencingGetGeofencesBasicInfo: %s\n" % e)
extern crate GeoFencingApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = GeoFencingApi::Context::default();
    let result = client.geoFencingGetGeofencesBasicInfo(xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required

Responses


geoFencingUpdateGeofence

Updates a geofencing with rules to be used for clock on/off automation. Requires the 'ManageGeofencing' permission.


/GeoFencing/UpdateGeofence

Usage and SDK Samples

curl -X PUT "https://api.chronosheets.com/GeoFencing/UpdateGeofence"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoFencingApi;

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

public class GeoFencingApiExample {

    public static void main(String[] args) {
        
        GeoFencingApi apiInstance = new GeoFencingApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        UpdateGeoFenceRequest request = ; // UpdateGeoFenceRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.geoFencingUpdateGeofence(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingUpdateGeofence");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.GeoFencingApi;

public class GeoFencingApiExample {

    public static void main(String[] args) {
        GeoFencingApi apiInstance = new GeoFencingApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        UpdateGeoFenceRequest request = ; // UpdateGeoFenceRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.geoFencingUpdateGeofence(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoFencingApi#geoFencingUpdateGeofence");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
UpdateGeoFenceRequest *request = ; // 

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

// Updates a geofencing with rules to be used for clock on/off automation.
Requires the 'ManageGeofencing' permission.
[apiInstance geoFencingUpdateGeofenceWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse[Int32] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.GeoFencingApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {UpdateGeoFenceRequest} 

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

namespace Example
{
    public class geoFencingUpdateGeofenceExample
    {
        public void main()
        {
            
            var apiInstance = new GeoFencingApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new UpdateGeoFenceRequest(); // UpdateGeoFenceRequest | 

            try
            {
                // Updates a geofencing with rules to be used for clock on/off automation.
Requires the 'ManageGeofencing' permission.
                ApiResponse[Int32] result = apiInstance.geoFencingUpdateGeofence(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GeoFencingApi.geoFencingUpdateGeofence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\GeoFencingApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // UpdateGeoFenceRequest | 

try {
    $result = $api_instance->geoFencingUpdateGeofence($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeoFencingApi->geoFencingUpdateGeofence: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::GeoFencingApi;

my $api_instance = ChronoSheetsAPI::GeoFencingApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::UpdateGeoFenceRequest->new(); # UpdateGeoFenceRequest | 

eval { 
    my $result = $api_instance->geoFencingUpdateGeofence(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GeoFencingApi->geoFencingUpdateGeofence: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.GeoFencingApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # UpdateGeoFenceRequest | 

try: 
    # Updates a geofencing with rules to be used for clock on/off automation.
Requires the 'ManageGeofencing' permission.
    api_response = api_instance.geo_fencing_update_geofence(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoFencingApi->geoFencingUpdateGeofence: %s\n" % e)
extern crate GeoFencingApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // UpdateGeoFenceRequest

    let mut context = GeoFencingApi::Context::default();
    let result = client.geoFencingUpdateGeofence(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

Responses


JobCodes

jobCodesCreateJobCode

Create a job code. Requires the 'ManageJobsAndTask' permission.


/JobCodes/CreateJobCode

Usage and SDK Samples

curl -X POST "https://api.chronosheets.com/JobCodes/CreateJobCode"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobCodesApi;

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

public class JobCodesApiExample {

    public static void main(String[] args) {
        
        JobCodesApi apiInstance = new JobCodesApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        InsertJobCodeRequest request = ; // InsertJobCodeRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.jobCodesCreateJobCode(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesCreateJobCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobCodesApi;

public class JobCodesApiExample {

    public static void main(String[] args) {
        JobCodesApi apiInstance = new JobCodesApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        InsertJobCodeRequest request = ; // InsertJobCodeRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.jobCodesCreateJobCode(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesCreateJobCode");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
InsertJobCodeRequest *request = ; // 

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

// Create a job code.  
Requires the 'ManageJobsAndTask' permission.
[apiInstance jobCodesCreateJobCodeWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse[Int32] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.JobCodesApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {InsertJobCodeRequest} 

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

namespace Example
{
    public class jobCodesCreateJobCodeExample
    {
        public void main()
        {
            
            var apiInstance = new JobCodesApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new InsertJobCodeRequest(); // InsertJobCodeRequest | 

            try
            {
                // Create a job code.  
Requires the 'ManageJobsAndTask' permission.
                ApiResponse[Int32] result = apiInstance.jobCodesCreateJobCode(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobCodesApi.jobCodesCreateJobCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\JobCodesApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // InsertJobCodeRequest | 

try {
    $result = $api_instance->jobCodesCreateJobCode($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobCodesApi->jobCodesCreateJobCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::JobCodesApi;

my $api_instance = ChronoSheetsAPI::JobCodesApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::InsertJobCodeRequest->new(); # InsertJobCodeRequest | 

eval { 
    my $result = $api_instance->jobCodesCreateJobCode(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobCodesApi->jobCodesCreateJobCode: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.JobCodesApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # InsertJobCodeRequest | 

try: 
    # Create a job code.  
Requires the 'ManageJobsAndTask' permission.
    api_response = api_instance.job_codes_create_job_code(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobCodesApi->jobCodesCreateJobCode: %s\n" % e)
extern crate JobCodesApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // InsertJobCodeRequest

    let mut context = JobCodesApi::Context::default();
    let result = client.jobCodesCreateJobCode(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

An Insert JobCode Request object containing values for the new JobCode to create

Responses


jobCodesDeleteJobCode

Delete a job code. Requires the 'ManageJobsAndTask' permission.


/JobCodes/DeleteJobCode

Usage and SDK Samples

curl -X DELETE "https://api.chronosheets.com/JobCodes/DeleteJobCode?JobCodeId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobCodesApi;

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

public class JobCodesApiExample {

    public static void main(String[] args) {
        
        JobCodesApi apiInstance = new JobCodesApi();
        Integer jobCodeId = 56; // Integer | The ID of the job code you want to delete
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse['Boolean'] result = apiInstance.jobCodesDeleteJobCode(jobCodeId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesDeleteJobCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobCodesApi;

public class JobCodesApiExample {

    public static void main(String[] args) {
        JobCodesApi apiInstance = new JobCodesApi();
        Integer jobCodeId = 56; // Integer | The ID of the job code you want to delete
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse['Boolean'] result = apiInstance.jobCodesDeleteJobCode(jobCodeId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesDeleteJobCode");
            e.printStackTrace();
        }
    }
}
Integer *jobCodeId = 56; // The ID of the job code you want to delete (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Delete a job code.  
Requires the 'ManageJobsAndTask' permission.
[apiInstance jobCodesDeleteJobCodeWith:jobCodeId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse['Boolean'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.JobCodesApi()
var jobCodeId = 56; // {Integer} The ID of the job code you want to delete
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class jobCodesDeleteJobCodeExample
    {
        public void main()
        {
            
            var apiInstance = new JobCodesApi();
            var jobCodeId = 56;  // Integer | The ID of the job code you want to delete (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Delete a job code.  
Requires the 'ManageJobsAndTask' permission.
                ApiResponse['Boolean'] result = apiInstance.jobCodesDeleteJobCode(jobCodeId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobCodesApi.jobCodesDeleteJobCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\JobCodesApi();
$jobCodeId = 56; // Integer | The ID of the job code you want to delete
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->jobCodesDeleteJobCode($jobCodeId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobCodesApi->jobCodesDeleteJobCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::JobCodesApi;

my $api_instance = ChronoSheetsAPI::JobCodesApi->new();
my $jobCodeId = 56; # Integer | The ID of the job code you want to delete
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->jobCodesDeleteJobCode(jobCodeId => $jobCodeId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobCodesApi->jobCodesDeleteJobCode: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.JobCodesApi()
jobCodeId = 56 # Integer | The ID of the job code you want to delete (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Delete a job code.  
Requires the 'ManageJobsAndTask' permission.
    api_response = api_instance.job_codes_delete_job_code(jobCodeId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobCodesApi->jobCodesDeleteJobCode: %s\n" % e)
extern crate JobCodesApi;

pub fn main() {
    let jobCodeId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = JobCodesApi::Context::default();
    let result = client.jobCodesDeleteJobCode(jobCodeId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
JobCodeId*
Integer (int32)
The ID of the job code you want to delete
Required

Responses


jobCodesGetJobCodeById

Get a particular job code by job code id. Requires 'SubmitTimesheets' or 'ManageJobsAndTasks' permissions.


/JobCodes/GetJobCodeById

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/JobCodes/GetJobCodeById?JobCodeId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobCodesApi;

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

public class JobCodesApiExample {

    public static void main(String[] args) {
        
        JobCodesApi apiInstance = new JobCodesApi();
        Integer jobCodeId = 56; // Integer | The ID of the JobCode you want to get
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[JobCode] result = apiInstance.jobCodesGetJobCodeById(jobCodeId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesGetJobCodeById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobCodesApi;

public class JobCodesApiExample {

    public static void main(String[] args) {
        JobCodesApi apiInstance = new JobCodesApi();
        Integer jobCodeId = 56; // Integer | The ID of the JobCode you want to get
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[JobCode] result = apiInstance.jobCodesGetJobCodeById(jobCodeId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesGetJobCodeById");
            e.printStackTrace();
        }
    }
}
Integer *jobCodeId = 56; // The ID of the JobCode you want to get (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a particular job code by job code id.  
Requires 'SubmitTimesheets' or 'ManageJobsAndTasks' permissions.
[apiInstance jobCodesGetJobCodeByIdWith:jobCodeId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse[JobCode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.JobCodesApi()
var jobCodeId = 56; // {Integer} The ID of the JobCode you want to get
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class jobCodesGetJobCodeByIdExample
    {
        public void main()
        {
            
            var apiInstance = new JobCodesApi();
            var jobCodeId = 56;  // Integer | The ID of the JobCode you want to get (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a particular job code by job code id.  
Requires 'SubmitTimesheets' or 'ManageJobsAndTasks' permissions.
                ApiResponse[JobCode] result = apiInstance.jobCodesGetJobCodeById(jobCodeId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobCodesApi.jobCodesGetJobCodeById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\JobCodesApi();
$jobCodeId = 56; // Integer | The ID of the JobCode you want to get
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->jobCodesGetJobCodeById($jobCodeId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobCodesApi->jobCodesGetJobCodeById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::JobCodesApi;

my $api_instance = ChronoSheetsAPI::JobCodesApi->new();
my $jobCodeId = 56; # Integer | The ID of the JobCode you want to get
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->jobCodesGetJobCodeById(jobCodeId => $jobCodeId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobCodesApi->jobCodesGetJobCodeById: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.JobCodesApi()
jobCodeId = 56 # Integer | The ID of the JobCode you want to get (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a particular job code by job code id.  
Requires 'SubmitTimesheets' or 'ManageJobsAndTasks' permissions.
    api_response = api_instance.job_codes_get_job_code_by_id(jobCodeId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobCodesApi->jobCodesGetJobCodeById: %s\n" % e)
extern crate JobCodesApi;

pub fn main() {
    let jobCodeId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = JobCodesApi::Context::default();
    let result = client.jobCodesGetJobCodeById(jobCodeId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
JobCodeId*
Integer (int32)
The ID of the JobCode you want to get
Required

Responses


jobCodesGetJobCodes

Get job codes for your organisation. Requires 'SubmitTimesheets' or 'ManageJobsAndTasks' permissions.


/JobCodes/GetJobCodes

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/JobCodes/GetJobCodes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobCodesApi;

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

public class JobCodesApiExample {

    public static void main(String[] args) {
        
        JobCodesApi apiInstance = new JobCodesApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[JobCode]] result = apiInstance.jobCodesGetJobCodes(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesGetJobCodes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobCodesApi;

public class JobCodesApiExample {

    public static void main(String[] args) {
        JobCodesApi apiInstance = new JobCodesApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[JobCode]] result = apiInstance.jobCodesGetJobCodes(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesGetJobCodes");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get job codes for your organisation.  
Requires 'SubmitTimesheets' or 'ManageJobsAndTasks' permissions.
[apiInstance jobCodesGetJobCodesWith:xChronosheetsAuth
              completionHandler: ^(ApiResponse[List[JobCode]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.JobCodesApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class jobCodesGetJobCodesExample
    {
        public void main()
        {
            
            var apiInstance = new JobCodesApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get job codes for your organisation.  
Requires 'SubmitTimesheets' or 'ManageJobsAndTasks' permissions.
                ApiResponse[List[JobCode]] result = apiInstance.jobCodesGetJobCodes(xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobCodesApi.jobCodesGetJobCodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\JobCodesApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->jobCodesGetJobCodes($xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobCodesApi->jobCodesGetJobCodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::JobCodesApi;

my $api_instance = ChronoSheetsAPI::JobCodesApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

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

# create an instance of the API class
api_instance = ChronoSheetsAPI.JobCodesApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get job codes for your organisation.  
Requires 'SubmitTimesheets' or 'ManageJobsAndTasks' permissions.
    api_response = api_instance.job_codes_get_job_codes(xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobCodesApi->jobCodesGetJobCodes: %s\n" % e)
extern crate JobCodesApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = JobCodesApi::Context::default();
    let result = client.jobCodesGetJobCodes(xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required

Responses


jobCodesUpdateJobCode

Update a job code. Requires the 'ManageJobsAndTask' permission.


/JobCodes/UpdateJobCode

Usage and SDK Samples

curl -X PUT "https://api.chronosheets.com/JobCodes/UpdateJobCode"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobCodesApi;

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

public class JobCodesApiExample {

    public static void main(String[] args) {
        
        JobCodesApi apiInstance = new JobCodesApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        UpdateJobCodeRequest request = ; // UpdateJobCodeRequest | 
        try {
            ApiResponse['Boolean'] result = apiInstance.jobCodesUpdateJobCode(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesUpdateJobCode");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobCodesApi;

public class JobCodesApiExample {

    public static void main(String[] args) {
        JobCodesApi apiInstance = new JobCodesApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        UpdateJobCodeRequest request = ; // UpdateJobCodeRequest | 
        try {
            ApiResponse['Boolean'] result = apiInstance.jobCodesUpdateJobCode(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobCodesApi#jobCodesUpdateJobCode");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
UpdateJobCodeRequest *request = ; // 

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

// Update a job code.  
Requires the 'ManageJobsAndTask' permission.
[apiInstance jobCodesUpdateJobCodeWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse['Boolean'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.JobCodesApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {UpdateJobCodeRequest} 

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

namespace Example
{
    public class jobCodesUpdateJobCodeExample
    {
        public void main()
        {
            
            var apiInstance = new JobCodesApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new UpdateJobCodeRequest(); // UpdateJobCodeRequest | 

            try
            {
                // Update a job code.  
Requires the 'ManageJobsAndTask' permission.
                ApiResponse['Boolean'] result = apiInstance.jobCodesUpdateJobCode(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobCodesApi.jobCodesUpdateJobCode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\JobCodesApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // UpdateJobCodeRequest | 

try {
    $result = $api_instance->jobCodesUpdateJobCode($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobCodesApi->jobCodesUpdateJobCode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::JobCodesApi;

my $api_instance = ChronoSheetsAPI::JobCodesApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::UpdateJobCodeRequest->new(); # UpdateJobCodeRequest | 

eval { 
    my $result = $api_instance->jobCodesUpdateJobCode(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobCodesApi->jobCodesUpdateJobCode: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.JobCodesApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # UpdateJobCodeRequest | 

try: 
    # Update a job code.  
Requires the 'ManageJobsAndTask' permission.
    api_response = api_instance.job_codes_update_job_code(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobCodesApi->jobCodesUpdateJobCode: %s\n" % e)
extern crate JobCodesApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // UpdateJobCodeRequest

    let mut context = JobCodesApi::Context::default();
    let result = client.jobCodesUpdateJobCode(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

A Update JobCode Request object containing updated fields. Make sure to specify the JobCode Id in the request object so that ChronoSheets knows which JobCode to update

Responses


Organisation

organisationGetOrganisation

Get your organisation. Requires 'OrganisationAdmin' permission.


/Organisation/GetOrganisation

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/Organisation/GetOrganisation"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganisationApi;

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

public class OrganisationApiExample {

    public static void main(String[] args) {
        
        OrganisationApi apiInstance = new OrganisationApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[Organisation] result = apiInstance.organisationGetOrganisation(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationApi#organisationGetOrganisation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganisationApi;

public class OrganisationApiExample {

    public static void main(String[] args) {
        OrganisationApi apiInstance = new OrganisationApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[Organisation] result = apiInstance.organisationGetOrganisation(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationApi#organisationGetOrganisation");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get your organisation.  
Requires 'OrganisationAdmin' permission.
[apiInstance organisationGetOrganisationWith:xChronosheetsAuth
              completionHandler: ^(ApiResponse[Organisation] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.OrganisationApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class organisationGetOrganisationExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get your organisation.  
Requires 'OrganisationAdmin' permission.
                ApiResponse[Organisation] result = apiInstance.organisationGetOrganisation(xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationApi.organisationGetOrganisation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\OrganisationApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->organisationGetOrganisation($xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationApi->organisationGetOrganisation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::OrganisationApi;

my $api_instance = ChronoSheetsAPI::OrganisationApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

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

# create an instance of the API class
api_instance = ChronoSheetsAPI.OrganisationApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get your organisation.  
Requires 'OrganisationAdmin' permission.
    api_response = api_instance.organisation_get_organisation(xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganisationApi->organisationGetOrganisation: %s\n" % e)
extern crate OrganisationApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = OrganisationApi::Context::default();
    let result = client.organisationGetOrganisation(xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required

Responses


organisationUpdateOrganisation

Update an organisation. Requires 'OrganisationAdmin' permission.


/Organisation/UpdateOrganisation

Usage and SDK Samples

curl -X PUT "https://api.chronosheets.com/Organisation/UpdateOrganisation"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganisationApi;

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

public class OrganisationApiExample {

    public static void main(String[] args) {
        
        OrganisationApi apiInstance = new OrganisationApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        UpdateOrganisationRequest request = ; // UpdateOrganisationRequest | 
        try {
            ApiResponse[UpdateOrganisationResponse] result = apiInstance.organisationUpdateOrganisation(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationApi#organisationUpdateOrganisation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganisationApi;

public class OrganisationApiExample {

    public static void main(String[] args) {
        OrganisationApi apiInstance = new OrganisationApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        UpdateOrganisationRequest request = ; // UpdateOrganisationRequest | 
        try {
            ApiResponse[UpdateOrganisationResponse] result = apiInstance.organisationUpdateOrganisation(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationApi#organisationUpdateOrganisation");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
UpdateOrganisationRequest *request = ; // 

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

// Update an organisation.  
Requires 'OrganisationAdmin' permission.
[apiInstance organisationUpdateOrganisationWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse[UpdateOrganisationResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.OrganisationApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {UpdateOrganisationRequest} 

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

namespace Example
{
    public class organisationUpdateOrganisationExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new UpdateOrganisationRequest(); // UpdateOrganisationRequest | 

            try
            {
                // Update an organisation.  
Requires 'OrganisationAdmin' permission.
                ApiResponse[UpdateOrganisationResponse] result = apiInstance.organisationUpdateOrganisation(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationApi.organisationUpdateOrganisation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\OrganisationApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // UpdateOrganisationRequest | 

try {
    $result = $api_instance->organisationUpdateOrganisation($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationApi->organisationUpdateOrganisation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::OrganisationApi;

my $api_instance = ChronoSheetsAPI::OrganisationApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::UpdateOrganisationRequest->new(); # UpdateOrganisationRequest | 

eval { 
    my $result = $api_instance->organisationUpdateOrganisation(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganisationApi->organisationUpdateOrganisation: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.OrganisationApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # UpdateOrganisationRequest | 

try: 
    # Update an organisation.  
Requires 'OrganisationAdmin' permission.
    api_response = api_instance.organisation_update_organisation(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganisationApi->organisationUpdateOrganisation: %s\n" % e)
extern crate OrganisationApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // UpdateOrganisationRequest

    let mut context = OrganisationApi::Context::default();
    let result = client.organisationUpdateOrganisation(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

An Update Organsation Request object containing updated fields. Make sure to specify the Organsation Id in the request object so that ChronoSheets knows which Organsation to update

Responses


OrganisationGroupUsers

organisationGroupUsersGetOrganisationGroupUsers

Get a collection of organisation group users that belong to an organisation group. Requires the 'ManageOrganisationGroups' or 'ManageOrganisationUsers' permissions.


/OrganisationGroupUsers/GetOrganisationGroupUsers

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/OrganisationGroupUsers/GetOrganisationGroupUsers?orgGroupId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganisationGroupUsersApi;

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

public class OrganisationGroupUsersApiExample {

    public static void main(String[] args) {
        
        OrganisationGroupUsersApi apiInstance = new OrganisationGroupUsersApi();
        Integer orgGroupId = 56; // Integer | An OrganisationGroup Id
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[UserForManagement]] result = apiInstance.organisationGroupUsersGetOrganisationGroupUsers(orgGroupId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupUsersApi#organisationGroupUsersGetOrganisationGroupUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganisationGroupUsersApi;

public class OrganisationGroupUsersApiExample {

    public static void main(String[] args) {
        OrganisationGroupUsersApi apiInstance = new OrganisationGroupUsersApi();
        Integer orgGroupId = 56; // Integer | An OrganisationGroup Id
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[UserForManagement]] result = apiInstance.organisationGroupUsersGetOrganisationGroupUsers(orgGroupId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupUsersApi#organisationGroupUsersGetOrganisationGroupUsers");
            e.printStackTrace();
        }
    }
}
Integer *orgGroupId = 56; // An OrganisationGroup Id (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a collection of organisation group users that belong to an organisation group.  
Requires the 'ManageOrganisationGroups' or 'ManageOrganisationUsers' permissions.
[apiInstance organisationGroupUsersGetOrganisationGroupUsersWith:orgGroupId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse[List[UserForManagement]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.OrganisationGroupUsersApi()
var orgGroupId = 56; // {Integer} An OrganisationGroup Id
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class organisationGroupUsersGetOrganisationGroupUsersExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationGroupUsersApi();
            var orgGroupId = 56;  // Integer | An OrganisationGroup Id (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a collection of organisation group users that belong to an organisation group.  
Requires the 'ManageOrganisationGroups' or 'ManageOrganisationUsers' permissions.
                ApiResponse[List[UserForManagement]] result = apiInstance.organisationGroupUsersGetOrganisationGroupUsers(orgGroupId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationGroupUsersApi.organisationGroupUsersGetOrganisationGroupUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\OrganisationGroupUsersApi();
$orgGroupId = 56; // Integer | An OrganisationGroup Id
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->organisationGroupUsersGetOrganisationGroupUsers($orgGroupId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationGroupUsersApi->organisationGroupUsersGetOrganisationGroupUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::OrganisationGroupUsersApi;

my $api_instance = ChronoSheetsAPI::OrganisationGroupUsersApi->new();
my $orgGroupId = 56; # Integer | An OrganisationGroup Id
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->organisationGroupUsersGetOrganisationGroupUsers(orgGroupId => $orgGroupId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganisationGroupUsersApi->organisationGroupUsersGetOrganisationGroupUsers: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.OrganisationGroupUsersApi()
orgGroupId = 56 # Integer | An OrganisationGroup Id (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a collection of organisation group users that belong to an organisation group.  
Requires the 'ManageOrganisationGroups' or 'ManageOrganisationUsers' permissions.
    api_response = api_instance.organisation_group_users_get_organisation_group_users(orgGroupId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganisationGroupUsersApi->organisationGroupUsersGetOrganisationGroupUsers: %s\n" % e)
extern crate OrganisationGroupUsersApi;

pub fn main() {
    let orgGroupId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = OrganisationGroupUsersApi::Context::default();
    let result = client.organisationGroupUsersGetOrganisationGroupUsers(orgGroupId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
orgGroupId*
Integer (int32)
An OrganisationGroup Id
Required

Responses


organisationGroupUsersUpdateOrganisationGroupUsers

Set the users who belong to an organisation group. Requires the 'ManageOrganisationGroups' permissions.


/OrganisationGroupUsers/UpdateOrganisationGroupUsers

Usage and SDK Samples

curl -X PUT "https://api.chronosheets.com/OrganisationGroupUsers/UpdateOrganisationGroupUsers"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganisationGroupUsersApi;

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

public class OrganisationGroupUsersApiExample {

    public static void main(String[] args) {
        
        OrganisationGroupUsersApi apiInstance = new OrganisationGroupUsersApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        SetOrganisationGroupUsersRequest request = ; // SetOrganisationGroupUsersRequest | 
        try {
            ApiResponse['Boolean'] result = apiInstance.organisationGroupUsersUpdateOrganisationGroupUsers(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupUsersApi#organisationGroupUsersUpdateOrganisationGroupUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganisationGroupUsersApi;

public class OrganisationGroupUsersApiExample {

    public static void main(String[] args) {
        OrganisationGroupUsersApi apiInstance = new OrganisationGroupUsersApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        SetOrganisationGroupUsersRequest request = ; // SetOrganisationGroupUsersRequest | 
        try {
            ApiResponse['Boolean'] result = apiInstance.organisationGroupUsersUpdateOrganisationGroupUsers(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupUsersApi#organisationGroupUsersUpdateOrganisationGroupUsers");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
SetOrganisationGroupUsersRequest *request = ; // 

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

// Set the users who belong to an organisation group.  
Requires the 'ManageOrganisationGroups' permissions.
[apiInstance organisationGroupUsersUpdateOrganisationGroupUsersWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse['Boolean'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.OrganisationGroupUsersApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {SetOrganisationGroupUsersRequest} 

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

namespace Example
{
    public class organisationGroupUsersUpdateOrganisationGroupUsersExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationGroupUsersApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new SetOrganisationGroupUsersRequest(); // SetOrganisationGroupUsersRequest | 

            try
            {
                // Set the users who belong to an organisation group.  
Requires the 'ManageOrganisationGroups' permissions.
                ApiResponse['Boolean'] result = apiInstance.organisationGroupUsersUpdateOrganisationGroupUsers(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationGroupUsersApi.organisationGroupUsersUpdateOrganisationGroupUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\OrganisationGroupUsersApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // SetOrganisationGroupUsersRequest | 

try {
    $result = $api_instance->organisationGroupUsersUpdateOrganisationGroupUsers($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationGroupUsersApi->organisationGroupUsersUpdateOrganisationGroupUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::OrganisationGroupUsersApi;

my $api_instance = ChronoSheetsAPI::OrganisationGroupUsersApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::SetOrganisationGroupUsersRequest->new(); # SetOrganisationGroupUsersRequest | 

eval { 
    my $result = $api_instance->organisationGroupUsersUpdateOrganisationGroupUsers(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganisationGroupUsersApi->organisationGroupUsersUpdateOrganisationGroupUsers: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.OrganisationGroupUsersApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # SetOrganisationGroupUsersRequest | 

try: 
    # Set the users who belong to an organisation group.  
Requires the 'ManageOrganisationGroups' permissions.
    api_response = api_instance.organisation_group_users_update_organisation_group_users(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganisationGroupUsersApi->organisationGroupUsersUpdateOrganisationGroupUsers: %s\n" % e)
extern crate OrganisationGroupUsersApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // SetOrganisationGroupUsersRequest

    let mut context = OrganisationGroupUsersApi::Context::default();
    let result = client.organisationGroupUsersUpdateOrganisationGroupUsers(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

A request object specifying which users belong to an organisation group. Make sure to specify the OrganisationGroup Id in the request object so that ChronoSheets knows which OrganisationGroup to update. CsvUserIds is a comma separated list of User Ids, e.g. 1,2,3,4

Responses


OrganisationGroups

organisationGroupsCreateOrganisationGroup

Create an organisation group. Requires the 'ManageOrganisationGroups' permissions.


/OrganisationGroups/CreateOrganisationGroup

Usage and SDK Samples

curl -X POST "https://api.chronosheets.com/OrganisationGroups/CreateOrganisationGroup"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganisationGroupsApi;

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

public class OrganisationGroupsApiExample {

    public static void main(String[] args) {
        
        OrganisationGroupsApi apiInstance = new OrganisationGroupsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        InsertOrganisationGroupRequest request = ; // InsertOrganisationGroupRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.organisationGroupsCreateOrganisationGroup(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupsApi#organisationGroupsCreateOrganisationGroup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganisationGroupsApi;

public class OrganisationGroupsApiExample {

    public static void main(String[] args) {
        OrganisationGroupsApi apiInstance = new OrganisationGroupsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        InsertOrganisationGroupRequest request = ; // InsertOrganisationGroupRequest | 
        try {
            ApiResponse[Int32] result = apiInstance.organisationGroupsCreateOrganisationGroup(xChronosheetsAuth, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupsApi#organisationGroupsCreateOrganisationGroup");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)
InsertOrganisationGroupRequest *request = ; // 

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

// Create an organisation group.  
Requires the 'ManageOrganisationGroups' permissions.
[apiInstance organisationGroupsCreateOrganisationGroupWith:xChronosheetsAuth
    request:request
              completionHandler: ^(ApiResponse[Int32] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.OrganisationGroupsApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token
var request = ; // {InsertOrganisationGroupRequest} 

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

namespace Example
{
    public class organisationGroupsCreateOrganisationGroupExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationGroupsApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)
            var request = new InsertOrganisationGroupRequest(); // InsertOrganisationGroupRequest | 

            try
            {
                // Create an organisation group.  
Requires the 'ManageOrganisationGroups' permissions.
                ApiResponse[Int32] result = apiInstance.organisationGroupsCreateOrganisationGroup(xChronosheetsAuth, request);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationGroupsApi.organisationGroupsCreateOrganisationGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\OrganisationGroupsApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
$request = ; // InsertOrganisationGroupRequest | 

try {
    $result = $api_instance->organisationGroupsCreateOrganisationGroup($xChronosheetsAuth, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationGroupsApi->organisationGroupsCreateOrganisationGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::OrganisationGroupsApi;

my $api_instance = ChronoSheetsAPI::OrganisationGroupsApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token
my $request = ChronoSheetsAPI::Object::InsertOrganisationGroupRequest->new(); # InsertOrganisationGroupRequest | 

eval { 
    my $result = $api_instance->organisationGroupsCreateOrganisationGroup(xChronosheetsAuth => $xChronosheetsAuth, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganisationGroupsApi->organisationGroupsCreateOrganisationGroup: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.OrganisationGroupsApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)
request =  # InsertOrganisationGroupRequest | 

try: 
    # Create an organisation group.  
Requires the 'ManageOrganisationGroups' permissions.
    api_response = api_instance.organisation_groups_create_organisation_group(xChronosheetsAuth, request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganisationGroupsApi->organisationGroupsCreateOrganisationGroup: %s\n" % e)
extern crate OrganisationGroupsApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String
    let request = ; // InsertOrganisationGroupRequest

    let mut context = OrganisationGroupsApi::Context::default();
    let result = client.organisationGroupsCreateOrganisationGroup(xChronosheetsAuth, request, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Body parameters
Name Description
request *

An Insert OrganisationGroup Request object containing values for the new OrganisationGroup to create

Responses


organisationGroupsDeleteOrganisationGroup


/OrganisationGroups/DeleteOrganisationGroup

Usage and SDK Samples

curl -X DELETE "https://api.chronosheets.com/OrganisationGroups/DeleteOrganisationGroup?OrganisationGroupId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganisationGroupsApi;

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

public class OrganisationGroupsApiExample {

    public static void main(String[] args) {
        
        OrganisationGroupsApi apiInstance = new OrganisationGroupsApi();
        Integer organisationGroupId = 56; // Integer | 
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse['Boolean'] result = apiInstance.organisationGroupsDeleteOrganisationGroup(organisationGroupId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupsApi#organisationGroupsDeleteOrganisationGroup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganisationGroupsApi;

public class OrganisationGroupsApiExample {

    public static void main(String[] args) {
        OrganisationGroupsApi apiInstance = new OrganisationGroupsApi();
        Integer organisationGroupId = 56; // Integer | 
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse['Boolean'] result = apiInstance.organisationGroupsDeleteOrganisationGroup(organisationGroupId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupsApi#organisationGroupsDeleteOrganisationGroup");
            e.printStackTrace();
        }
    }
}
Integer *organisationGroupId = 56; //  (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

[apiInstance organisationGroupsDeleteOrganisationGroupWith:organisationGroupId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse['Boolean'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.OrganisationGroupsApi()
var organisationGroupId = 56; // {Integer} 
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class organisationGroupsDeleteOrganisationGroupExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationGroupsApi();
            var organisationGroupId = 56;  // Integer |  (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                ApiResponse['Boolean'] result = apiInstance.organisationGroupsDeleteOrganisationGroup(organisationGroupId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationGroupsApi.organisationGroupsDeleteOrganisationGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\OrganisationGroupsApi();
$organisationGroupId = 56; // Integer | 
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->organisationGroupsDeleteOrganisationGroup($organisationGroupId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationGroupsApi->organisationGroupsDeleteOrganisationGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::OrganisationGroupsApi;

my $api_instance = ChronoSheetsAPI::OrganisationGroupsApi->new();
my $organisationGroupId = 56; # Integer | 
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->organisationGroupsDeleteOrganisationGroup(organisationGroupId => $organisationGroupId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganisationGroupsApi->organisationGroupsDeleteOrganisationGroup: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.OrganisationGroupsApi()
organisationGroupId = 56 # Integer |  (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    api_response = api_instance.organisation_groups_delete_organisation_group(organisationGroupId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganisationGroupsApi->organisationGroupsDeleteOrganisationGroup: %s\n" % e)
extern crate OrganisationGroupsApi;

pub fn main() {
    let organisationGroupId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = OrganisationGroupsApi::Context::default();
    let result = client.organisationGroupsDeleteOrganisationGroup(organisationGroupId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
OrganisationGroupId*
Integer (int32)
Required

Responses


organisationGroupsGetOrganisationGroup

Get a particular organisation group. Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.


/OrganisationGroups/GetOrganisationGroup

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/OrganisationGroups/GetOrganisationGroup?OrganisationGroupId="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganisationGroupsApi;

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

public class OrganisationGroupsApiExample {

    public static void main(String[] args) {
        
        OrganisationGroupsApi apiInstance = new OrganisationGroupsApi();
        Integer organisationGroupId = 56; // Integer | The ID of the OrganisationGroup you want to get
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[OrganisationGroup] result = apiInstance.organisationGroupsGetOrganisationGroup(organisationGroupId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupsApi#organisationGroupsGetOrganisationGroup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganisationGroupsApi;

public class OrganisationGroupsApiExample {

    public static void main(String[] args) {
        OrganisationGroupsApi apiInstance = new OrganisationGroupsApi();
        Integer organisationGroupId = 56; // Integer | The ID of the OrganisationGroup you want to get
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[OrganisationGroup] result = apiInstance.organisationGroupsGetOrganisationGroup(organisationGroupId, xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupsApi#organisationGroupsGetOrganisationGroup");
            e.printStackTrace();
        }
    }
}
Integer *organisationGroupId = 56; // The ID of the OrganisationGroup you want to get (default to null)
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a particular organisation group.  
Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.
[apiInstance organisationGroupsGetOrganisationGroupWith:organisationGroupId
    xChronosheetsAuth:xChronosheetsAuth
              completionHandler: ^(ApiResponse[OrganisationGroup] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.OrganisationGroupsApi()
var organisationGroupId = 56; // {Integer} The ID of the OrganisationGroup you want to get
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class organisationGroupsGetOrganisationGroupExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationGroupsApi();
            var organisationGroupId = 56;  // Integer | The ID of the OrganisationGroup you want to get (default to null)
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a particular organisation group.  
Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.
                ApiResponse[OrganisationGroup] result = apiInstance.organisationGroupsGetOrganisationGroup(organisationGroupId, xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationGroupsApi.organisationGroupsGetOrganisationGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\OrganisationGroupsApi();
$organisationGroupId = 56; // Integer | The ID of the OrganisationGroup you want to get
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->organisationGroupsGetOrganisationGroup($organisationGroupId, $xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationGroupsApi->organisationGroupsGetOrganisationGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::OrganisationGroupsApi;

my $api_instance = ChronoSheetsAPI::OrganisationGroupsApi->new();
my $organisationGroupId = 56; # Integer | The ID of the OrganisationGroup you want to get
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

eval { 
    my $result = $api_instance->organisationGroupsGetOrganisationGroup(organisationGroupId => $organisationGroupId, xChronosheetsAuth => $xChronosheetsAuth);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganisationGroupsApi->organisationGroupsGetOrganisationGroup: $@\n";
}
from __future__ import print_statement
import time
import ChronoSheetsAPI
from ChronoSheetsAPI.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ChronoSheetsAPI.OrganisationGroupsApi()
organisationGroupId = 56 # Integer | The ID of the OrganisationGroup you want to get (default to null)
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a particular organisation group.  
Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.
    api_response = api_instance.organisation_groups_get_organisation_group(organisationGroupId, xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganisationGroupsApi->organisationGroupsGetOrganisationGroup: %s\n" % e)
extern crate OrganisationGroupsApi;

pub fn main() {
    let organisationGroupId = 56; // Integer
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = OrganisationGroupsApi::Context::default();
    let result = client.organisationGroupsGetOrganisationGroup(organisationGroupId, xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required
Query parameters
Name Description
OrganisationGroupId*
Integer (int32)
The ID of the OrganisationGroup you want to get
Required

Responses


organisationGroupsGetOrganisationGroups

Get a collection of organisation groups that are under your organisation. Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.


/OrganisationGroups/GetOrganisationGroups

Usage and SDK Samples

curl -X GET "https://api.chronosheets.com/OrganisationGroups/GetOrganisationGroups"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OrganisationGroupsApi;

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

public class OrganisationGroupsApiExample {

    public static void main(String[] args) {
        
        OrganisationGroupsApi apiInstance = new OrganisationGroupsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[OrganisationGroup]] result = apiInstance.organisationGroupsGetOrganisationGroups(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupsApi#organisationGroupsGetOrganisationGroups");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OrganisationGroupsApi;

public class OrganisationGroupsApiExample {

    public static void main(String[] args) {
        OrganisationGroupsApi apiInstance = new OrganisationGroupsApi();
        String xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token
        try {
            ApiResponse[List[OrganisationGroup]] result = apiInstance.organisationGroupsGetOrganisationGroups(xChronosheetsAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganisationGroupsApi#organisationGroupsGetOrganisationGroups");
            e.printStackTrace();
        }
    }
}
String *xChronosheetsAuth = xChronosheetsAuth_example; // The ChronoSheets Auth Token (default to null)

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

// Get a collection of organisation groups that are under your organisation.  
Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.
[apiInstance organisationGroupsGetOrganisationGroupsWith:xChronosheetsAuth
              completionHandler: ^(ApiResponse[List[OrganisationGroup]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ChronoSheetsApi = require('chrono_sheets_api');

var api = new ChronoSheetsApi.OrganisationGroupsApi()
var xChronosheetsAuth = xChronosheetsAuth_example; // {String} The ChronoSheets Auth Token

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

namespace Example
{
    public class organisationGroupsGetOrganisationGroupsExample
    {
        public void main()
        {
            
            var apiInstance = new OrganisationGroupsApi();
            var xChronosheetsAuth = xChronosheetsAuth_example;  // String | The ChronoSheets Auth Token (default to null)

            try
            {
                // Get a collection of organisation groups that are under your organisation.  
Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.
                ApiResponse[List[OrganisationGroup]] result = apiInstance.organisationGroupsGetOrganisationGroups(xChronosheetsAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganisationGroupsApi.organisationGroupsGetOrganisationGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\OrganisationGroupsApi();
$xChronosheetsAuth = xChronosheetsAuth_example; // String | The ChronoSheets Auth Token

try {
    $result = $api_instance->organisationGroupsGetOrganisationGroups($xChronosheetsAuth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationGroupsApi->organisationGroupsGetOrganisationGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ChronoSheetsAPI::Configuration;
use ChronoSheetsAPI::OrganisationGroupsApi;

my $api_instance = ChronoSheetsAPI::OrganisationGroupsApi->new();
my $xChronosheetsAuth = xChronosheetsAuth_example; # String | The ChronoSheets Auth Token

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

# create an instance of the API class
api_instance = ChronoSheetsAPI.OrganisationGroupsApi()
xChronosheetsAuth = xChronosheetsAuth_example # String | The ChronoSheets Auth Token (default to null)

try: 
    # Get a collection of organisation groups that are under your organisation.  
Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.
    api_response = api_instance.organisation_groups_get_organisation_groups(xChronosheetsAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganisationGroupsApi->organisationGroupsGetOrganisationGroups: %s\n" % e)
extern crate OrganisationGroupsApi;

pub fn main() {
    let xChronosheetsAuth = xChronosheetsAuth_example; // String

    let mut context = OrganisationGroupsApi::Context::default();
    let result = client.organisationGroupsGetOrganisationGroups(xChronosheetsAuth, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Header parameters
Name Description
x-chronosheets-auth*
String
The ChronoSheets Auth Token
Required

Responses


organisationGroupsGetOrganisationGroupsForJob

Get org groups for a particular job. Requires the 'ManageOrganisationGroups', 'ManageJobsAndTask', 'ManageClientsAndProjects' or 'ManageOrganisationUsers' permissions.


/OrganisationGroups/GetOrganisationGroupsForJob

Usage and SDK Samples