Skip to content

RGSAPriceTableApi.md

Latest commit

 

History

History
185 lines (129 loc) · 6.55 KB

RGSAPriceTableApi.md

File metadata and controls

185 lines (129 loc) · 6.55 KB
Raw

RealGreenSaPS.RealGreenSaPS\Api.RGSAPriceTableApi

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

Method HTTP request Description
Invoke-RGSAPriceTableAvailableAvailableGet GET /PriceTable/Available/{available} Returns a list of price tables that are (available=true) or are not (available=false) available to use.
Invoke-RGSAPriceTableGet GET /PriceTable Returns all price table headers in the database.
Invoke-RGSAPriceTableIdDetailedGet GET /PriceTable/{id}/Detailed Returns a detailed price table record that includes the size and price ranges that correspond to the provided ID.
Invoke-RGSAPriceTableIdGet GET /PriceTable/{id} Returns a single price table that matches the provided ID.

Invoke-RGSAPriceTableAvailableAvailableGet

PriceTable[] Invoke-RGSAPriceTableAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of price tables that are (available=true) or are not (available=false) available to use.

Example

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

# Returns a list of price tables that are (available=true) or are not (available=false) available to use.
try {
    $Result = Invoke-RGSAPriceTableAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPriceTableAvailableAvailableGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Available Boolean
ApiKey String API Key

Return type

PriceTable[] (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-RGSAPriceTableGet

PriceTable[] Invoke-RGSAPriceTableGet
        [-ApiKey]

Returns all price table headers in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

PriceTable[] (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-RGSAPriceTableIdDetailedGet

DetailedPriceTable Invoke-RGSAPriceTableIdDetailedGet
        [-Id]
        [-ApiKey]

Returns a detailed price table record that includes the size and price ranges that correspond to the provided ID.

Example

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

# Returns a detailed price table record that includes the size and price ranges that correspond to the provided ID.
try {
    $Result = Invoke-RGSAPriceTableIdDetailedGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPriceTableIdDetailedGet: {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

DetailedPriceTable (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-RGSAPriceTableIdGet

PriceTable Invoke-RGSAPriceTableIdGet
        [-Id]
        [-ApiKey]

Returns a single price table that matches the provided ID.

Example

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

# Returns a single price table that matches the provided ID.
try {
    $Result = Invoke-RGSAPriceTableIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPriceTableIdGet: {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

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