StaffSavvy REST API

Absences

getAbsence

Retrieve an individual absence item

Retrieve an individual absence item


/absences/{absenceid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/absences/{absenceid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AbsencesApi;

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

public class AbsencesApiExample {

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


        AbsencesApi apiInstance = new AbsencesApi();
        Integer absenceid = 56; // Integer | individual absence id
        try {
            inline_response_200_3 result = apiInstance.getAbsence(absenceid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AbsencesApi#getAbsence");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AbsencesApi;

public class AbsencesApiExample {

    public static void main(String[] args) {
        AbsencesApi apiInstance = new AbsencesApi();
        Integer absenceid = 56; // Integer | individual absence id
        try {
            inline_response_200_3 result = apiInstance.getAbsence(absenceid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AbsencesApi#getAbsence");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *absenceid = 56; // individual absence id

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

// Retrieve an individual absence item
[apiInstance getAbsenceWith:absenceid
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AbsencesApi()
var absenceid = 56; // {{Integer}} individual absence id

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

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


            var apiInstance = new AbsencesApi();
            var absenceid = 56;  // Integer | individual absence id

            try
            {
                // Retrieve an individual absence item
                inline_response_200_3 result = apiInstance.getAbsence(absenceid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AbsencesApi.getAbsence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAbsencesApi();
$absenceid = 56; // Integer | individual absence id

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


my $api_instance = WWW::SwaggerClient::AbsencesApi->new();
my $absenceid = 56; # Integer | individual absence id

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


# create an instance of the API class
api_instance = swagger_client.AbsencesApi()
absenceid = 56 # Integer | individual absence id

try: 
    # Retrieve an individual absence item
    api_response = api_instance.get_absence(absenceid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AbsencesApi->getAbsence: %s\n" % e)

Parameters

Path parameters
Name Description
absenceid*
Integer
individual absence id
Required

Responses

Status: 200 - Individual absence record

Status: 400 - bad input parameter


getAbsenceHelp

Retrieves a list of absence help actions

Retrieves a list of absence help actions


/absences/help

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/absences/help"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AbsencesApi;

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

public class AbsencesApiExample {

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


        AbsencesApi apiInstance = new AbsencesApi();
        try {
            inline_response_200_3 result = apiInstance.getAbsenceHelp();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AbsencesApi#getAbsenceHelp");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AbsencesApi;

public class AbsencesApiExample {

    public static void main(String[] args) {
        AbsencesApi apiInstance = new AbsencesApi();
        try {
            inline_response_200_3 result = apiInstance.getAbsenceHelp();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AbsencesApi#getAbsenceHelp");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

// Retrieves a list of absence help actions
[apiInstance getAbsenceHelpWithCompletionHandler: 
              ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


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

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


            var apiInstance = new AbsencesApi();

            try
            {
                // Retrieves a list of absence help actions
                inline_response_200_3 result = apiInstance.getAbsenceHelp();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AbsencesApi.getAbsenceHelp: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


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

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


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

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


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

try: 
    # Retrieves a list of absence help actions
    api_response = api_instance.get_absence_help()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AbsencesApi->getAbsenceHelp: %s\n" % e)

Parameters

Responses

Status: 200 - All absences

Status: 401 - Unauthorised


getAbsences

Retrieves a list of all absences

Retrieves a list of all absences that are available to your user


/absences

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/absences?filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AbsencesApi;

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

public class AbsencesApiExample {

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


        AbsencesApi apiInstance = new AbsencesApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are 

Equals, account=10
Does not equal, type=not:-11
Greater than, start=gt:2025-01-01
Less than, start=start:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2025-12-31]
One of the options (value in list), type=[10,11,15,20]

try { inline_response_200_3 result = apiInstance.getAbsences(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AbsencesApi#getAbsences"); e.printStackTrace(); } } }
import io.swagger.client.api.AbsencesApi;

public class AbsencesApiExample {

    public static void main(String[] args) {
        AbsencesApi apiInstance = new AbsencesApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are 

Equals, account=10
Does not equal, type=not:-11
Greater than, start=gt:2025-01-01
Less than, start=start:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2025-12-31]
One of the options (value in list), type=[10,11,15,20]

try { inline_response_200_3 result = apiInstance.getAbsences(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AbsencesApi#getAbsences"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *filters = filters_example; // filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are 

Equals, account=10
Does not equal, type=not:-11
Greater than, start=gt:2025-01-01
Less than, start=start:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2025-12-31]
One of the options (value in list), type=[10,11,15,20]

(optional) AbsencesApi *apiInstance = [[AbsencesApi alloc] init]; // Retrieves a list of all absences [apiInstance getAbsencesWith:filters completionHandler: ^(inline_response_200_3 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AbsencesApi()
var opts = { 
  'filters': filters_example // {{String}} filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are 

Equals, account=10
Does not equal, type=not:-11
Greater than, start=gt:2025-01-01
Less than, start=start:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2025-12-31]
One of the options (value in list), type=[10,11,15,20]

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

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


            var apiInstance = new AbsencesApi();
            var filters = filters_example;  // String | filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are 

Equals, account=10
Does not equal, type=not:-11
Greater than, start=gt:2025-01-01
Less than, start=start:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2025-12-31]
One of the options (value in list), type=[10,11,15,20]

(optional) try { // Retrieves a list of all absences inline_response_200_3 result = apiInstance.getAbsences(filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling AbsencesApi.getAbsences: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAbsencesApi();
$filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are 

Equals, account=10
Does not equal, type=not:-11
Greater than, start=gt:2025-01-01
Less than, start=start:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2025-12-31]
One of the options (value in list), type=[10,11,15,20]

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


my $api_instance = WWW::SwaggerClient::AbsencesApi->new();
my $filters = filters_example; # String | filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are 

Equals, account=10
Does not equal, type=not:-11
Greater than, start=gt:2025-01-01
Less than, start=start:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2025-12-31]
One of the options (value in list), type=[10,11,15,20]

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


# create an instance of the API class
api_instance = swagger_client.AbsencesApi()
filters = filters_example # String | filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are 

Equals, account=10
Does not equal, type=not:-11
Greater than, start=gt:2025-01-01
Less than, start=start:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2025-12-31]
One of the options (value in list), type=[10,11,15,20]

(optional) try: # Retrieves a list of all absences api_response = api_instance.get_absences(filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling AbsencesApi->getAbsences: %s\n" % e)

Parameters

Query parameters
Name Description
filters
String
filters, please use variable name as the paramter, i.e. title=office. Valid options for filter are <P> Equals, account=10<BR/> Does not equal, type=not:-11<BR/> Greater than, start=gt:2025-01-01<BR/> Less than, start=start:2025-01-01<BR/> Greater or equal than, start=gte:2025-01-01<BR/> Less or equal to, start=lte:2025-01-01<BR/> Between, start=[2025-01-01:2025-12-31]<BR/> One of the options (value in list), type=[10,11,15,20] </P>

Responses

Status: 200 - All absences

Status: 401 - Unauthorised


newAbsence

Create a new absence

Create a new absence


/absences/new

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/absences/new?absence-type=&category=&reason=&start=&end=&repeat="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AbsencesApi;

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

public class AbsencesApiExample {

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


        AbsencesApi apiInstance = new AbsencesApi();
        String absenceType = absenceType_example; // String | type of new absence
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String repeat = repeat_example; // String | repeat the new absence
        String category = category_example; // String | category of new absence
        String reason = reason_example; // String | reason for new absence
        try {
            apiInstance.newAbsence(absenceType, start, end, repeat, category, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling AbsencesApi#newAbsence");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AbsencesApi;

public class AbsencesApiExample {

    public static void main(String[] args) {
        AbsencesApi apiInstance = new AbsencesApi();
        String absenceType = absenceType_example; // String | type of new absence
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String repeat = repeat_example; // String | repeat the new absence
        String category = category_example; // String | category of new absence
        String reason = reason_example; // String | reason for new absence
        try {
            apiInstance.newAbsence(absenceType, start, end, repeat, category, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling AbsencesApi#newAbsence");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *absenceType = absenceType_example; // type of new absence
String *start = start_example; // start (YYYY-MM-DD HH:MM:SS in local time)
String *end = end_example; // end (YYYY-MM-DD HH:MM:SS in local time)
String *repeat = repeat_example; // repeat the new absence
String *category = category_example; // category of new absence (optional)
String *reason = reason_example; // reason for new absence (optional)

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

// Create a new absence
[apiInstance newAbsenceWith:absenceType
    start:start
    end:end
    repeat:repeat
    category:category
    reason:reason
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AbsencesApi()
var absenceType = absenceType_example; // {{String}} type of new absence
var start = start_example; // {{String}} start (YYYY-MM-DD HH:MM:SS in local time)
var end = end_example; // {{String}} end (YYYY-MM-DD HH:MM:SS in local time)
var repeat = repeat_example; // {{String}} repeat the new absence
var opts = { 
  'category': category_example, // {{String}} category of new absence
  'reason': reason_example // {{String}} reason for new absence
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.newAbsence(absenceType, start, end, repeat, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AbsencesApi();
            var absenceType = absenceType_example;  // String | type of new absence
            var start = start_example;  // String | start (YYYY-MM-DD HH:MM:SS in local time)
            var end = end_example;  // String | end (YYYY-MM-DD HH:MM:SS in local time)
            var repeat = repeat_example;  // String | repeat the new absence
            var category = category_example;  // String | category of new absence (optional) 
            var reason = reason_example;  // String | reason for new absence (optional) 

            try
            {
                // Create a new absence
                apiInstance.newAbsence(absenceType, start, end, repeat, category, reason);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AbsencesApi.newAbsence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAbsencesApi();
$absenceType = absenceType_example; // String | type of new absence
$start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
$end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
$repeat = repeat_example; // String | repeat the new absence
$category = category_example; // String | category of new absence
$reason = reason_example; // String | reason for new absence

try {
    $api_instance->newAbsence($absenceType, $start, $end, $repeat, $category, $reason);
} catch (Exception $e) {
    echo 'Exception when calling AbsencesApi->newAbsence: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AbsencesApi;


my $api_instance = WWW::SwaggerClient::AbsencesApi->new();
my $absenceType = absenceType_example; # String | type of new absence
my $start = start_example; # String | start (YYYY-MM-DD HH:MM:SS in local time)
my $end = end_example; # String | end (YYYY-MM-DD HH:MM:SS in local time)
my $repeat = repeat_example; # String | repeat the new absence
my $category = category_example; # String | category of new absence
my $reason = reason_example; # String | reason for new absence

eval { 
    $api_instance->newAbsence(absenceType => $absenceType, start => $start, end => $end, repeat => $repeat, category => $category, reason => $reason);
};
if ($@) {
    warn "Exception when calling AbsencesApi->newAbsence: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AbsencesApi()
absenceType = absenceType_example # String | type of new absence
start = start_example # String | start (YYYY-MM-DD HH:MM:SS in local time)
end = end_example # String | end (YYYY-MM-DD HH:MM:SS in local time)
repeat = repeat_example # String | repeat the new absence
category = category_example # String | category of new absence (optional)
reason = reason_example # String | reason for new absence (optional)

try: 
    # Create a new absence
    api_instance.new_absence(absenceType, start, end, repeat, category=category, reason=reason)
except ApiException as e:
    print("Exception when calling AbsencesApi->newAbsence: %s\n" % e)

Parameters

Query parameters
Name Description
absence-type*
String
type of new absence
Required
category
String
category of new absence
reason
String
reason for new absence
start*
String
start (YYYY-MM-DD HH:MM:SS in local time)
Required
end*
String
end (YYYY-MM-DD HH:MM:SS in local time)
Required
repeat*
String
repeat the new absence
Required

Responses

Status: 201 - absence updated

Status: 304 - not modified


updateAbsence

Update absence information

Updates absence item


/absences/{absenceid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/absences/{absenceid}?absence-type=&category=&reason=&start=&end=&duration=&work-days=&remaining=&added-by="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AbsencesApi;

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

public class AbsencesApiExample {

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


        AbsencesApi apiInstance = new AbsencesApi();
        Integer absenceid = 56; // Integer | individual absence id
        String absenceType = absenceType_example; // String | type of absence
        String category = category_example; // String | category of absence
        String reason = reason_example; // String | reason for absence
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String duration = duration_example; // String | length of absence (DD-HH-MM)
        String workDays = workDays_example; // String | number of works days absence covers
        String remaining = remaining_example; // String | number of staff with same role remaining
        String addedBy = addedBy_example; // String | member of staff that added absence
        try {
            apiInstance.updateAbsence(absenceid, absenceType, category, reason, start, end, duration, workDays, remaining, addedBy);
        } catch (ApiException e) {
            System.err.println("Exception when calling AbsencesApi#updateAbsence");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AbsencesApi;

public class AbsencesApiExample {

    public static void main(String[] args) {
        AbsencesApi apiInstance = new AbsencesApi();
        Integer absenceid = 56; // Integer | individual absence id
        String absenceType = absenceType_example; // String | type of absence
        String category = category_example; // String | category of absence
        String reason = reason_example; // String | reason for absence
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String duration = duration_example; // String | length of absence (DD-HH-MM)
        String workDays = workDays_example; // String | number of works days absence covers
        String remaining = remaining_example; // String | number of staff with same role remaining
        String addedBy = addedBy_example; // String | member of staff that added absence
        try {
            apiInstance.updateAbsence(absenceid, absenceType, category, reason, start, end, duration, workDays, remaining, addedBy);
        } catch (ApiException e) {
            System.err.println("Exception when calling AbsencesApi#updateAbsence");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *absenceid = 56; // individual absence id
String *absenceType = absenceType_example; // type of absence (optional)
String *category = category_example; // category of absence (optional)
String *reason = reason_example; // reason for absence (optional)
String *start = start_example; // start (YYYY-MM-DD HH:MM:SS in local time) (optional)
String *end = end_example; // end (YYYY-MM-DD HH:MM:SS in local time) (optional)
String *duration = duration_example; // length of absence (DD-HH-MM) (optional)
String *workDays = workDays_example; // number of works days absence covers (optional)
String *remaining = remaining_example; // number of staff with same role remaining (optional)
String *addedBy = addedBy_example; // member of staff that added absence (optional)

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

// Update absence information
[apiInstance updateAbsenceWith:absenceid
    absenceType:absenceType
    category:category
    reason:reason
    start:start
    end:end
    duration:duration
    workDays:workDays
    remaining:remaining
    addedBy:addedBy
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AbsencesApi()
var absenceid = 56; // {{Integer}} individual absence id
var opts = { 
  'absenceType': absenceType_example, // {{String}} type of absence
  'category': category_example, // {{String}} category of absence
  'reason': reason_example, // {{String}} reason for absence
  'start': start_example, // {{String}} start (YYYY-MM-DD HH:MM:SS in local time)
  'end': end_example, // {{String}} end (YYYY-MM-DD HH:MM:SS in local time)
  'duration': duration_example, // {{String}} length of absence (DD-HH-MM)
  'workDays': workDays_example, // {{String}} number of works days absence covers
  'remaining': remaining_example, // {{String}} number of staff with same role remaining
  'addedBy': addedBy_example // {{String}} member of staff that added absence
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateAbsence(absenceid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AbsencesApi();
            var absenceid = 56;  // Integer | individual absence id
            var absenceType = absenceType_example;  // String | type of absence (optional) 
            var category = category_example;  // String | category of absence (optional) 
            var reason = reason_example;  // String | reason for absence (optional) 
            var start = start_example;  // String | start (YYYY-MM-DD HH:MM:SS in local time) (optional) 
            var end = end_example;  // String | end (YYYY-MM-DD HH:MM:SS in local time) (optional) 
            var duration = duration_example;  // String | length of absence (DD-HH-MM) (optional) 
            var workDays = workDays_example;  // String | number of works days absence covers (optional) 
            var remaining = remaining_example;  // String | number of staff with same role remaining (optional) 
            var addedBy = addedBy_example;  // String | member of staff that added absence (optional) 

            try
            {
                // Update absence information
                apiInstance.updateAbsence(absenceid, absenceType, category, reason, start, end, duration, workDays, remaining, addedBy);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AbsencesApi.updateAbsence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAbsencesApi();
$absenceid = 56; // Integer | individual absence id
$absenceType = absenceType_example; // String | type of absence
$category = category_example; // String | category of absence
$reason = reason_example; // String | reason for absence
$start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
$end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
$duration = duration_example; // String | length of absence (DD-HH-MM)
$workDays = workDays_example; // String | number of works days absence covers
$remaining = remaining_example; // String | number of staff with same role remaining
$addedBy = addedBy_example; // String | member of staff that added absence

try {
    $api_instance->updateAbsence($absenceid, $absenceType, $category, $reason, $start, $end, $duration, $workDays, $remaining, $addedBy);
} catch (Exception $e) {
    echo 'Exception when calling AbsencesApi->updateAbsence: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AbsencesApi;


my $api_instance = WWW::SwaggerClient::AbsencesApi->new();
my $absenceid = 56; # Integer | individual absence id
my $absenceType = absenceType_example; # String | type of absence
my $category = category_example; # String | category of absence
my $reason = reason_example; # String | reason for absence
my $start = start_example; # String | start (YYYY-MM-DD HH:MM:SS in local time)
my $end = end_example; # String | end (YYYY-MM-DD HH:MM:SS in local time)
my $duration = duration_example; # String | length of absence (DD-HH-MM)
my $workDays = workDays_example; # String | number of works days absence covers
my $remaining = remaining_example; # String | number of staff with same role remaining
my $addedBy = addedBy_example; # String | member of staff that added absence

eval { 
    $api_instance->updateAbsence(absenceid => $absenceid, absenceType => $absenceType, category => $category, reason => $reason, start => $start, end => $end, duration => $duration, workDays => $workDays, remaining => $remaining, addedBy => $addedBy);
};
if ($@) {
    warn "Exception when calling AbsencesApi->updateAbsence: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AbsencesApi()
absenceid = 56 # Integer | individual absence id
absenceType = absenceType_example # String | type of absence (optional)
category = category_example # String | category of absence (optional)
reason = reason_example # String | reason for absence (optional)
start = start_example # String | start (YYYY-MM-DD HH:MM:SS in local time) (optional)
end = end_example # String | end (YYYY-MM-DD HH:MM:SS in local time) (optional)
duration = duration_example # String | length of absence (DD-HH-MM) (optional)
workDays = workDays_example # String | number of works days absence covers (optional)
remaining = remaining_example # String | number of staff with same role remaining (optional)
addedBy = addedBy_example # String | member of staff that added absence (optional)

try: 
    # Update absence information
    api_instance.update_absence(absenceid, absenceType=absenceType, category=category, reason=reason, start=start, end=end, duration=duration, workDays=workDays, remaining=remaining, addedBy=addedBy)
except ApiException as e:
    print("Exception when calling AbsencesApi->updateAbsence: %s\n" % e)

Parameters

Path parameters
Name Description
absenceid*
Integer
individual absence id
Required
Query parameters
Name Description
absence-type
String
type of absence
category
String
category of absence
reason
String
reason for absence
start
String
start (YYYY-MM-DD HH:MM:SS in local time)
end
String
end (YYYY-MM-DD HH:MM:SS in local time)
duration
String
length of absence (DD-HH-MM)
work-days
String
number of works days absence covers
remaining
String
number of staff with same role remaining
added-by
String
member of staff that added absence

Responses

Status: 201 - absence updated

Status: 304 - not modified


Accounts

getAccount

Retrieve an individual account item

Retrieve an individual account record


/accounts/{accountid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/accounts/{accountid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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


        AccountsApi apiInstance = new AccountsApi();
        Integer accountid = 56; // Integer | individual account id
        try {
            inline_response_200_2 result = apiInstance.getAccount(accountid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        Integer accountid = 56; // Integer | individual account id
        try {
            inline_response_200_2 result = apiInstance.getAccount(accountid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *accountid = 56; // individual account id

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

// Retrieve an individual account item
[apiInstance getAccountWith:accountid
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AccountsApi()
var accountid = 56; // {{Integer}} individual account id

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

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


            var apiInstance = new AccountsApi();
            var accountid = 56;  // Integer | individual account id

            try
            {
                // Retrieve an individual account item
                inline_response_200_2 result = apiInstance.getAccount(accountid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccountsApi();
$accountid = 56; // Integer | individual account id

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


my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountid = 56; # Integer | individual account id

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


# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountid = 56 # Integer | individual account id

try: 
    # Retrieve an individual account item
    api_response = api_instance.get_account(accountid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getAccount: %s\n" % e)

Parameters

Path parameters
Name Description
accountid*
Integer
individual account id
Required

Responses

Status: 200 - Individual account record

Status: 400 - bad input parameter


getAccounts

Retrieves a list of all accounts available

Retrieves a list of all accounts that are available to your user


/accounts

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/accounts?filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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


        AccountsApi apiInstance = new AccountsApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are 

Equals, firstname=Bob
Does not equal, firstname=not:Bob
Greater than, firstname=gt:Bob
Less than, firstname=lt:Bob
Greater or equal than, level=gte:5
Less or equal to, level=lte:5
Between, level=[2:10]
One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01

try { inline_response_200_1 result = apiInstance.getAccounts(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AccountsApi#getAccounts"); e.printStackTrace(); } } }
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are 

Equals, firstname=Bob
Does not equal, firstname=not:Bob
Greater than, firstname=gt:Bob
Less than, firstname=lt:Bob
Greater or equal than, level=gte:5
Less or equal to, level=lte:5
Between, level=[2:10]
One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01

try { inline_response_200_1 result = apiInstance.getAccounts(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AccountsApi#getAccounts"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *filters = filters_example; // filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are 

Equals, firstname=Bob
Does not equal, firstname=not:Bob
Greater than, firstname=gt:Bob
Less than, firstname=lt:Bob
Greater or equal than, level=gte:5
Less or equal to, level=lte:5
Between, level=[2:10]
One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01

(optional) AccountsApi *apiInstance = [[AccountsApi alloc] init]; // Retrieves a list of all accounts available [apiInstance getAccountsWith:filters completionHandler: ^(inline_response_200_1 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AccountsApi()
var opts = { 
  'filters': filters_example // {{String}} filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are 

Equals, firstname=Bob
Does not equal, firstname=not:Bob
Greater than, firstname=gt:Bob
Less than, firstname=lt:Bob
Greater or equal than, level=gte:5
Less or equal to, level=lte:5
Between, level=[2:10]
One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01

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

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


            var apiInstance = new AccountsApi();
            var filters = filters_example;  // String | filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are 

Equals, firstname=Bob
Does not equal, firstname=not:Bob
Greater than, firstname=gt:Bob
Less than, firstname=lt:Bob
Greater or equal than, level=gte:5
Less or equal to, level=lte:5
Between, level=[2:10]
One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01

(optional) try { // Retrieves a list of all accounts available inline_response_200_1 result = apiInstance.getAccounts(filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling AccountsApi.getAccounts: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccountsApi();
$filters = filters_example; // String | filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are 

Equals, firstname=Bob
Does not equal, firstname=not:Bob
Greater than, firstname=gt:Bob
Less than, firstname=lt:Bob
Greater or equal than, level=gte:5
Less or equal to, level=lte:5
Between, level=[2:10]
One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01

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


my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $filters = filters_example; # String | filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are 

Equals, firstname=Bob
Does not equal, firstname=not:Bob
Greater than, firstname=gt:Bob
Less than, firstname=lt:Bob
Greater or equal than, level=gte:5
Less or equal to, level=lte:5
Between, level=[2:10]
One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01

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


# create an instance of the API class
api_instance = swagger_client.AccountsApi()
filters = filters_example # String | filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are 

Equals, firstname=Bob
Does not equal, firstname=not:Bob
Greater than, firstname=gt:Bob
Less than, firstname=lt:Bob
Greater or equal than, level=gte:5
Less or equal to, level=lte:5
Between, level=[2:10]
One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01

(optional) try: # Retrieves a list of all accounts available api_response = api_instance.get_accounts(filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling AccountsApi->getAccounts: %s\n" % e)

Parameters

Query parameters
Name Description
filters
String
filters, please use variable name as the paramter, i.e. email=example@email.com. Valid options for filter are <P> Equals, firstname=Bob<BR/> Does not equal, firstname=not:Bob<BR/> Greater than, firstname=gt:Bob<BR/> Less than, firstname=lt:Bob<BR/> Greater or equal than, level=gte:5<BR/> Less or equal to, level=lte:5<BR/> Between, level=[2:10]<BR/> One of the options (value in list), firstname=[Bob,Bill,Rob] _last_history_record variable can be used to then specify a changed since date. E.g. _last_history_record=gte:2024-01-01 </P>

Responses

Status: 200 - All available accounts

Status: 401 - Unauthorised


newAccount

Create a new account

Create a new account


/accounts/new

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/accounts/new?firstname=&lastname=&known-as=&email=&phone=&level=&default-venue="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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


        AccountsApi apiInstance = new AccountsApi();
        String firstname = firstname_example; // String | first name of new user
        String lastname = lastname_example; // String | surname of new user
        String email = email_example; // String | email address of new user
        String phone = phone_example; // String | phone number of new user
        Integer level = 56; // Integer | level of new user
        Integer defaultVenue = 56; // Integer | default of new user
        String knownAs = knownAs_example; // String | known-as of new user
        try {
            apiInstance.newAccount(firstname, lastname, email, phone, level, defaultVenue, knownAs);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#newAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        String firstname = firstname_example; // String | first name of new user
        String lastname = lastname_example; // String | surname of new user
        String email = email_example; // String | email address of new user
        String phone = phone_example; // String | phone number of new user
        Integer level = 56; // Integer | level of new user
        Integer defaultVenue = 56; // Integer | default of new user
        String knownAs = knownAs_example; // String | known-as of new user
        try {
            apiInstance.newAccount(firstname, lastname, email, phone, level, defaultVenue, knownAs);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#newAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *firstname = firstname_example; // first name of new user
String *lastname = lastname_example; // surname of new user
String *email = email_example; // email address of new user
String *phone = phone_example; // phone number of new user
Integer *level = 56; // level of new user
Integer *defaultVenue = 56; // default of new user
String *knownAs = knownAs_example; // known-as of new user (optional)

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

// Create a new account
[apiInstance newAccountWith:firstname
    lastname:lastname
    email:email
    phone:phone
    level:level
    defaultVenue:defaultVenue
    knownAs:knownAs
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AccountsApi()
var firstname = firstname_example; // {{String}} first name of new user
var lastname = lastname_example; // {{String}} surname of new user
var email = email_example; // {{String}} email address of new user
var phone = phone_example; // {{String}} phone number of new user
var level = 56; // {{Integer}} level of new user
var defaultVenue = 56; // {{Integer}} default of new user
var opts = { 
  'knownAs': knownAs_example // {{String}} known-as of new user
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.newAccount(firstname, lastname, email, phone, level, defaultVenue, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AccountsApi();
            var firstname = firstname_example;  // String | first name of new user
            var lastname = lastname_example;  // String | surname of new user
            var email = email_example;  // String | email address of new user
            var phone = phone_example;  // String | phone number of new user
            var level = 56;  // Integer | level of new user
            var defaultVenue = 56;  // Integer | default of new user
            var knownAs = knownAs_example;  // String | known-as of new user (optional) 

            try
            {
                // Create a new account
                apiInstance.newAccount(firstname, lastname, email, phone, level, defaultVenue, knownAs);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.newAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccountsApi();
$firstname = firstname_example; // String | first name of new user
$lastname = lastname_example; // String | surname of new user
$email = email_example; // String | email address of new user
$phone = phone_example; // String | phone number of new user
$level = 56; // Integer | level of new user
$defaultVenue = 56; // Integer | default of new user
$knownAs = knownAs_example; // String | known-as of new user

try {
    $api_instance->newAccount($firstname, $lastname, $email, $phone, $level, $defaultVenue, $knownAs);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->newAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;


my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $firstname = firstname_example; # String | first name of new user
my $lastname = lastname_example; # String | surname of new user
my $email = email_example; # String | email address of new user
my $phone = phone_example; # String | phone number of new user
my $level = 56; # Integer | level of new user
my $defaultVenue = 56; # Integer | default of new user
my $knownAs = knownAs_example; # String | known-as of new user

eval { 
    $api_instance->newAccount(firstname => $firstname, lastname => $lastname, email => $email, phone => $phone, level => $level, defaultVenue => $defaultVenue, knownAs => $knownAs);
};
if ($@) {
    warn "Exception when calling AccountsApi->newAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AccountsApi()
firstname = firstname_example # String | first name of new user
lastname = lastname_example # String | surname of new user
email = email_example # String | email address of new user
phone = phone_example # String | phone number of new user
level = 56 # Integer | level of new user
defaultVenue = 56 # Integer | default of new user
knownAs = knownAs_example # String | known-as of new user (optional)

try: 
    # Create a new account
    api_instance.new_account(firstname, lastname, email, phone, level, defaultVenue, knownAs=knownAs)
except ApiException as e:
    print("Exception when calling AccountsApi->newAccount: %s\n" % e)

Parameters

Query parameters
Name Description
firstname*
String
first name of new user
Required
lastname*
String
surname of new user
Required
known-as
String
known-as of new user
email*
String (email)
email address of new user
Required
phone*
String
phone number of new user
Required
level*
Integer
level of new user
Required
default-venue*
Integer
default of new user
Required

Responses

Status: 201 - account updated

Status: 304 - not modified


pathAction

Apply an action to an account

Apply an action to an account


/accounts/{accountid}/action/

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/accounts/{accountid}/action/?_action="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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


        AccountsApi apiInstance = new AccountsApi();
        Integer accountid = 56; // Integer | id of account
        _action action = ; // _action | 

Action to be completed:

  • invite: send invite email
  • archive: archive the account
  • restore: restore an archied account
  • assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.

try { apiInstance.pathAction(accountid, action); } catch (ApiException e) { System.err.println("Exception when calling AccountsApi#pathAction"); e.printStackTrace(); } } }
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        Integer accountid = 56; // Integer | id of account
        _action action = ; // _action | 

Action to be completed:

  • invite: send invite email
  • archive: archive the account
  • restore: restore an archied account
  • assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.

try { apiInstance.pathAction(accountid, action); } catch (ApiException e) { System.err.println("Exception when calling AccountsApi#pathAction"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
Integer *accountid = 56; // id of account
_action *action = ; // 

Action to be completed:

  • invite: send invite email
  • archive: archive the account
  • restore: restore an archied account
  • assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.

AccountsApi *apiInstance = [[AccountsApi alloc] init]; // Apply an action to an account [apiInstance pathActionWith:accountid action:action completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AccountsApi()
var accountid = 56; // {{Integer}} id of account
var action = ; // {{_action}} 

Action to be completed:

  • invite: send invite email
  • archive: archive the account
  • restore: restore an archied account
  • assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.

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

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


            var apiInstance = new AccountsApi();
            var accountid = 56;  // Integer | id of account
            var action = new _action(); // _action | 

Action to be completed:

  • invite: send invite email
  • archive: archive the account
  • restore: restore an archied account
  • assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.

try { // Apply an action to an account apiInstance.pathAction(accountid, action); } catch (Exception e) { Debug.Print("Exception when calling AccountsApi.pathAction: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccountsApi();
$accountid = 56; // Integer | id of account
$action = ; // _action | 

Action to be completed:

  • invite: send invite email
  • archive: archive the account
  • restore: restore an archied account
  • assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.

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


my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountid = 56; # Integer | id of account
my $action = ; # _action | 

Action to be completed:

  • invite: send invite email
  • archive: archive the account
  • restore: restore an archied account
  • assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.

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


# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountid = 56 # Integer | id of account
action =  # _action | 

Action to be completed:

  • invite: send invite email
  • archive: archive the account
  • restore: restore an archied account
  • assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.
  • remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.

try: # Apply an action to an account api_instance.path_action(accountid, action) except ApiException as e: print("Exception when calling AccountsApi->pathAction: %s\n" % e)

Parameters

Path parameters
Name Description
accountid*
Integer
id of account
Required
Query parameters
Name Description
_action*
_action
<p>Action to be completed:<ul> <li>invite: send invite email</li> <li>archive: archive the account</li> <li> restore: restore an archied account</li> <li>assign-venue: assign venues to the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.</li> <li>remove-venue: unassign venues from the account. Venue(s) can be provided in the GET veriable 'item'. Send multiples as an array.</li> <li>assign-group: assign groups (often called skills or roles) to the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.</li> <li>remove-group: unassign groups (often called skills or roles) from the account. Skills(s) can be provided in the GET veriable 'item'. Send multiples as an array.</li></ul> </p>
Required

Responses

Status: 201 - account updated

Status: 304 - not modified


updateAccount

Update account details

Updates accout item


/accounts/{accountid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/accounts/{accountid}?firstname=&lastname=&known-as=&email=&phone=&level=&default-venue="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

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

public class AccountsApiExample {

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


        AccountsApi apiInstance = new AccountsApi();
        Integer accountid = 56; // Integer | individual account id
        String firstname = firstname_example; // String | first name to be updated
        String lastname = lastname_example; // String | surname to be updated
        String knownAs = knownAs_example; // String | known-as to be updated
        String email = email_example; // String | email address to be updated
        String phone = phone_example; // String | phone number to be updated
        Integer level = 56; // Integer | level to be updated
        String defaultVenue = defaultVenue_example; // String | default venue to be updated
        try {
            apiInstance.updateAccount(accountid, firstname, lastname, knownAs, email, phone, level, defaultVenue);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#updateAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        Integer accountid = 56; // Integer | individual account id
        String firstname = firstname_example; // String | first name to be updated
        String lastname = lastname_example; // String | surname to be updated
        String knownAs = knownAs_example; // String | known-as to be updated
        String email = email_example; // String | email address to be updated
        String phone = phone_example; // String | phone number to be updated
        Integer level = 56; // Integer | level to be updated
        String defaultVenue = defaultVenue_example; // String | default venue to be updated
        try {
            apiInstance.updateAccount(accountid, firstname, lastname, knownAs, email, phone, level, defaultVenue);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#updateAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *accountid = 56; // individual account id
String *firstname = firstname_example; // first name to be updated (optional)
String *lastname = lastname_example; // surname to be updated (optional)
String *knownAs = knownAs_example; // known-as to be updated (optional)
String *email = email_example; // email address to be updated (optional)
String *phone = phone_example; // phone number to be updated (optional)
Integer *level = 56; // level to be updated (optional)
String *defaultVenue = defaultVenue_example; // default venue to be updated (optional)

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

// Update account details
[apiInstance updateAccountWith:accountid
    firstname:firstname
    lastname:lastname
    knownAs:knownAs
    email:email
    phone:phone
    level:level
    defaultVenue:defaultVenue
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.AccountsApi()
var accountid = 56; // {{Integer}} individual account id
var opts = { 
  'firstname': firstname_example, // {{String}} first name to be updated
  'lastname': lastname_example, // {{String}} surname to be updated
  'knownAs': knownAs_example, // {{String}} known-as to be updated
  'email': email_example, // {{String}} email address to be updated
  'phone': phone_example, // {{String}} phone number to be updated
  'level': 56, // {{Integer}} level to be updated
  'defaultVenue': defaultVenue_example // {{String}} default venue to be updated
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateAccount(accountid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new AccountsApi();
            var accountid = 56;  // Integer | individual account id
            var firstname = firstname_example;  // String | first name to be updated (optional) 
            var lastname = lastname_example;  // String | surname to be updated (optional) 
            var knownAs = knownAs_example;  // String | known-as to be updated (optional) 
            var email = email_example;  // String | email address to be updated (optional) 
            var phone = phone_example;  // String | phone number to be updated (optional) 
            var level = 56;  // Integer | level to be updated (optional) 
            var defaultVenue = defaultVenue_example;  // String | default venue to be updated (optional) 

            try
            {
                // Update account details
                apiInstance.updateAccount(accountid, firstname, lastname, knownAs, email, phone, level, defaultVenue);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.updateAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAccountsApi();
$accountid = 56; // Integer | individual account id
$firstname = firstname_example; // String | first name to be updated
$lastname = lastname_example; // String | surname to be updated
$knownAs = knownAs_example; // String | known-as to be updated
$email = email_example; // String | email address to be updated
$phone = phone_example; // String | phone number to be updated
$level = 56; // Integer | level to be updated
$defaultVenue = defaultVenue_example; // String | default venue to be updated

try {
    $api_instance->updateAccount($accountid, $firstname, $lastname, $knownAs, $email, $phone, $level, $defaultVenue);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->updateAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;


my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountid = 56; # Integer | individual account id
my $firstname = firstname_example; # String | first name to be updated
my $lastname = lastname_example; # String | surname to be updated
my $knownAs = knownAs_example; # String | known-as to be updated
my $email = email_example; # String | email address to be updated
my $phone = phone_example; # String | phone number to be updated
my $level = 56; # Integer | level to be updated
my $defaultVenue = defaultVenue_example; # String | default venue to be updated

eval { 
    $api_instance->updateAccount(accountid => $accountid, firstname => $firstname, lastname => $lastname, knownAs => $knownAs, email => $email, phone => $phone, level => $level, defaultVenue => $defaultVenue);
};
if ($@) {
    warn "Exception when calling AccountsApi->updateAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountid = 56 # Integer | individual account id
firstname = firstname_example # String | first name to be updated (optional)
lastname = lastname_example # String | surname to be updated (optional)
knownAs = knownAs_example # String | known-as to be updated (optional)
email = email_example # String | email address to be updated (optional)
phone = phone_example # String | phone number to be updated (optional)
level = 56 # Integer | level to be updated (optional)
defaultVenue = defaultVenue_example # String | default venue to be updated (optional)

try: 
    # Update account details
    api_instance.update_account(accountid, firstname=firstname, lastname=lastname, knownAs=knownAs, email=email, phone=phone, level=level, defaultVenue=defaultVenue)
except ApiException as e:
    print("Exception when calling AccountsApi->updateAccount: %s\n" % e)

Parameters

Path parameters
Name Description
accountid*
Integer
individual account id
Required
Query parameters
Name Description
firstname
String
first name to be updated
lastname
String
surname to be updated
known-as
String
known-as to be updated
email
String (email)
email address to be updated
phone
String
phone number to be updated
level
Integer
level to be updated
default-venue
String
default venue to be updated

Responses

Status: 201 - account updated

Status: 304 - not modified


Auth

getToken

Retrieve your bearer token for authentication

Retrieve your bearer token for subsequent authentication


/auth

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/auth?x-user=&x-auth="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String xUser = xUser_example; // String | Your given username
        String xAuth = xAuth_example; // String | Your given password
        try {
            inline_response_200 result = apiInstance.getToken(xUser, xAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String xUser = xUser_example; // String | Your given username
        String xAuth = xAuth_example; // String | Your given password
        try {
            inline_response_200 result = apiInstance.getToken(xUser, xAuth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getToken");
            e.printStackTrace();
        }
    }
}
String *xUser = xUser_example; // Your given username
String *xAuth = xAuth_example; // Your given password

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

// Retrieve your bearer token for authentication
[apiInstance getTokenWith:xUser
    xAuth:xAuth
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');

var api = new StaffSavvyRestApi.AuthApi()
var xUser = xUser_example; // {{String}} Your given username
var xAuth = xAuth_example; // {{String}} Your given password

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

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

            var apiInstance = new AuthApi();
            var xUser = xUser_example;  // String | Your given username
            var xAuth = xAuth_example;  // String | Your given password

            try
            {
                // Retrieve your bearer token for authentication
                inline_response_200 result = apiInstance.getToken(xUser, xAuth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.getToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$xUser = xUser_example; // String | Your given username
$xAuth = xAuth_example; // String | Your given password

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

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $xUser = xUser_example; # String | Your given username
my $xAuth = xAuth_example; # String | Your given password

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

# create an instance of the API class
api_instance = swagger_client.AuthApi()
xUser = xUser_example # String | Your given username
xAuth = xAuth_example # String | Your given password

try: 
    # Retrieve your bearer token for authentication
    api_response = api_instance.get_token(xUser, xAuth)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->getToken: %s\n" % e)

Parameters

Query parameters
Name Description
x-user*
String
Your given username
Required
x-auth*
String
Your given password
Required

Responses

Status: 200 - Your bearer token


Lookups

getGroups

Retrieves a list of all groups

Retrieves a list of all groups that are available to your user


/groups

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/groups?filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LookupsApi;

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

public class LookupsApiExample {

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


        LookupsApi apiInstance = new LookupsApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are 

Equals, title=Usher
Does not equal, title=not:Usher
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

try { inline_response_200_7 result = apiInstance.getGroups(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LookupsApi#getGroups"); e.printStackTrace(); } } }
import io.swagger.client.api.LookupsApi;

public class LookupsApiExample {

    public static void main(String[] args) {
        LookupsApi apiInstance = new LookupsApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are 

Equals, title=Usher
Does not equal, title=not:Usher
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

try { inline_response_200_7 result = apiInstance.getGroups(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LookupsApi#getGroups"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *filters = filters_example; // filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are 

Equals, title=Usher
Does not equal, title=not:Usher
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

(optional) LookupsApi *apiInstance = [[LookupsApi alloc] init]; // Retrieves a list of all groups [apiInstance getGroupsWith:filters completionHandler: ^(inline_response_200_7 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.LookupsApi()
var opts = { 
  'filters': filters_example // {{String}} filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are 

Equals, title=Usher
Does not equal, title=not:Usher
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

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

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


            var apiInstance = new LookupsApi();
            var filters = filters_example;  // String | filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are 

Equals, title=Usher
Does not equal, title=not:Usher
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

(optional) try { // Retrieves a list of all groups inline_response_200_7 result = apiInstance.getGroups(filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling LookupsApi.getGroups: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiLookupsApi();
$filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are 

Equals, title=Usher
Does not equal, title=not:Usher
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

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


my $api_instance = WWW::SwaggerClient::LookupsApi->new();
my $filters = filters_example; # String | filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are 

Equals, title=Usher
Does not equal, title=not:Usher
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

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


# create an instance of the API class
api_instance = swagger_client.LookupsApi()
filters = filters_example # String | filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are 

Equals, title=Usher
Does not equal, title=not:Usher
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

(optional) try: # Retrieves a list of all groups api_response = api_instance.get_groups(filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling LookupsApi->getGroups: %s\n" % e)

Parameters

Query parameters
Name Description
filters
String
filters, please use variable name as the paramter, i.e. title=usher. Valid options for filter are <P> Equals, title=Usher<BR/> Does not equal, title=not:Usher<BR/> Greater than, id=gt:10<BR/> Less than, id=lt:10<BR/> Greater or equal than, id=gte:10<BR/> Less or equal to, id=lte:10<BR/> Between, id=[10:20]<BR/> One of the options (value in list), id=[3,9,20] </P>

Responses

Status: 200 - All available groups

Status: 401 - Unauthorised


getShiftActions

Retrieves a list of all shift-actions

Retrieves a list of all shift actions that are available to your user


/shift-actions

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/shift-actions?filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LookupsApi;

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

public class LookupsApiExample {

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


        LookupsApi apiInstance = new LookupsApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are 

Equals, title=cleaning
Does not equal, title=not:cleaning
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

try { inline_response_200_8 result = apiInstance.getShiftActions(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LookupsApi#getShiftActions"); e.printStackTrace(); } } }
import io.swagger.client.api.LookupsApi;

public class LookupsApiExample {

    public static void main(String[] args) {
        LookupsApi apiInstance = new LookupsApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are 

Equals, title=cleaning
Does not equal, title=not:cleaning
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

try { inline_response_200_8 result = apiInstance.getShiftActions(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LookupsApi#getShiftActions"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *filters = filters_example; // filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are 

Equals, title=cleaning
Does not equal, title=not:cleaning
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

(optional) LookupsApi *apiInstance = [[LookupsApi alloc] init]; // Retrieves a list of all shift-actions [apiInstance getShiftActionsWith:filters completionHandler: ^(inline_response_200_8 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.LookupsApi()
var opts = { 
  'filters': filters_example // {{String}} filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are 

Equals, title=cleaning
Does not equal, title=not:cleaning
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

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

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


            var apiInstance = new LookupsApi();
            var filters = filters_example;  // String | filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are 

Equals, title=cleaning
Does not equal, title=not:cleaning
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

(optional) try { // Retrieves a list of all shift-actions inline_response_200_8 result = apiInstance.getShiftActions(filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling LookupsApi.getShiftActions: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiLookupsApi();
$filters = filters_example; // String | filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are 

Equals, title=cleaning
Does not equal, title=not:cleaning
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

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


my $api_instance = WWW::SwaggerClient::LookupsApi->new();
my $filters = filters_example; # String | filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are 

Equals, title=cleaning
Does not equal, title=not:cleaning
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

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


# create an instance of the API class
api_instance = swagger_client.LookupsApi()
filters = filters_example # String | filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are 

Equals, title=cleaning
Does not equal, title=not:cleaning
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[10:20]
One of the options (value in list), id=[3,9,20]

(optional) try: # Retrieves a list of all shift-actions api_response = api_instance.get_shift_actions(filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling LookupsApi->getShiftActions: %s\n" % e)

Parameters

Query parameters
Name Description
filters
String
filters, please use variable name as the paramter, i.e. title=cleaning. Valid options for filter are <P> Equals, title=cleaning<BR/> Does not equal, title=not:cleaning<BR/> Greater than, id=gt:10<BR/> Less than, id=lt:10<BR/> Greater or equal than, id=gte:10<BR/> Less or equal to, id=lte:10<BR/> Between, id=[10:20]<BR/> One of the options (value in list), id=[3,9,20] </P>

Responses

Status: 200 - All available shift actions

Status: 401 - Unauthorised


getVenues

Retrieves a list of all venues

Retrieves a list of all venues that are available to your user


/venues

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/venues?filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LookupsApi;

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

public class LookupsApiExample {

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


        LookupsApi apiInstance = new LookupsApi();
        String filters = filters_example; // String | filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are 

Equals, title=ABC
Does not equal, title=not:ABC
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[5:10]
One of the options (value in list), id=[5,7,9]

try { inline_response_200_6 result = apiInstance.getVenues(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LookupsApi#getVenues"); e.printStackTrace(); } } }
import io.swagger.client.api.LookupsApi;

public class LookupsApiExample {

    public static void main(String[] args) {
        LookupsApi apiInstance = new LookupsApi();
        String filters = filters_example; // String | filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are 

Equals, title=ABC
Does not equal, title=not:ABC
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[5:10]
One of the options (value in list), id=[5,7,9]

try { inline_response_200_6 result = apiInstance.getVenues(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LookupsApi#getVenues"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *filters = filters_example; // filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are 

Equals, title=ABC
Does not equal, title=not:ABC
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[5:10]
One of the options (value in list), id=[5,7,9]

(optional) LookupsApi *apiInstance = [[LookupsApi alloc] init]; // Retrieves a list of all venues [apiInstance getVenuesWith:filters completionHandler: ^(inline_response_200_6 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.LookupsApi()
var opts = { 
  'filters': filters_example // {{String}} filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are 

Equals, title=ABC
Does not equal, title=not:ABC
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[5:10]
One of the options (value in list), id=[5,7,9]

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

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


            var apiInstance = new LookupsApi();
            var filters = filters_example;  // String | filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are 

Equals, title=ABC
Does not equal, title=not:ABC
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[5:10]
One of the options (value in list), id=[5,7,9]

(optional) try { // Retrieves a list of all venues inline_response_200_6 result = apiInstance.getVenues(filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling LookupsApi.getVenues: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiLookupsApi();
$filters = filters_example; // String | filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are 

Equals, title=ABC
Does not equal, title=not:ABC
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[5:10]
One of the options (value in list), id=[5,7,9]

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


my $api_instance = WWW::SwaggerClient::LookupsApi->new();
my $filters = filters_example; # String | filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are 

Equals, title=ABC
Does not equal, title=not:ABC
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[5:10]
One of the options (value in list), id=[5,7,9]

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


# create an instance of the API class
api_instance = swagger_client.LookupsApi()
filters = filters_example # String | filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are 

Equals, title=ABC
Does not equal, title=not:ABC
Greater than, id=gt:10
Less than, id=lt:10
Greater or equal than, id=gte:10
Less or equal to, id=lte:10
Between, id=[5:10]
One of the options (value in list), id=[5,7,9]

(optional) try: # Retrieves a list of all venues api_response = api_instance.get_venues(filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling LookupsApi->getVenues: %s\n" % e)

Parameters

Query parameters
Name Description
filters
String
filters, please use variable name as the parameter, i.e. title=office. Valid options for filter are <P> Equals, title=ABC<BR/> Does not equal, title=not:ABC<BR/> Greater than, id=gt:10<BR/> Less than, id=lt:10<BR/> Greater or equal than, id=gte:10<BR/> Less or equal to, id=lte:10<BR/> Between, id=[5:10]<BR/> One of the options (value in list), id=[5,7,9] </P>

Responses

Status: 200 - All available venues

Status: 401 - Unauthorised


My

getMyShift

Retrieve an individual shift item

Retrieve an individual shift item


/my/shifts/{shiftid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/my/shifts/{shiftid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MyApi;

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

public class MyApiExample {

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


        MyApi apiInstance = new MyApi();
        Integer shiftid = 56; // Integer | individual shift id
        try {
            inline_response_200_4 result = apiInstance.getMyShift(shiftid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MyApi#getMyShift");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MyApi;

public class MyApiExample {

    public static void main(String[] args) {
        MyApi apiInstance = new MyApi();
        Integer shiftid = 56; // Integer | individual shift id
        try {
            inline_response_200_4 result = apiInstance.getMyShift(shiftid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MyApi#getMyShift");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *shiftid = 56; // individual shift id

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

// Retrieve an individual shift item
[apiInstance getMyShiftWith:shiftid
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.MyApi()
var shiftid = 56; // {{Integer}} individual shift id

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

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


            var apiInstance = new MyApi();
            var shiftid = 56;  // Integer | individual shift id

            try
            {
                // Retrieve an individual shift item
                inline_response_200_4 result = apiInstance.getMyShift(shiftid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MyApi.getMyShift: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMyApi();
$shiftid = 56; // Integer | individual shift id

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


my $api_instance = WWW::SwaggerClient::MyApi->new();
my $shiftid = 56; # Integer | individual shift id

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


# create an instance of the API class
api_instance = swagger_client.MyApi()
shiftid = 56 # Integer | individual shift id

try: 
    # Retrieve an individual shift item
    api_response = api_instance.get_my_shift(shiftid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MyApi->getMyShift: %s\n" % e)

Parameters

Path parameters
Name Description
shiftid*
Integer
individual shift id
Required

Responses

Status: 200 - Individual shift record

Status: 400 - bad input parameter


getMyShifts

Retrieves a list of my shifts

Retrieves a list of all my shifts


/my/shifts

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/my/shifts?filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MyApi;

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

public class MyApiExample {

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


        MyApi apiInstance = new MyApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are 

Equals, group=10
Does not equal, group=not:10
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,7,15]

try { inline_response_200_4 result = apiInstance.getMyShifts(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MyApi#getMyShifts"); e.printStackTrace(); } } }
import io.swagger.client.api.MyApi;

public class MyApiExample {

    public static void main(String[] args) {
        MyApi apiInstance = new MyApi();
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are 

Equals, group=10
Does not equal, group=not:10
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,7,15]

try { inline_response_200_4 result = apiInstance.getMyShifts(filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MyApi#getMyShifts"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *filters = filters_example; // filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are 

Equals, group=10
Does not equal, group=not:10
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,7,15]

(optional) MyApi *apiInstance = [[MyApi alloc] init]; // Retrieves a list of my shifts [apiInstance getMyShiftsWith:filters completionHandler: ^(inline_response_200_4 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.MyApi()
var opts = { 
  'filters': filters_example // {{String}} filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are 

Equals, group=10
Does not equal, group=not:10
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,7,15]

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

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


            var apiInstance = new MyApi();
            var filters = filters_example;  // String | filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are 

Equals, group=10
Does not equal, group=not:10
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,7,15]

(optional) try { // Retrieves a list of my shifts inline_response_200_4 result = apiInstance.getMyShifts(filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling MyApi.getMyShifts: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMyApi();
$filters = filters_example; // String | filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are 

Equals, group=10
Does not equal, group=not:10
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,7,15]

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


my $api_instance = WWW::SwaggerClient::MyApi->new();
my $filters = filters_example; # String | filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are 

Equals, group=10
Does not equal, group=not:10
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,7,15]

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


# create an instance of the API class
api_instance = swagger_client.MyApi()
filters = filters_example # String | filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are 

Equals, group=10
Does not equal, group=not:10
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,7,15]

(optional) try: # Retrieves a list of my shifts api_response = api_instance.get_my_shifts(filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling MyApi->getMyShifts: %s\n" % e)

Parameters

Query parameters
Name Description
filters
String
filters, please use variable name as the paramter, i.e. venue=5. Valid options for filter are <P> Equals, group=10<BR/> Does not equal, group=not:10<BR/> Greater than, start=gt:2025-01-01<BR/> Less than, start=lt:2025-01-01<BR/> Greater or equal than, start=gte:2025-01-01<BR/> Less or equal to, start=lte:2025-01-01<BR/> Between, start=[2025-01-01:2026-01-01]<BR/> One of the options (value in list), venue=[1,7,15] </P>

Responses

Status: 200 - All available shifts

Status: 401 - Unauthorised


updateMyShift

Update shift details

Updates shift item


/my/shifts/{shiftid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/my/shifts/{shiftid}?external-worker-name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MyApi;

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

public class MyApiExample {

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


        MyApi apiInstance = new MyApi();
        Integer shiftid = 56; // Integer | individual shift id
        String externalWorkerName = externalWorkerName_example; // String | Name of the external worker
        try {
            apiInstance.updateMyShift(shiftid, externalWorkerName);
        } catch (ApiException e) {
            System.err.println("Exception when calling MyApi#updateMyShift");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MyApi;

public class MyApiExample {

    public static void main(String[] args) {
        MyApi apiInstance = new MyApi();
        Integer shiftid = 56; // Integer | individual shift id
        String externalWorkerName = externalWorkerName_example; // String | Name of the external worker
        try {
            apiInstance.updateMyShift(shiftid, externalWorkerName);
        } catch (ApiException e) {
            System.err.println("Exception when calling MyApi#updateMyShift");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *shiftid = 56; // individual shift id
String *externalWorkerName = externalWorkerName_example; // Name of the external worker

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

// Update shift details
[apiInstance updateMyShiftWith:shiftid
    externalWorkerName:externalWorkerName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.MyApi()
var shiftid = 56; // {{Integer}} individual shift id
var externalWorkerName = externalWorkerName_example; // {{String}} Name of the external worker

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

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


            var apiInstance = new MyApi();
            var shiftid = 56;  // Integer | individual shift id
            var externalWorkerName = externalWorkerName_example;  // String | Name of the external worker

            try
            {
                // Update shift details
                apiInstance.updateMyShift(shiftid, externalWorkerName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MyApi.updateMyShift: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMyApi();
$shiftid = 56; // Integer | individual shift id
$externalWorkerName = externalWorkerName_example; // String | Name of the external worker

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


my $api_instance = WWW::SwaggerClient::MyApi->new();
my $shiftid = 56; # Integer | individual shift id
my $externalWorkerName = externalWorkerName_example; # String | Name of the external worker

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


# create an instance of the API class
api_instance = swagger_client.MyApi()
shiftid = 56 # Integer | individual shift id
externalWorkerName = externalWorkerName_example # String | Name of the external worker

try: 
    # Update shift details
    api_instance.update_my_shift(shiftid, externalWorkerName)
except ApiException as e:
    print("Exception when calling MyApi->updateMyShift: %s\n" % e)

Parameters

Path parameters
Name Description
shiftid*
Integer
individual shift id
Required
Query parameters
Name Description
external-worker-name*
String
Name of the external worker
Required

Responses

Status: 201 - shift updated

Status: 304 - shift not modified


updateMyShiftAction

Update an issue action on my shift

Updates an issue action on a shift item


/my/shifts/{shiftid}/action

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/my/shifts/{shiftid}/action?_action="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MyApi;

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

public class MyApiExample {

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


        MyApi apiInstance = new MyApi();
        Integer shiftid = 56; // Integer | individual shift id
        _action_1 action = ; // _action_1 | action to carry out
        try {
            apiInstance.updateMyShiftAction(shiftid, action);
        } catch (ApiException e) {
            System.err.println("Exception when calling MyApi#updateMyShiftAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MyApi;

public class MyApiExample {

    public static void main(String[] args) {
        MyApi apiInstance = new MyApi();
        Integer shiftid = 56; // Integer | individual shift id
        _action_1 action = ; // _action_1 | action to carry out
        try {
            apiInstance.updateMyShiftAction(shiftid, action);
        } catch (ApiException e) {
            System.err.println("Exception when calling MyApi#updateMyShiftAction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *shiftid = 56; // individual shift id
_action_1 *action = ; // action to carry out

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

// Update an issue action on my shift
[apiInstance updateMyShiftActionWith:shiftid
    action:action
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.MyApi()
var shiftid = 56; // {{Integer}} individual shift id
var action = ; // {{_action_1}} action to carry out

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

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


            var apiInstance = new MyApi();
            var shiftid = 56;  // Integer | individual shift id
            var action = new _action_1(); // _action_1 | action to carry out

            try
            {
                // Update an issue action on my shift
                apiInstance.updateMyShiftAction(shiftid, action);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MyApi.updateMyShiftAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMyApi();
$shiftid = 56; // Integer | individual shift id
$action = ; // _action_1 | action to carry out

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


my $api_instance = WWW::SwaggerClient::MyApi->new();
my $shiftid = 56; # Integer | individual shift id
my $action = ; # _action_1 | action to carry out

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


# create an instance of the API class
api_instance = swagger_client.MyApi()
shiftid = 56 # Integer | individual shift id
action =  # _action_1 | action to carry out

try: 
    # Update an issue action on my shift
    api_instance.update_my_shift_action(shiftid, action)
except ApiException as e:
    print("Exception when calling MyApi->updateMyShiftAction: %s\n" % e)

Parameters

Path parameters
Name Description
shiftid*
Integer
individual shift id
Required
Query parameters
Name Description
_action*
_action_1
action to carry out
Required

Responses

Status: 201 - shift action updated

Status: 304 - shift action not modified


Shifts

getShift

Retrieve an individual shift item

Get an individual shift item


/shifts/{shiftid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/shifts/{shiftid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShiftsApi;

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

public class ShiftsApiExample {

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


        ShiftsApi apiInstance = new ShiftsApi();
        Integer shiftid = 56; // Integer | individual shift id
        try {
            inline_response_200_4 result = apiInstance.getShift(shiftid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShiftsApi#getShift");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShiftsApi;

public class ShiftsApiExample {

    public static void main(String[] args) {
        ShiftsApi apiInstance = new ShiftsApi();
        Integer shiftid = 56; // Integer | individual shift id
        try {
            inline_response_200_4 result = apiInstance.getShift(shiftid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShiftsApi#getShift");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *shiftid = 56; // individual shift id

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

// Retrieve an individual shift item
[apiInstance getShiftWith:shiftid
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.ShiftsApi()
var shiftid = 56; // {{Integer}} individual shift id

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

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


            var apiInstance = new ShiftsApi();
            var shiftid = 56;  // Integer | individual shift id

            try
            {
                // Retrieve an individual shift item
                inline_response_200_4 result = apiInstance.getShift(shiftid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShiftsApi.getShift: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShiftsApi();
$shiftid = 56; // Integer | individual shift id

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


my $api_instance = WWW::SwaggerClient::ShiftsApi->new();
my $shiftid = 56; # Integer | individual shift id

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


# create an instance of the API class
api_instance = swagger_client.ShiftsApi()
shiftid = 56 # Integer | individual shift id

try: 
    # Retrieve an individual shift item
    api_response = api_instance.get_shift(shiftid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShiftsApi->getShift: %s\n" % e)

Parameters

Path parameters
Name Description
shiftid*
Integer
individual shift id
Required

Responses

Status: 200 - Individual shift record

Status: 400 - bad input parameter


getShiftHistory

Retrieve the changelog for a shift

Get an individual shift item changelog


/shifts/{shiftid}/history

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/shifts/{shiftid}/history?filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShiftsApi;

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

public class ShiftsApiExample {

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


        ShiftsApi apiInstance = new ShiftsApi();
        Integer shiftid = 56; // Integer | individual shift id
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are 

Equals, filter=value
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

try { inline_response_200_4 result = apiInstance.getShiftHistory(shiftid, filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ShiftsApi#getShiftHistory"); e.printStackTrace(); } } }
import io.swagger.client.api.ShiftsApi;

public class ShiftsApiExample {

    public static void main(String[] args) {
        ShiftsApi apiInstance = new ShiftsApi();
        Integer shiftid = 56; // Integer | individual shift id
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are 

Equals, filter=value
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

try { inline_response_200_4 result = apiInstance.getShiftHistory(shiftid, filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ShiftsApi#getShiftHistory"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
Integer *shiftid = 56; // individual shift id
String *filters = filters_example; // filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are 

Equals, filter=value
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

(optional) ShiftsApi *apiInstance = [[ShiftsApi alloc] init]; // Retrieve the changelog for a shift [apiInstance getShiftHistoryWith:shiftid filters:filters completionHandler: ^(inline_response_200_4 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.ShiftsApi()
var shiftid = 56; // {{Integer}} individual shift id
var opts = { 
  'filters': filters_example // {{String}} filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are 

Equals, filter=value
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

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

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


            var apiInstance = new ShiftsApi();
            var shiftid = 56;  // Integer | individual shift id
            var filters = filters_example;  // String | filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are 

Equals, filter=value
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

(optional) try { // Retrieve the changelog for a shift inline_response_200_4 result = apiInstance.getShiftHistory(shiftid, filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ShiftsApi.getShiftHistory: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShiftsApi();
$shiftid = 56; // Integer | individual shift id
$filters = filters_example; // String | filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are 

Equals, filter=value
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

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


my $api_instance = WWW::SwaggerClient::ShiftsApi->new();
my $shiftid = 56; # Integer | individual shift id
my $filters = filters_example; # String | filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are 

Equals, filter=value
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

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


# create an instance of the API class
api_instance = swagger_client.ShiftsApi()
shiftid = 56 # Integer | individual shift id
filters = filters_example # String | filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are 

Equals, filter=value
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

(optional) try: # Retrieve the changelog for a shift api_response = api_instance.get_shift_history(shiftid, filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling ShiftsApi->getShiftHistory: %s\n" % e)

Parameters

Path parameters
Name Description
shiftid*
Integer
individual shift id
Required
Query parameters
Name Description
filters
String
filters, please use variable name as the paramter, i.e. type=covered. Valid options for filter are <P> Equals, filter=value<BR/> Does not equal, filter=not:value<BR/> Greater than, filter=gt:value<BR/> Less than, filter=lt:value<BR/> Greater or equal than, filter=gte:value<BR/> Less or equal to, filter=lte:value<BR/> Between, filter=[valueStart:valueEnd]<BR/> One of the options (value in list), filter=[value1,value2,value3] </P>

Responses

Status: 200 - Individual shift record

Status: 400 - bad input parameter


getShifts

Retrieves a list of all shifts available

Retrieves a list of all shifts that are available to your user


/shifts

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/shifts?event=&filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShiftsApi;

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

public class ShiftsApiExample {

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


        ShiftsApi apiInstance = new ShiftsApi();
        Integer event = 56; // Integer | optional event filter
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are 

Equals, group=5
Does not equal, group=not:5
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,2,8]

try { inline_response_200_4 result = apiInstance.getShifts(event, filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ShiftsApi#getShifts"); e.printStackTrace(); } } }
import io.swagger.client.api.ShiftsApi;

public class ShiftsApiExample {

    public static void main(String[] args) {
        ShiftsApi apiInstance = new ShiftsApi();
        Integer event = 56; // Integer | optional event filter
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are 

Equals, group=5
Does not equal, group=not:5
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,2,8]

try { inline_response_200_4 result = apiInstance.getShifts(event, filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ShiftsApi#getShifts"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
Integer *event = 56; // optional event filter (optional)
String *filters = filters_example; // filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are 

Equals, group=5
Does not equal, group=not:5
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,2,8]

(optional) ShiftsApi *apiInstance = [[ShiftsApi alloc] init]; // Retrieves a list of all shifts available [apiInstance getShiftsWith:event filters:filters completionHandler: ^(inline_response_200_4 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.ShiftsApi()
var opts = { 
  'event': 56, // {{Integer}} optional event filter
  'filters': filters_example // {{String}} filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are 

Equals, group=5
Does not equal, group=not:5
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,2,8]

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

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


            var apiInstance = new ShiftsApi();
            var event = 56;  // Integer | optional event filter (optional) 
            var filters = filters_example;  // String | filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are 

Equals, group=5
Does not equal, group=not:5
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,2,8]

(optional) try { // Retrieves a list of all shifts available inline_response_200_4 result = apiInstance.getShifts(event, filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ShiftsApi.getShifts: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShiftsApi();
$event = 56; // Integer | optional event filter
$filters = filters_example; // String | filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are 

Equals, group=5
Does not equal, group=not:5
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,2,8]

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


my $api_instance = WWW::SwaggerClient::ShiftsApi->new();
my $event = 56; # Integer | optional event filter
my $filters = filters_example; # String | filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are 

Equals, group=5
Does not equal, group=not:5
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,2,8]

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


# create an instance of the API class
api_instance = swagger_client.ShiftsApi()
event = 56 # Integer | optional event filter (optional)
filters = filters_example # String | filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are 

Equals, group=5
Does not equal, group=not:5
Greater than, start=gt:2025-01-01
Less than, start=lt:2025-01-01
Greater or equal than, start=gte:2025-01-01
Less or equal to, start=lte:2025-01-01
Between, start=[2025-01-01:2026-01-01]
One of the options (value in list), venue=[1,2,8]

(optional) try: # Retrieves a list of all shifts available api_response = api_instance.get_shifts(event=event, filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling ShiftsApi->getShifts: %s\n" % e)

Parameters

Query parameters
Name Description
event
Integer
optional event filter
filters
String
filters, please use variable name as the paramter, i.e. group=5. Valid options for filter are <P> Equals, group=5<BR/> Does not equal, group=not:5<BR/> Greater than, start=gt:2025-01-01<BR/> Less than, start=lt:2025-01-01<BR/> Greater or equal than, start=gte:2025-01-01<BR/> Less or equal to, start=lte:2025-01-01<BR/> Between, start=[2025-01-01:2026-01-01]<BR/> One of the options (value in list), venue=[1,2,8] </P>

Responses

Status: 200 - All available shifts

Status: 401 - Unauthorised


newShift

Create a new shift record

Create a new shift record


/shifts/new

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/shifts/new?start=&end=&account=&group=&venue=&task="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShiftsApi;

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

public class ShiftsApiExample {

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


        ShiftsApi apiInstance = new ShiftsApi();
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String account = account_example; // String | id of staff member
        Integer group = 56; // Integer | id of group role
        Integer venue = 56; // Integer | id of venue
        Integer task = 56; // Integer | task id
        try {
            apiInstance.newShift(start, end, account, group, venue, task);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShiftsApi#newShift");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShiftsApi;

public class ShiftsApiExample {

    public static void main(String[] args) {
        ShiftsApi apiInstance = new ShiftsApi();
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String account = account_example; // String | id of staff member
        Integer group = 56; // Integer | id of group role
        Integer venue = 56; // Integer | id of venue
        Integer task = 56; // Integer | task id
        try {
            apiInstance.newShift(start, end, account, group, venue, task);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShiftsApi#newShift");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *start = start_example; // start (YYYY-MM-DD HH:MM:SS in local time)
String *end = end_example; // end (YYYY-MM-DD HH:MM:SS in local time)
String *account = account_example; // id of staff member
Integer *group = 56; // id of group role
Integer *venue = 56; // id of venue
Integer *task = 56; // task id (optional)

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

// Create a new shift record
[apiInstance newShiftWith:start
    end:end
    account:account
    group:group
    venue:venue
    task:task
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.ShiftsApi()
var start = start_example; // {{String}} start (YYYY-MM-DD HH:MM:SS in local time)
var end = end_example; // {{String}} end (YYYY-MM-DD HH:MM:SS in local time)
var account = account_example; // {{String}} id of staff member
var group = 56; // {{Integer}} id of group role
var venue = 56; // {{Integer}} id of venue
var opts = { 
  'task': 56 // {{Integer}} task id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.newShift(start, end, account, group, venue, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ShiftsApi();
            var start = start_example;  // String | start (YYYY-MM-DD HH:MM:SS in local time)
            var end = end_example;  // String | end (YYYY-MM-DD HH:MM:SS in local time)
            var account = account_example;  // String | id of staff member
            var group = 56;  // Integer | id of group role
            var venue = 56;  // Integer | id of venue
            var task = 56;  // Integer | task id (optional) 

            try
            {
                // Create a new shift record
                apiInstance.newShift(start, end, account, group, venue, task);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShiftsApi.newShift: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShiftsApi();
$start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
$end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
$account = account_example; // String | id of staff member
$group = 56; // Integer | id of group role
$venue = 56; // Integer | id of venue
$task = 56; // Integer | task id

try {
    $api_instance->newShift($start, $end, $account, $group, $venue, $task);
} catch (Exception $e) {
    echo 'Exception when calling ShiftsApi->newShift: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShiftsApi;


my $api_instance = WWW::SwaggerClient::ShiftsApi->new();
my $start = start_example; # String | start (YYYY-MM-DD HH:MM:SS in local time)
my $end = end_example; # String | end (YYYY-MM-DD HH:MM:SS in local time)
my $account = account_example; # String | id of staff member
my $group = 56; # Integer | id of group role
my $venue = 56; # Integer | id of venue
my $task = 56; # Integer | task id

eval { 
    $api_instance->newShift(start => $start, end => $end, account => $account, group => $group, venue => $venue, task => $task);
};
if ($@) {
    warn "Exception when calling ShiftsApi->newShift: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ShiftsApi()
start = start_example # String | start (YYYY-MM-DD HH:MM:SS in local time)
end = end_example # String | end (YYYY-MM-DD HH:MM:SS in local time)
account = account_example # String | id of staff member
group = 56 # Integer | id of group role
venue = 56 # Integer | id of venue
task = 56 # Integer | task id (optional)

try: 
    # Create a new shift record
    api_instance.new_shift(start, end, account, group, venue, task=task)
except ApiException as e:
    print("Exception when calling ShiftsApi->newShift: %s\n" % e)

Parameters

Query parameters
Name Description
start*
String
start (YYYY-MM-DD HH:MM:SS in local time)
Required
end*
String
end (YYYY-MM-DD HH:MM:SS in local time)
Required
account*
String
id of staff member
Required
group*
Integer
id of group role
Required
venue*
Integer
id of venue
Required
task
Integer
task id

Responses

Status: 201 - shift updated

Status: 304 - not modified


updateShift

Update Shift record

Updates shift item


/shifts/{shiftid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/shifts/{shiftid}?start=&end=&account=&group=&venue=&task="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShiftsApi;

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

public class ShiftsApiExample {

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


        ShiftsApi apiInstance = new ShiftsApi();
        Integer shiftid = 56; // Integer | individual shift id
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String account = account_example; // String | id of staff member
        Integer group = 56; // Integer | id of group role
        Integer venue = 56; // Integer | id of venue
        Integer task = 56; // Integer | task id
        try {
            apiInstance.updateShift(shiftid, start, end, account, group, venue, task);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShiftsApi#updateShift");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShiftsApi;

public class ShiftsApiExample {

    public static void main(String[] args) {
        ShiftsApi apiInstance = new ShiftsApi();
        Integer shiftid = 56; // Integer | individual shift id
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String account = account_example; // String | id of staff member
        Integer group = 56; // Integer | id of group role
        Integer venue = 56; // Integer | id of venue
        Integer task = 56; // Integer | task id
        try {
            apiInstance.updateShift(shiftid, start, end, account, group, venue, task);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShiftsApi#updateShift");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *shiftid = 56; // individual shift id
String *start = start_example; // start (YYYY-MM-DD HH:MM:SS in local time) (optional)
String *end = end_example; // end (YYYY-MM-DD HH:MM:SS in local time) (optional)
String *account = account_example; // id of staff member (optional)
Integer *group = 56; // id of group role (optional)
Integer *venue = 56; // id of venue (optional)
Integer *task = 56; // task id (optional)

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

// Update Shift record
[apiInstance updateShiftWith:shiftid
    start:start
    end:end
    account:account
    group:group
    venue:venue
    task:task
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.ShiftsApi()
var shiftid = 56; // {{Integer}} individual shift id
var opts = { 
  'start': start_example, // {{String}} start (YYYY-MM-DD HH:MM:SS in local time)
  'end': end_example, // {{String}} end (YYYY-MM-DD HH:MM:SS in local time)
  'account': account_example, // {{String}} id of staff member
  'group': 56, // {{Integer}} id of group role
  'venue': 56, // {{Integer}} id of venue
  'task': 56 // {{Integer}} task id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateShift(shiftid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ShiftsApi();
            var shiftid = 56;  // Integer | individual shift id
            var start = start_example;  // String | start (YYYY-MM-DD HH:MM:SS in local time) (optional) 
            var end = end_example;  // String | end (YYYY-MM-DD HH:MM:SS in local time) (optional) 
            var account = account_example;  // String | id of staff member (optional) 
            var group = 56;  // Integer | id of group role (optional) 
            var venue = 56;  // Integer | id of venue (optional) 
            var task = 56;  // Integer | task id (optional) 

            try
            {
                // Update Shift record
                apiInstance.updateShift(shiftid, start, end, account, group, venue, task);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShiftsApi.updateShift: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiShiftsApi();
$shiftid = 56; // Integer | individual shift id
$start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
$end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
$account = account_example; // String | id of staff member
$group = 56; // Integer | id of group role
$venue = 56; // Integer | id of venue
$task = 56; // Integer | task id

try {
    $api_instance->updateShift($shiftid, $start, $end, $account, $group, $venue, $task);
} catch (Exception $e) {
    echo 'Exception when calling ShiftsApi->updateShift: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShiftsApi;


my $api_instance = WWW::SwaggerClient::ShiftsApi->new();
my $shiftid = 56; # Integer | individual shift id
my $start = start_example; # String | start (YYYY-MM-DD HH:MM:SS in local time)
my $end = end_example; # String | end (YYYY-MM-DD HH:MM:SS in local time)
my $account = account_example; # String | id of staff member
my $group = 56; # Integer | id of group role
my $venue = 56; # Integer | id of venue
my $task = 56; # Integer | task id

eval { 
    $api_instance->updateShift(shiftid => $shiftid, start => $start, end => $end, account => $account, group => $group, venue => $venue, task => $task);
};
if ($@) {
    warn "Exception when calling ShiftsApi->updateShift: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ShiftsApi()
shiftid = 56 # Integer | individual shift id
start = start_example # String | start (YYYY-MM-DD HH:MM:SS in local time) (optional)
end = end_example # String | end (YYYY-MM-DD HH:MM:SS in local time) (optional)
account = account_example # String | id of staff member (optional)
group = 56 # Integer | id of group role (optional)
venue = 56 # Integer | id of venue (optional)
task = 56 # Integer | task id (optional)

try: 
    # Update Shift record
    api_instance.update_shift(shiftid, start=start, end=end, account=account, group=group, venue=venue, task=task)
except ApiException as e:
    print("Exception when calling ShiftsApi->updateShift: %s\n" % e)

Parameters

Path parameters
Name Description
shiftid*
Integer
individual shift id
Required
Query parameters
Name Description
start
String
start (YYYY-MM-DD HH:MM:SS in local time)
end
String
end (YYYY-MM-DD HH:MM:SS in local time)
account
String
id of staff member
group
Integer
id of group role
venue
Integer
id of venue
task
Integer
task id

Responses

Status: 201 - shift updated

Status: 304 - not modified


TimeEntries

getTimeEntries

Retrieves a list of all time entries

Retrieves a list of all time entries that are available to your user


/time-entries

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/time-entries?event=&filters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeEntriesApi;

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

public class TimeEntriesApiExample {

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


        TimeEntriesApi apiInstance = new TimeEntriesApi();
        Integer event = 56; // Integer | optional event filter
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are 

Equals, account=10
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

try { inline_response_200_5 result = apiInstance.getTimeEntries(event, filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TimeEntriesApi#getTimeEntries"); e.printStackTrace(); } } }
import io.swagger.client.api.TimeEntriesApi;

public class TimeEntriesApiExample {

    public static void main(String[] args) {
        TimeEntriesApi apiInstance = new TimeEntriesApi();
        Integer event = 56; // Integer | optional event filter
        String filters = filters_example; // String | filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are 

Equals, account=10
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

try { inline_response_200_5 result = apiInstance.getTimeEntries(event, filters); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TimeEntriesApi#getTimeEntries"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
Integer *event = 56; // optional event filter (optional)
String *filters = filters_example; // filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are 

Equals, account=10
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

(optional) TimeEntriesApi *apiInstance = [[TimeEntriesApi alloc] init]; // Retrieves a list of all time entries [apiInstance getTimeEntriesWith:event filters:filters completionHandler: ^(inline_response_200_5 output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.TimeEntriesApi()
var opts = { 
  'event': 56, // {{Integer}} optional event filter
  'filters': filters_example // {{String}} filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are 

Equals, account=10
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

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

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


            var apiInstance = new TimeEntriesApi();
            var event = 56;  // Integer | optional event filter (optional) 
            var filters = filters_example;  // String | filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are 

Equals, account=10
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

(optional) try { // Retrieves a list of all time entries inline_response_200_5 result = apiInstance.getTimeEntries(event, filters); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling TimeEntriesApi.getTimeEntries: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiTimeEntriesApi();
$event = 56; // Integer | optional event filter
$filters = filters_example; // String | filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are 

Equals, account=10
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

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


my $api_instance = WWW::SwaggerClient::TimeEntriesApi->new();
my $event = 56; # Integer | optional event filter
my $filters = filters_example; # String | filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are 

Equals, account=10
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

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


# create an instance of the API class
api_instance = swagger_client.TimeEntriesApi()
event = 56 # Integer | optional event filter (optional)
filters = filters_example # String | filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are 

Equals, account=10
Does not equal, filter=not:value
Greater than, filter=gt:value
Less than, filter=lt:value
Greater or equal than, filter=gte:value
Less or equal to, filter=lte:value
Between, filter=[valueStart:valueEnd]
One of the options (value in list), filter=[value1,value2,value3]

(optional) try: # Retrieves a list of all time entries api_response = api_instance.get_time_entries(event=event, filters=filters) pprint(api_response) except ApiException as e: print("Exception when calling TimeEntriesApi->getTimeEntries: %s\n" % e)

Parameters

Query parameters
Name Description
event
Integer
optional event filter
filters
String
filters, please use variable name as the paramter, i.e. account=10. Valid options for filter are <P> Equals, account=10<BR/> Does not equal, filter=not:value<BR/> Greater than, filter=gt:value<BR/> Less than, filter=lt:value<BR/> Greater or equal than, filter=gte:value<BR/> Less or equal to, filter=lte:value<BR/> Between, filter=[valueStart:valueEnd]<BR/> One of the options (value in list), filter=[value1,value2,value3] </P>

Responses

Status: 200 - All available time entries

Status: 401 - Unauthorised


getTimeEntry

Retrieves a single time entry

Retrieves a single time entry from it's id


/time-entries/{entryid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/time-entries/{entryid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeEntriesApi;

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

public class TimeEntriesApiExample {

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


        TimeEntriesApi apiInstance = new TimeEntriesApi();
        Integer entryid = 56; // Integer | individual entry id
        try {
            inline_response_200_5 result = apiInstance.getTimeEntry(entryid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeEntriesApi#getTimeEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeEntriesApi;

public class TimeEntriesApiExample {

    public static void main(String[] args) {
        TimeEntriesApi apiInstance = new TimeEntriesApi();
        Integer entryid = 56; // Integer | individual entry id
        try {
            inline_response_200_5 result = apiInstance.getTimeEntry(entryid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeEntriesApi#getTimeEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *entryid = 56; // individual entry id

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

// Retrieves a single time entry
[apiInstance getTimeEntryWith:entryid
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.TimeEntriesApi()
var entryid = 56; // {{Integer}} individual entry id

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

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


            var apiInstance = new TimeEntriesApi();
            var entryid = 56;  // Integer | individual entry id

            try
            {
                // Retrieves a single time entry
                inline_response_200_5 result = apiInstance.getTimeEntry(entryid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeEntriesApi.getTimeEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiTimeEntriesApi();
$entryid = 56; // Integer | individual entry id

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


my $api_instance = WWW::SwaggerClient::TimeEntriesApi->new();
my $entryid = 56; # Integer | individual entry id

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


# create an instance of the API class
api_instance = swagger_client.TimeEntriesApi()
entryid = 56 # Integer | individual entry id

try: 
    # Retrieves a single time entry
    api_response = api_instance.get_time_entry(entryid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeEntriesApi->getTimeEntry: %s\n" % e)

Parameters

Path parameters
Name Description
entryid*
Integer
individual entry id
Required

Responses

Status: 200 - An individual time entry

Status: 401 - Unauthorised


getTimeEntryHistory

Retrieves a single time entry's changelog

Retrieves a single time entry's history from it's id


/time-entries/{entryid}/history

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/time-entries/{entryid}/history"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeEntriesApi;

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

public class TimeEntriesApiExample {

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


        TimeEntriesApi apiInstance = new TimeEntriesApi();
        Integer entryid = 56; // Integer | individual entry id
        try {
            inline_response_200_5 result = apiInstance.getTimeEntryHistory(entryid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeEntriesApi#getTimeEntryHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeEntriesApi;

public class TimeEntriesApiExample {

    public static void main(String[] args) {
        TimeEntriesApi apiInstance = new TimeEntriesApi();
        Integer entryid = 56; // Integer | individual entry id
        try {
            inline_response_200_5 result = apiInstance.getTimeEntryHistory(entryid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeEntriesApi#getTimeEntryHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *entryid = 56; // individual entry id

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

// Retrieves a single time entry's changelog
[apiInstance getTimeEntryHistoryWith:entryid
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.TimeEntriesApi()
var entryid = 56; // {{Integer}} individual entry id

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

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


            var apiInstance = new TimeEntriesApi();
            var entryid = 56;  // Integer | individual entry id

            try
            {
                // Retrieves a single time entry's changelog
                inline_response_200_5 result = apiInstance.getTimeEntryHistory(entryid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeEntriesApi.getTimeEntryHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiTimeEntriesApi();
$entryid = 56; // Integer | individual entry id

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


my $api_instance = WWW::SwaggerClient::TimeEntriesApi->new();
my $entryid = 56; # Integer | individual entry id

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


# create an instance of the API class
api_instance = swagger_client.TimeEntriesApi()
entryid = 56 # Integer | individual entry id

try: 
    # Retrieves a single time entry's changelog
    api_response = api_instance.get_time_entry_history(entryid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TimeEntriesApi->getTimeEntryHistory: %s\n" % e)

Parameters

Path parameters
Name Description
entryid*
Integer
individual entry id
Required

Responses

Status: 200 - Historic changelog for a time entry

Status: 401 - Unauthorised


newTimeEntry

Create a new time-entry record

Add a new time entry record


/time-entries/new

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/time-entries/new?start=&end=&account=&group=&venue=&pay-element="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeEntriesApi;

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

public class TimeEntriesApiExample {

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


        TimeEntriesApi apiInstance = new TimeEntriesApi();
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String account = account_example; // String | id of staff member
        Integer group = 56; // Integer | id of group role
        Integer venue = 56; // Integer | id of venue
        Integer payElement = 56; // Integer | pay element id
        try {
            apiInstance.newTimeEntry(start, end, account, group, venue, payElement);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeEntriesApi#newTimeEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeEntriesApi;

public class TimeEntriesApiExample {

    public static void main(String[] args) {
        TimeEntriesApi apiInstance = new TimeEntriesApi();
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String account = account_example; // String | id of staff member
        Integer group = 56; // Integer | id of group role
        Integer venue = 56; // Integer | id of venue
        Integer payElement = 56; // Integer | pay element id
        try {
            apiInstance.newTimeEntry(start, end, account, group, venue, payElement);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeEntriesApi#newTimeEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *start = start_example; // start (YYYY-MM-DD HH:MM:SS in local time)
String *end = end_example; // end (YYYY-MM-DD HH:MM:SS in local time)
String *account = account_example; // id of staff member
Integer *group = 56; // id of group role
Integer *venue = 56; // id of venue
Integer *payElement = 56; // pay element id

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

// Create a new time-entry record
[apiInstance newTimeEntryWith:start
    end:end
    account:account
    group:group
    venue:venue
    payElement:payElement
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.TimeEntriesApi()
var start = start_example; // {{String}} start (YYYY-MM-DD HH:MM:SS in local time)
var end = end_example; // {{String}} end (YYYY-MM-DD HH:MM:SS in local time)
var account = account_example; // {{String}} id of staff member
var group = 56; // {{Integer}} id of group role
var venue = 56; // {{Integer}} id of venue
var payElement = 56; // {{Integer}} pay element id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.newTimeEntry(start, end, account, group, venue, payElement, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new TimeEntriesApi();
            var start = start_example;  // String | start (YYYY-MM-DD HH:MM:SS in local time)
            var end = end_example;  // String | end (YYYY-MM-DD HH:MM:SS in local time)
            var account = account_example;  // String | id of staff member
            var group = 56;  // Integer | id of group role
            var venue = 56;  // Integer | id of venue
            var payElement = 56;  // Integer | pay element id

            try
            {
                // Create a new time-entry record
                apiInstance.newTimeEntry(start, end, account, group, venue, payElement);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeEntriesApi.newTimeEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiTimeEntriesApi();
$start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
$end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
$account = account_example; // String | id of staff member
$group = 56; // Integer | id of group role
$venue = 56; // Integer | id of venue
$payElement = 56; // Integer | pay element id

try {
    $api_instance->newTimeEntry($start, $end, $account, $group, $venue, $payElement);
} catch (Exception $e) {
    echo 'Exception when calling TimeEntriesApi->newTimeEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeEntriesApi;


my $api_instance = WWW::SwaggerClient::TimeEntriesApi->new();
my $start = start_example; # String | start (YYYY-MM-DD HH:MM:SS in local time)
my $end = end_example; # String | end (YYYY-MM-DD HH:MM:SS in local time)
my $account = account_example; # String | id of staff member
my $group = 56; # Integer | id of group role
my $venue = 56; # Integer | id of venue
my $payElement = 56; # Integer | pay element id

eval { 
    $api_instance->newTimeEntry(start => $start, end => $end, account => $account, group => $group, venue => $venue, payElement => $payElement);
};
if ($@) {
    warn "Exception when calling TimeEntriesApi->newTimeEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.TimeEntriesApi()
start = start_example # String | start (YYYY-MM-DD HH:MM:SS in local time)
end = end_example # String | end (YYYY-MM-DD HH:MM:SS in local time)
account = account_example # String | id of staff member
group = 56 # Integer | id of group role
venue = 56 # Integer | id of venue
payElement = 56 # Integer | pay element id

try: 
    # Create a new time-entry record
    api_instance.new_time_entry(start, end, account, group, venue, payElement)
except ApiException as e:
    print("Exception when calling TimeEntriesApi->newTimeEntry: %s\n" % e)

Parameters

Query parameters
Name Description
start*
String
start (YYYY-MM-DD HH:MM:SS in local time)
Required
end*
String
end (YYYY-MM-DD HH:MM:SS in local time)
Required
account*
String
id of staff member
Required
group*
Integer
id of group role
Required
venue*
Integer
id of venue
Required
pay-element*
Integer
pay element id
Required

Responses

Status: 201 - shift updated

Status: 304 - not modified


updateTimeEntry

Update a time-entry record

Updates a time-entry item


/time-entries/{entryid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"https://virtserver.swaggerhub.com/SmartBlue/StaffSavvy/1.0.2/time-entries/{entryid}?start=&end=&account=&group=&venue=&pay-element="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TimeEntriesApi;

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

public class TimeEntriesApiExample {

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


        TimeEntriesApi apiInstance = new TimeEntriesApi();
        Integer entryid = 56; // Integer | individual time-entry id
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String account = account_example; // String | id of staff member
        Integer group = 56; // Integer | id of group role
        Integer venue = 56; // Integer | id of venue
        Integer payElement = 56; // Integer | pay element id
        try {
            apiInstance.updateTimeEntry(entryid, start, end, account, group, venue, payElement);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeEntriesApi#updateTimeEntry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TimeEntriesApi;

public class TimeEntriesApiExample {

    public static void main(String[] args) {
        TimeEntriesApi apiInstance = new TimeEntriesApi();
        Integer entryid = 56; // Integer | individual time-entry id
        String start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
        String end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
        String account = account_example; // String | id of staff member
        Integer group = 56; // Integer | id of group role
        Integer venue = 56; // Integer | id of venue
        Integer payElement = 56; // Integer | pay element id
        try {
            apiInstance.updateTimeEntry(entryid, start, end, account, group, venue, payElement);
        } catch (ApiException e) {
            System.err.println("Exception when calling TimeEntriesApi#updateTimeEntry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *entryid = 56; // individual time-entry id
String *start = start_example; // start (YYYY-MM-DD HH:MM:SS in local time) (optional)
String *end = end_example; // end (YYYY-MM-DD HH:MM:SS in local time) (optional)
String *account = account_example; // id of staff member (optional)
Integer *group = 56; // id of group role (optional)
Integer *venue = 56; // id of venue (optional)
Integer *payElement = 56; // pay element id (optional)

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

// Update a time-entry record
[apiInstance updateTimeEntryWith:entryid
    start:start
    end:end
    account:account
    group:group
    venue:venue
    payElement:payElement
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var StaffSavvyRestApi = require('staff_savvy_rest_api');
var defaultClient = StaffSavvyRestApi.ApiClient.instance;


var api = new StaffSavvyRestApi.TimeEntriesApi()
var entryid = 56; // {{Integer}} individual time-entry id
var opts = { 
  'start': start_example, // {{String}} start (YYYY-MM-DD HH:MM:SS in local time)
  'end': end_example, // {{String}} end (YYYY-MM-DD HH:MM:SS in local time)
  'account': account_example, // {{String}} id of staff member
  'group': 56, // {{Integer}} id of group role
  'venue': 56, // {{Integer}} id of venue
  'payElement': 56 // {{Integer}} pay element id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateTimeEntry(entryid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new TimeEntriesApi();
            var entryid = 56;  // Integer | individual time-entry id
            var start = start_example;  // String | start (YYYY-MM-DD HH:MM:SS in local time) (optional) 
            var end = end_example;  // String | end (YYYY-MM-DD HH:MM:SS in local time) (optional) 
            var account = account_example;  // String | id of staff member (optional) 
            var group = 56;  // Integer | id of group role (optional) 
            var venue = 56;  // Integer | id of venue (optional) 
            var payElement = 56;  // Integer | pay element id (optional) 

            try
            {
                // Update a time-entry record
                apiInstance.updateTimeEntry(entryid, start, end, account, group, venue, payElement);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TimeEntriesApi.updateTimeEntry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiTimeEntriesApi();
$entryid = 56; // Integer | individual time-entry id
$start = start_example; // String | start (YYYY-MM-DD HH:MM:SS in local time)
$end = end_example; // String | end (YYYY-MM-DD HH:MM:SS in local time)
$account = account_example; // String | id of staff member
$group = 56; // Integer | id of group role
$venue = 56; // Integer | id of venue
$payElement = 56; // Integer | pay element id

try {
    $api_instance->updateTimeEntry($entryid, $start, $end, $account, $group, $venue, $payElement);
} catch (Exception $e) {
    echo 'Exception when calling TimeEntriesApi->updateTimeEntry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TimeEntriesApi;


my $api_instance = WWW::SwaggerClient::TimeEntriesApi->new();
my $entryid = 56; # Integer | individual time-entry id
my $start = start_example; # String | start (YYYY-MM-DD HH:MM:SS in local time)
my $end = end_example; # String | end (YYYY-MM-DD HH:MM:SS in local time)
my $account = account_example; # String | id of staff member
my $group = 56; # Integer | id of group role
my $venue = 56; # Integer | id of venue
my $payElement = 56; # Integer | pay element id

eval { 
    $api_instance->updateTimeEntry(entryid => $entryid, start => $start, end => $end, account => $account, group => $group, venue => $venue, payElement => $payElement);
};
if ($@) {
    warn "Exception when calling TimeEntriesApi->updateTimeEntry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.TimeEntriesApi()
entryid = 56 # Integer | individual time-entry id
start = start_example # String | start (YYYY-MM-DD HH:MM:SS in local time) (optional)
end = end_example # String | end (YYYY-MM-DD HH:MM:SS in local time) (optional)
account = account_example # String | id of staff member (optional)
group = 56 # Integer | id of group role (optional)
venue = 56 # Integer | id of venue (optional)
payElement = 56 # Integer | pay element id (optional)

try: 
    # Update a time-entry record
    api_instance.update_time_entry(entryid, start=start, end=end, account=account, group=group, venue=venue, payElement=payElement)
except ApiException as e:
    print("Exception when calling TimeEntriesApi->updateTimeEntry: %s\n" % e)

Parameters

Path parameters
Name Description
entryid*
Integer
individual time-entry id
Required
Query parameters
Name Description
start
String
start (YYYY-MM-DD HH:MM:SS in local time)
end
String
end (YYYY-MM-DD HH:MM:SS in local time)
account
String
id of staff member
group
Integer
id of group role
venue
Integer
id of venue
pay-element
Integer
pay element id

Responses

Status: 201 - shift updated

Status: 304 - not modified