Skip to content

RGSAPropertyInventoryApi.md

Latest commit

 

History

History
185 lines (129 loc) · 7.15 KB

RGSAPropertyInventoryApi.md

File metadata and controls

185 lines (129 loc) · 7.15 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAPropertyInventoryApi

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

Method HTTP request Description
Invoke-RGSAPropertyInventoryAnyBranchAnybranchGet GET /PropertyInventory/AnyBranch/{anybranch} Returns a list of property inventory parameters that are/are not available for all companies/branches based on the provided anybranch value.
Invoke-RGSAPropertyInventoryCategoryIDInvcatidGet GET /PropertyInventory/CategoryID/{invcatid} Returns a list of property inventory parameters that are assigned the provided InventoryCategoryID.
Invoke-RGSAPropertyInventoryGet GET /PropertyInventory Returns a list of all property inventory parameters in the database.
Invoke-RGSAPropertyInventoryIdGet GET /PropertyInventory/{id} Returns a single property inventory parameter that corresponds to the provided ID.

Invoke-RGSAPropertyInventoryAnyBranchAnybranchGet

PropertyInventory[] Invoke-RGSAPropertyInventoryAnyBranchAnybranchGet
        [-Anybranch]
        [-ApiKey]

Returns a list of property inventory parameters that are/are not available for all companies/branches based on the provided anybranch value.

Example

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

# Returns a list of property inventory parameters that are/are not available for all companies/branches based on the provided anybranch value.
try {
    $Result = Invoke-RGSAPropertyInventoryAnyBranchAnybranchGet -Anybranch $Anybranch -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPropertyInventoryAnyBranchAnybranchGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Anybranch Boolean
ApiKey String API Key

Return type

PropertyInventory[] (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-RGSAPropertyInventoryCategoryIDInvcatidGet

PropertyInventory[] Invoke-RGSAPropertyInventoryCategoryIDInvcatidGet
        [-Invcatid]
        [-ApiKey]

Returns a list of property inventory parameters that are assigned the provided InventoryCategoryID.

Example

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

# Returns a list of property inventory parameters that are assigned the provided InventoryCategoryID.
try {
    $Result = Invoke-RGSAPropertyInventoryCategoryIDInvcatidGet -Invcatid $Invcatid -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPropertyInventoryCategoryIDInvcatidGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Invcatid Int32
ApiKey String API Key

Return type

PropertyInventory[] (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-RGSAPropertyInventoryGet

PropertyInventory[] Invoke-RGSAPropertyInventoryGet
        [-ApiKey]

Returns a list of all property inventory parameters in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

# Returns a list of all property inventory parameters in the database.
try {
    $Result = Invoke-RGSAPropertyInventoryGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPropertyInventoryGet: {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

PropertyInventory[] (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-RGSAPropertyInventoryIdGet

PropertyInventory Invoke-RGSAPropertyInventoryIdGet
        [-Id]
        [-ApiKey]

Returns a single property inventory parameter that corresponds to the provided ID.

Example

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

# Returns a single property inventory parameter that corresponds to the provided ID.
try {
    $Result = Invoke-RGSAPropertyInventoryIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPropertyInventoryIdGet: {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

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