Skip to content

RGSADiscountCodeApi.md

Latest commit

 

History

History
365 lines (257 loc) · 14 KB

RGSADiscountCodeApi.md

File metadata and controls

365 lines (257 loc) · 14 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSADiscountCodeApi

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

Method HTTP request Description
Invoke-RGSADiscountCodeAvailableAvailableGet GET /DiscountCode/Available/{available} Returns a list of discount codes that are or are not available based on the supplied value.
Invoke-RGSADiscountCodeAvailableOnHandheldHandheldGet GET /DiscountCode/AvailableOnHandheld/{handheld} Returns a list of discount codes that are or are not available on handhelds based on the supplied value.
Invoke-RGSADiscountCodeAvailableOnWebWebavailGet GET /DiscountCode/AvailableOnWeb/{webavail} Returns a lit of discount codes that are or are not available on CAW based on the supplied value.
Invoke-RGSADiscountCodeDollarDiscountDollardiscGet GET /DiscountCode/DollarDiscount/{dollardisc} Retruns a list of discount codes that are either a dollar discount (1) or percentage discount (0).
Invoke-RGSADiscountCodeGet GET /DiscountCode Returns all discount codes in the database.
Invoke-RGSADiscountCodeIdGet GET /DiscountCode/{id} Returns a single discount code record that corresponds to the provided ID.
Invoke-RGSADiscountCodeIsSurchargeSurchargeGet GET /DiscountCode/IsSurcharge/{surcharge} Returns a list of discount codes that correspond with the supplied surcharge value.
Invoke-RGSADiscountCodePermanentPermanentGet GET /DiscountCode/Permanent/{permanent} Returns a list of discount codes that are or are not permanent based on the supplied value.

Invoke-RGSADiscountCodeAvailableAvailableGet

DiscountCode[] Invoke-RGSADiscountCodeAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of discount codes that are or are not available based on the supplied value.

Example

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

# Returns a list of discount codes that are or are not available based on the supplied value.
try {
    $Result = Invoke-RGSADiscountCodeAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADiscountCodeAvailableAvailableGet: {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

DiscountCode[] (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-RGSADiscountCodeAvailableOnHandheldHandheldGet

DiscountCode[] Invoke-RGSADiscountCodeAvailableOnHandheldHandheldGet
        [-Handheld]
        [-ApiKey]

Returns a list of discount codes that are or are not available on handhelds based on the supplied value.

Example

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

# Returns a list of discount codes that are or are not available on handhelds based on the supplied value.
try {
    $Result = Invoke-RGSADiscountCodeAvailableOnHandheldHandheldGet -Handheld $Handheld -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADiscountCodeAvailableOnHandheldHandheldGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Handheld Boolean
ApiKey String API Key

Return type

DiscountCode[] (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-RGSADiscountCodeAvailableOnWebWebavailGet

DiscountCode[] Invoke-RGSADiscountCodeAvailableOnWebWebavailGet
        [-Webavail]
        [-ApiKey]

Returns a lit of discount codes that are or are not available on CAW based on the supplied value.

Example

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

# Returns a lit of discount codes that are or are not available on CAW based on the supplied value.
try {
    $Result = Invoke-RGSADiscountCodeAvailableOnWebWebavailGet -Webavail $Webavail -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADiscountCodeAvailableOnWebWebavailGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Webavail Boolean
ApiKey String API Key

Return type

DiscountCode[] (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-RGSADiscountCodeDollarDiscountDollardiscGet

DiscountCode[] Invoke-RGSADiscountCodeDollarDiscountDollardiscGet
        [-Dollardisc]
        [-ApiKey]

Retruns a list of discount codes that are either a dollar discount (1) or percentage discount (0).

Example

$Dollardisc = 1.2 # Double | 
$ApiKey = "MyApiKey" # String | API Key

# Retruns a list of discount codes that are either a dollar discount (1) or percentage discount (0).
try {
    $Result = Invoke-RGSADiscountCodeDollarDiscountDollardiscGet -Dollardisc $Dollardisc -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADiscountCodeDollarDiscountDollardiscGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Dollardisc Double
ApiKey String API Key

Return type

DiscountCode[] (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-RGSADiscountCodeGet

DiscountCode[] Invoke-RGSADiscountCodeGet
        [-ApiKey]

Returns all discount codes in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

DiscountCode[] (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-RGSADiscountCodeIdGet

DiscountCode Invoke-RGSADiscountCodeIdGet
        [-Id]
        [-ApiKey]

Returns a single discount code record that corresponds to the provided ID.

Example

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

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

DiscountCode (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-RGSADiscountCodeIsSurchargeSurchargeGet

DiscountCode[] Invoke-RGSADiscountCodeIsSurchargeSurchargeGet
        [-Surcharge]
        [-ApiKey]

Returns a list of discount codes that correspond with the supplied surcharge value.

Example

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

# Returns a list of discount codes that correspond with the supplied surcharge value.
try {
    $Result = Invoke-RGSADiscountCodeIsSurchargeSurchargeGet -Surcharge $Surcharge -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADiscountCodeIsSurchargeSurchargeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Surcharge Boolean
ApiKey String API Key

Return type

DiscountCode[] (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-RGSADiscountCodePermanentPermanentGet

DiscountCode[] Invoke-RGSADiscountCodePermanentPermanentGet
        [-Permanent]
        [-ApiKey]

Returns a list of discount codes that are or are not permanent based on the supplied value.

Example

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

# Returns a list of discount codes that are or are not permanent based on the supplied value.
try {
    $Result = Invoke-RGSADiscountCodePermanentPermanentGet -Permanent $Permanent -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADiscountCodePermanentPermanentGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Permanent Boolean
ApiKey String API Key

Return type

DiscountCode[] (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]