Skip to content

RGSAEmployeeApi.md

Latest commit

 

History

History
409 lines (287 loc) · 15.1 KB

RGSAEmployeeApi.md

File metadata and controls

409 lines (287 loc) · 15.1 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAEmployeeApi

All URIs are relative to https://saapi.realgreen.com

Method HTTP request Description
Invoke-RGSAEmployeeActiveActiveGet GET /Employee/Active/{active} Returns a list of employees who are or are not active based on the provided value.
Invoke-RGSAEmployeeApplicatorLicenseNumberApplicenseGet GET /Employee/ApplicatorLicenseNumber/{applicense} Returns a single employee record that has the provided application license number.
Invoke-RGSAEmployeeDepartmentDeptGet GET /Employee/Department/{dept} Returns a list of employees who are assigned to the provided department.
Invoke-RGSAEmployeeEmailEmailGet GET /Employee/Email/{email} Returns a single employee record that has the email provided.
Invoke-RGSAEmployeeGet GET /Employee Returns all employees in the database.
Invoke-RGSAEmployeeIdGet GET /Employee/{id} Returns a single employee record that correseponds with the provided ID.
Invoke-RGSAEmployeePositionPositionGet GET /Employee/Position/{position} Returns a list of employees who are assigned the provided position.
Invoke-RGSAEmployeeSimplePost POST /Employee/Simple Add a simple employee to the database. Employee is inactive. EmployeeID will be generated (FirstInitial,LastInitial,MMddyy) (Ex: RM082421) if not passed.
Invoke-RGSAEmployeeTruckTrackingConfigEmployeeIdGet GET /Employee/TruckTrackingConfig/{employeeId}

Invoke-RGSAEmployeeActiveActiveGet

APIEmployee[] Invoke-RGSAEmployeeActiveActiveGet
        [-Active]
        [-ApiKey]

Returns a list of employees who are or are not active based on the provided value.

Example

$Active = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of employees who are or are not active based on the provided value.
try {
    $Result = Invoke-RGSAEmployeeActiveActiveGet -Active $Active -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeeActiveActiveGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Active Boolean
ApiKey String API Key

Return type

APIEmployee[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAEmployeeApplicatorLicenseNumberApplicenseGet

APIEmployee Invoke-RGSAEmployeeApplicatorLicenseNumberApplicenseGet
        [-Applicense]
        [-ApiKey]

Returns a single employee record that has the provided application license number.

Example

$Applicense = "MyApplicense" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single employee record that has the provided application license number.
try {
    $Result = Invoke-RGSAEmployeeApplicatorLicenseNumberApplicenseGet -Applicense $Applicense -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeeApplicatorLicenseNumberApplicenseGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Applicense String
ApiKey String API Key

Return type

APIEmployee (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAEmployeeDepartmentDeptGet

APIEmployee[] Invoke-RGSAEmployeeDepartmentDeptGet
        [-Dept]
        [-ApiKey]

Returns a list of employees who are assigned to the provided department.

Example

$Dept = "MyDept" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of employees who are assigned to the provided department.
try {
    $Result = Invoke-RGSAEmployeeDepartmentDeptGet -Dept $Dept -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeeDepartmentDeptGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Dept String
ApiKey String API Key

Return type

APIEmployee[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAEmployeeEmailEmailGet

APIEmployee Invoke-RGSAEmployeeEmailEmailGet
        [-Email]
        [-ApiKey]

Returns a single employee record that has the email provided.

Example

$Email = "MyEmail" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single employee record that has the email provided.
try {
    $Result = Invoke-RGSAEmployeeEmailEmailGet -Email $Email -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeeEmailEmailGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Email String
ApiKey String API Key

Return type

APIEmployee (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAEmployeeGet

APIEmployee[] Invoke-RGSAEmployeeGet
        [-ApiKey]

Returns all employees in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

# Returns all employees in the database.
try {
    $Result = Invoke-RGSAEmployeeGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

APIEmployee[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAEmployeeIdGet

APIEmployee Invoke-RGSAEmployeeIdGet
        [-Id]
        [-ApiKey]

Returns a single employee record that correseponds with the provided ID.

Example

$Id = "MyId" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single employee record that correseponds with the provided ID.
try {
    $Result = Invoke-RGSAEmployeeIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeeIdGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Id String
ApiKey String API Key

Return type

APIEmployee (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAEmployeePositionPositionGet

APIEmployee[] Invoke-RGSAEmployeePositionPositionGet
        [-Position]
        [-ApiKey]

Returns a list of employees who are assigned the provided position.

Example

$Position = "MyPosition" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of employees who are assigned the provided position.
try {
    $Result = Invoke-RGSAEmployeePositionPositionGet -Position $Position -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeePositionPositionGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Position String
ApiKey String API Key

Return type

APIEmployee[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAEmployeeSimplePost

APIEmployee Invoke-RGSAEmployeeSimplePost
        [-ApiKey]
        [-APIEmployeeInsert]

Add a simple employee to the database. Employee is inactive. EmployeeID will be generated (FirstInitial,LastInitial,MMddyy) (Ex: RM082421) if not passed.

Example

$ApiKey = "MyApiKey" # String | API Key
$APIEmployeeInsert = Initialize-APIEmployeeInsert -EmployeeID "MyEmployeeID" -Name "MyName" -CompanyID 0 # APIEmployeeInsert |  (optional)

# Add a simple employee to the database. Employee is inactive. EmployeeID will be generated (FirstInitial,LastInitial,MMddyy) (Ex: RM082421) if not passed.
try {
    $Result = Invoke-RGSAEmployeeSimplePost -ApiKey $ApiKey -APIEmployeeInsert $APIEmployeeInsert
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeeSimplePost: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key
APIEmployeeInsert APIEmployeeInsert [optional]

Return type

APIEmployee (PSCustomObject)

Authorization

No authorization required

HTTP request headers

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

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

Invoke-RGSAEmployeeTruckTrackingConfigEmployeeIdGet

TelematicsMobileTokenResponseModel Invoke-RGSAEmployeeTruckTrackingConfigEmployeeIdGet
        [-EmployeeId]
        [-ApiKey]

Example

$EmployeeId = "MyEmployeeId" # String | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSAEmployeeTruckTrackingConfigEmployeeIdGet -EmployeeId $EmployeeId -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAEmployeeTruckTrackingConfigEmployeeIdGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
EmployeeId String
ApiKey String API Key

Return type

TelematicsMobileTokenResponseModel (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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