Skip to content

RGSACompanyApi.md

Latest commit

 

History

History
226 lines (156 loc) · 7.45 KB

RGSACompanyApi.md

File metadata and controls

226 lines (156 loc) · 7.45 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSACompanyApi

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

Method HTTP request Description
Invoke-RGSACompanyBranchNumberBranchnoGet GET /Company/BranchNumber/{branchno} Returns a single company record that corresponds with the provided branch number.
Invoke-RGSACompanyCountryGet GET /Company/Country
Invoke-RGSACompanyEmployeeEmployeeIdGet GET /Company/Employee/{employeeId} Returns all companies the supplied user can access.
Invoke-RGSACompanyGet GET /Company Returns all companies in the database.
Invoke-RGSACompanyIdGet GET /Company/{id} Returns a single company record that corresponds with the provided ID.

Invoke-RGSACompanyBranchNumberBranchnoGet

Company Invoke-RGSACompanyBranchNumberBranchnoGet
        [-Branchno]
        [-ApiKey]

Returns a single company record that corresponds with the provided branch number.

Example

$Branchno = "MyBranchno" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single company record that corresponds with the provided branch number.
try {
    $Result = Invoke-RGSACompanyBranchNumberBranchnoGet -Branchno $Branchno -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACompanyBranchNumberBranchnoGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Branchno String
ApiKey String API Key

Return type

Company (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-RGSACompanyCountryGet

void Invoke-RGSACompanyCountryGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSACompanyCountryGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACompanyCountryGet: {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

void (empty response body)

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-RGSACompanyEmployeeEmployeeIdGet

Company[] Invoke-RGSACompanyEmployeeEmployeeIdGet
        [-EmployeeId]
        [-ApiKey]

Returns all companies the supplied user can access.

Example

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

# Returns all companies the supplied user can access.
try {
    $Result = Invoke-RGSACompanyEmployeeEmployeeIdGet -EmployeeId $EmployeeId -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACompanyEmployeeEmployeeIdGet: {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

Company[] (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-RGSACompanyGet

Company[] Invoke-RGSACompanyGet
        [-ApiKey]

Returns all companies in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

# Returns all companies in the database.
try {
    $Result = Invoke-RGSACompanyGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACompanyGet: {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

Company[] (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-RGSACompanyIdGet

Company Invoke-RGSACompanyIdGet
        [-Id]
        [-ApiKey]

Returns a single company record that corresponds with the provided ID.

Example

$Id = 56 # Int32 | 
$ApiKey = "MyApiKey" # String | API Key

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

Parameters

Name Type Description Notes
Id Int32
ApiKey String API Key

Return type

Company (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]