Skip to content

AbsenceApi.md

Latest commit

 

History

History
445 lines (346 loc) · 13.2 KB

AbsenceApi.md

File metadata and controls

445 lines (346 loc) · 13.2 KB

Workforce.Api.AbsenceApi

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

Method HTTP request Description
CreateOrUpdateAbsence POST /v1/Absence Add a new Absence to the Workforce system
DeleteAbsence DELETE /v1/Absence Delete an Absence from the Workforce system
GetAbsence GET /v1/Absence/{id} Get a specific Absence from Workforce
GetAbsences GET /v1/Absence Get all Absences within Workforce
GetAbsencesForEmployee GET /v1/Absence/Employee/{id} Get a list of Absences from workforce for a specific Employee
SearchAbsences GET /v1/Absence/Search Get a list of Absences from workforce that match the specified criteria

CreateOrUpdateAbsence

void CreateOrUpdateAbsence (Absence absence = null)

Add a new Absence 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 CreateOrUpdateAbsenceExample
    {
        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 AbsenceApi(config);
            var absence = new Absence(); // Absence |  (optional) 

            try
            {
                // Add a new Absence to the Workforce system
                apiInstance.CreateOrUpdateAbsence(absence);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AbsenceApi.CreateOrUpdateAbsence: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
absence Absence [optional]

Return type

void (empty response body)

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 Absence -
400 If the Absence is null -

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

DeleteAbsence

void DeleteAbsence (Guid? id = null)

Delete an Absence 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 DeleteAbsenceExample
    {
        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 AbsenceApi(config);
            var id = new Guid?(); // Guid? | The Id of the entity to delete (optional) 

            try
            {
                // Delete an Absence from the Workforce system
                apiInstance.DeleteAbsence(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AbsenceApi.DeleteAbsence: " + 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 Absence was deleted -
400 If the Id is null -

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

GetAbsence

Absence GetAbsence (Guid id)

Get a specific Absence from Workforce

Example

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

namespace Example
{
    public class GetAbsenceExample
    {
        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 AbsenceApi(config);
            var id = new Guid(); // Guid | Unique ID of the Absence

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

Parameters

Name Type Description Notes
id Guid Unique ID of the Absence

Return type

Absence

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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

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

GetAbsences

List<Absence> GetAbsences ()

Get all Absences within Workforce

Example

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

namespace Example
{
    public class GetAbsencesExample
    {
        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 AbsenceApi(config);

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

Parameters

This endpoint does not need any parameter.

Return type

List<Absence>

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns the Absence list -

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

GetAbsencesForEmployee

List<Absence> GetAbsencesForEmployee (Guid id)

Get a list of Absences from workforce for a specific Employee

Example

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

namespace Example
{
    public class GetAbsencesForEmployeeExample
    {
        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 AbsenceApi(config);
            var id = new Guid(); // Guid | Unique ID of the Employee

            try
            {
                // Get a list of Absences from workforce for a specific Employee
                List<Absence> result = apiInstance.GetAbsencesForEmployee(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AbsenceApi.GetAbsencesForEmployee: " + 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

List<Absence>

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns the Absences -
404 If the Employee doesn't exist or there are no absences -

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

SearchAbsences

List<Absence> SearchAbsences (Guid? employeeId = null, DateTime? dateFrom = null, DateTime? dateTo = null, string notes = null)

Get a list of Absences from workforce that match the specified criteria

Example

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

namespace Example
{
    public class SearchAbsencesExample
    {
        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 AbsenceApi(config);
            var employeeId = new Guid?(); // Guid? |  (optional) 
            var dateFrom = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var dateTo = 2013-10-20T19:20:30+01:00;  // DateTime? |  (optional) 
            var notes = notes_example;  // string |  (optional) 

            try
            {
                // Get a list of Absences from workforce that match the specified criteria
                List<Absence> result = apiInstance.SearchAbsences(employeeId, dateFrom, dateTo, notes);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AbsenceApi.SearchAbsences: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
employeeId Guid? [optional]
dateFrom DateTime? [optional]
dateTo DateTime? [optional]
notes string [optional]

Return type

List<Absence>

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns the Absences -
404 If there are no absences -

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