Workforce.Api.EmployeeApi

All URIs are relative to https://api.workforcehr.org

Method	HTTP request	Description
CreateOrUpdateEmployee	POST /v1/Employee	Add a new Employee to the Workforce system
DeleteEmployee	DELETE /v1/Employee	Delete an Employee from the Workforce system
GetEmployee	GET /v1/Employee/{id}	Get a specific Employee from Workforce
GetEmployeePhoto	GET /v1/Employee/employees/{employeeId}/photo	Get a single Employee Photo from Workforce
GetEmployees	GET /v1/Employee	Get all Employees within Workforce
SearchEmployees	GET /v1/Employee/search	Search for Employees within Workforce

CreateOrUpdateEmployee

Employee CreateOrUpdateEmployee (Employee employee = null)

Add a new Employee to the Workforce system

Example

using System.Collections.Generic;
using System.Diagnostics;
using Workforce.Api;
using Workforce.Client;
using Workforce.Model;

namespace Example
{
    public class CreateOrUpdateEmployeeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.workforcehr.org";
            // Configure OAuth2 access token for authorization: Bearer
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EmployeeApi(config);
            var employee = new Employee(); // Employee |  (optional) 

            try
            {
                // Add a new Employee to the Workforce system
                Employee result = apiInstance.CreateOrUpdateEmployee(employee);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmployeeApi.CreateOrUpdateEmployee: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
employee	Employee		[optional]

Return type

Employee

Authorization

Bearer

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Returns the newly created Employee	-
400	If the Employee is null	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEmployee

void DeleteEmployee (Guid? id = null)

Delete an Employee from the Workforce system

Example

using System.Collections.Generic;
using System.Diagnostics;
using Workforce.Api;
using Workforce.Client;
using Workforce.Model;

namespace Example
{
    public class DeleteEmployeeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.workforcehr.org";
            // Configure OAuth2 access token for authorization: Bearer
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EmployeeApi(config);
            var id = new Guid?(); // Guid? | The Id of the entity to delete (optional) 

            try
            {
                // Delete an Employee from the Workforce system
                apiInstance.DeleteEmployee(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmployeeApi.DeleteEmployee: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	Guid?	The Id of the entity to delete	[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	If the Employee was deleted	-
400	If the Id is null	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEmployee

Employee GetEmployee (Guid id)

Get a specific Employee from Workforce

Example

using System.Collections.Generic;
using System.Diagnostics;
using Workforce.Api;
using Workforce.Client;
using Workforce.Model;

namespace Example
{
    public class GetEmployeeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.workforcehr.org";
            // Configure OAuth2 access token for authorization: Bearer
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EmployeeApi(config);
            var id = new Guid(); // Guid | Unique ID of the Employee

            try
            {
                // Get a specific Employee from Workforce
                Employee result = apiInstance.GetEmployee(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmployeeApi.GetEmployee: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	Guid	Unique ID of the Employee

Return type

Employee

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the Employee	-
404	If the Employee doesn't exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEmployeePhoto

byte[] GetEmployeePhoto (Guid employeeId, int? height = null, int? width = null)

Get a single Employee Photo from Workforce

Example

using System.Collections.Generic;
using System.Diagnostics;
using Workforce.Api;
using Workforce.Client;
using Workforce.Model;

namespace Example
{
    public class GetEmployeePhotoExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.workforcehr.org";
            // Configure OAuth2 access token for authorization: Bearer
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EmployeeApi(config);
            var employeeId = new Guid(); // Guid | Unique ID of the Employee
            var height = 56;  // int? | Height in pixels of the image to be returned (optional) 
            var width = 56;  // int? | Width in pixels of the image to be returned (optional) 

            try
            {
                // Get a single Employee Photo from Workforce
                byte[] result = apiInstance.GetEmployeePhoto(employeeId, height, width);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmployeeApi.GetEmployeePhoto: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
employeeId	Guid	Unique ID of the Employee
height	int?	Height in pixels of the image to be returned	[optional]
width	int?	Width in pixels of the image to be returned	[optional]

Return type

byte[]

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the image	-
404	If the Employee doesn't exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEmployees

List<Employee> GetEmployees ()

Get all Employees within Workforce

Example

using System.Collections.Generic;
using System.Diagnostics;
using Workforce.Api;
using Workforce.Client;
using Workforce.Model;

namespace Example
{
    public class GetEmployeesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.workforcehr.org";
            // Configure OAuth2 access token for authorization: Bearer
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EmployeeApi(config);

            try
            {
                // Get all Employees within Workforce
                List<Employee> result = apiInstance.GetEmployees();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmployeeApi.GetEmployees: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List<Employee>

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the Employee list	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchEmployees

List<Employee> SearchEmployees (string firstName = null, string lastName = null)

Search for Employees within Workforce

Example

using System.Collections.Generic;
using System.Diagnostics;
using Workforce.Api;
using Workforce.Client;
using Workforce.Model;

namespace Example
{
    public class SearchEmployeesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.workforcehr.org";
            // Configure OAuth2 access token for authorization: Bearer
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EmployeeApi(config);
            var firstName = firstName_example;  // string |  (optional) 
            var lastName = lastName_example;  // string |  (optional) 

            try
            {
                // Search for Employees within Workforce
                List<Employee> result = apiInstance.SearchEmployees(firstName, lastName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmployeeApi.SearchEmployees: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
firstName	string		[optional]
lastName	string		[optional]

Return type

List<Employee>

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the Employee	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

EmployeeApi.md

Latest commit

History

EmployeeApi.md

File metadata and controls

Workforce.Api.EmployeeApi

CreateOrUpdateEmployee

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteEmployee

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetEmployee

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetEmployeePhoto

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetEmployees

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

SearchEmployees

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details