Skip to content

RGSAHoldCodeApi.md

Latest commit

 

History

History
140 lines (97 loc) · 4.71 KB

RGSAHoldCodeApi.md

File metadata and controls

140 lines (97 loc) · 4.71 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAHoldCodeApi

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

Method HTTP request Description
Invoke-RGSAHoldCodeAvailableAvailableGet GET /HoldCode/Available/{available} Returns a list of hold reasons that are/are not available based on the provided available value.
Invoke-RGSAHoldCodeGet GET /HoldCode Returns all hold reasons in the database.
Invoke-RGSAHoldCodeIdGet GET /HoldCode/{id} Returns a single hold reason that corresponds to the provided ID.

Invoke-RGSAHoldCodeAvailableAvailableGet

HoldCode[] Invoke-RGSAHoldCodeAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of hold reasons that are/are not available based on the provided available value.

Example

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

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

HoldCode[] (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-RGSAHoldCodeGet

HoldCode[] Invoke-RGSAHoldCodeGet
        [-ApiKey]

Returns all hold reasons in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

HoldCode[] (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-RGSAHoldCodeIdGet

HoldCode Invoke-RGSAHoldCodeIdGet
        [-Id]
        [-ApiKey]

Returns a single hold reason that corresponds to the provided ID.

Example

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

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

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