Skip to content

RGSAConditionCodeApi.md

Latest commit

 

History

History
545 lines (385 loc) · 19.8 KB

RGSAConditionCodeApi.md

File metadata and controls

545 lines (385 loc) · 19.8 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAConditionCodeApi

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

Method HTTP request Description
Invoke-RGSAConditionCodeAnyBranchAnybranchGet GET /ConditionCode/AnyBranch/{anybranch} Retrieve a list of condition codes that are/are not available for all branches.
Invoke-RGSAConditionCodeAvailableAvailableGet GET /ConditionCode/Available/{available} Retrieve a list of condition codes that are/are not available.
Invoke-RGSAConditionCodeCategoryIDCondcatidGet GET /ConditionCode/CategoryID/{condcatid} Retrieve a list of condition codes that match the corresponding condition category ID.
Invoke-RGSAConditionCodeCustomerTypeCustomerActionCustdoGet GET /ConditionCode/CustomerTypeCustomerAction/{custdo} Retrieve a list of condition codes that have/don't have customer actions.
Invoke-RGSAConditionCodeDiscountDisccodeGet GET /ConditionCode/Discount/{disccode} Retrieve a list of condition codes that have the corresponding discount code.
Invoke-RGSAConditionCodeGet GET /ConditionCode Retrieve all condition codes
Invoke-RGSAConditionCodeIdGet GET /ConditionCode/{id} Retrieve a single condition code by ID.
Invoke-RGSAConditionCodeInternalUseInternaluseGet GET /ConditionCode/InternalUse/{internaluse} Retrieve a list of condition codes that are/are not available only for internal use.
Invoke-RGSAConditionCodeIsMobileHandheldGet GET /ConditionCode/IsMobile/{handheld} Retrieve a list of condition codes that are/are not available on Mobile
Invoke-RGSAConditionCodeLetterIDLetteridGet GET /ConditionCode/LetterID/{letterid} Retrieve a list of condition codes that match the corresponding letter id.
Invoke-RGSAConditionCodeSendEmailSendemailGet GET /ConditionCode/SendEmail/{sendemail} Retrieve a list of condition codes that will/will not send emails.
Invoke-RGSAConditionCodeUpsellProgramTypeProgdefidGet GET /ConditionCode/UpsellProgramType/{progdefid} Retrieve a list of condition codes that match the provided program definition ID

Invoke-RGSAConditionCodeAnyBranchAnybranchGet

void Invoke-RGSAConditionCodeAnyBranchAnybranchGet
        [-Anybranch]
        [-ApiKey]

Retrieve a list of condition codes that are/are not available for all branches.

Example

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

# Retrieve a list of condition codes that are/are not available for all branches.
try {
    $Result = Invoke-RGSAConditionCodeAnyBranchAnybranchGet -Anybranch $Anybranch -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeAnyBranchAnybranchGet: {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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeAvailableAvailableGet

void Invoke-RGSAConditionCodeAvailableAvailableGet
        [-Available]
        [-ApiKey]

Retrieve a list of condition codes that are/are not available.

Example

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

# Retrieve a list of condition codes that are/are not available.
try {
    $Result = Invoke-RGSAConditionCodeAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeAvailableAvailableGet: {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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeCategoryIDCondcatidGet

void Invoke-RGSAConditionCodeCategoryIDCondcatidGet
        [-Condcatid]
        [-ApiKey]

Retrieve a list of condition codes that match the corresponding condition category ID.

Example

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

# Retrieve a list of condition codes that match the corresponding condition category ID.
try {
    $Result = Invoke-RGSAConditionCodeCategoryIDCondcatidGet -Condcatid $Condcatid -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeCategoryIDCondcatidGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Condcatid Int32
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeCustomerTypeCustomerActionCustdoGet

void Invoke-RGSAConditionCodeCustomerTypeCustomerActionCustdoGet
        [-Custdo]
        [-ApiKey]

Retrieve a list of condition codes that have/don't have customer actions.

Example

$Custdo = "MyCustdo" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Retrieve a list of condition codes that have/don't have customer actions.
try {
    $Result = Invoke-RGSAConditionCodeCustomerTypeCustomerActionCustdoGet -Custdo $Custdo -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeCustomerTypeCustomerActionCustdoGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Custdo String
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeDiscountDisccodeGet

void Invoke-RGSAConditionCodeDiscountDisccodeGet
        [-Disccode]
        [-ApiKey]

Retrieve a list of condition codes that have the corresponding discount code.

Example

$Disccode = "MyDisccode" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Retrieve a list of condition codes that have the corresponding discount code.
try {
    $Result = Invoke-RGSAConditionCodeDiscountDisccodeGet -Disccode $Disccode -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeDiscountDisccodeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Disccode String
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeGet

void Invoke-RGSAConditionCodeGet
        [-ApiKey]

Retrieve all condition codes

Example

$ApiKey = "MyApiKey" # String | API Key

# Retrieve all condition codes
try {
    $Result = Invoke-RGSAConditionCodeGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeGet: {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: Not defined

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

Invoke-RGSAConditionCodeIdGet

void Invoke-RGSAConditionCodeIdGet
        [-Id]
        [-ApiKey]

Retrieve a single condition code by ID.

Example

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

# Retrieve a single condition code by ID.
try {
    $Result = Invoke-RGSAConditionCodeIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeIdGet: {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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeInternalUseInternaluseGet

void Invoke-RGSAConditionCodeInternalUseInternaluseGet
        [-Internaluse]
        [-ApiKey]

Retrieve a list of condition codes that are/are not available only for internal use.

Example

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

# Retrieve a list of condition codes that are/are not available only for internal use.
try {
    $Result = Invoke-RGSAConditionCodeInternalUseInternaluseGet -Internaluse $Internaluse -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeInternalUseInternaluseGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Internaluse Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeIsMobileHandheldGet

void Invoke-RGSAConditionCodeIsMobileHandheldGet
        [-Handheld]
        [-ApiKey]

Retrieve a list of condition codes that are/are not available on Mobile

Example

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

# Retrieve a list of condition codes that are/are not available on Mobile
try {
    $Result = Invoke-RGSAConditionCodeIsMobileHandheldGet -Handheld $Handheld -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeIsMobileHandheldGet: {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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeLetterIDLetteridGet

void Invoke-RGSAConditionCodeLetterIDLetteridGet
        [-Letterid]
        [-ApiKey]

Retrieve a list of condition codes that match the corresponding letter id.

Example

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

# Retrieve a list of condition codes that match the corresponding letter id.
try {
    $Result = Invoke-RGSAConditionCodeLetterIDLetteridGet -Letterid $Letterid -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeLetterIDLetteridGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Letterid Int32
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeSendEmailSendemailGet

void Invoke-RGSAConditionCodeSendEmailSendemailGet
        [-Sendemail]
        [-ApiKey]

Retrieve a list of condition codes that will/will not send emails.

Example

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

# Retrieve a list of condition codes that will/will not send emails.
try {
    $Result = Invoke-RGSAConditionCodeSendEmailSendemailGet -Sendemail $Sendemail -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeSendEmailSendemailGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Sendemail Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAConditionCodeUpsellProgramTypeProgdefidGet

void Invoke-RGSAConditionCodeUpsellProgramTypeProgdefidGet
        [-Progdefid]
        [-ApiKey]

Retrieve a list of condition codes that match the provided program definition ID

Example

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

# Retrieve a list of condition codes that match the provided program definition ID
try {
    $Result = Invoke-RGSAConditionCodeUpsellProgramTypeProgdefidGet -Progdefid $Progdefid -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAConditionCodeUpsellProgramTypeProgdefidGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Progdefid Int32
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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