Skip to content

RGSACallAheadApi.md

Latest commit

 

History

History
320 lines (225 loc) · 11.9 KB

RGSACallAheadApi.md

File metadata and controls

320 lines (225 loc) · 11.9 KB
Raw

RealGreenSaPS.RealGreenSaPS\Api.RGSACallAheadApi

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

Method HTTP request Description
Invoke-RGSACallAheadAvailableAvailableGet GET /CallAhead/Available/{available} Returns a list of call ahead reasons that are, or are not, available based on the provided value.
Invoke-RGSACallAheadCallAheadDescriptionCallDescGet GET /CallAhead/CallAheadDescription/{call_desc} Returns a single call ahead record that corresponds to the provided description.
Invoke-RGSACallAheadGet GET /CallAhead Returns all call ahead parameters in the database.
Invoke-RGSACallAheadHighlightHighlightGet GET /CallAhead/Highlight/{highlight} Returns a list of call ahead reasons that are, or are not, highlighted based on the provided value.
Invoke-RGSACallAheadIdGet GET /CallAhead/{id} Returns a single call ahead record that corresponds to the provided ID.
Invoke-RGSACallAheadNotificationTypeNotifytypeGet GET /CallAhead/NotificationType/{notifytype} Returns a list of call ahead reasons that have the provided notification type.
Invoke-RGSACallAheadRenewableRenewableGet GET /CallAhead/Renewable/{renewable} Returns a list of all call ahead reasons that are, or are not, renewable based on the provided value.

Invoke-RGSACallAheadAvailableAvailableGet

CallAhead[] Invoke-RGSACallAheadAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of call ahead reasons that are, or are not, available based on the provided value.

Example

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

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

CallAhead[] (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-RGSACallAheadCallAheadDescriptionCallDescGet

CallAhead Invoke-RGSACallAheadCallAheadDescriptionCallDescGet
        [-CallDesc]
        [-ApiKey]

Returns a single call ahead record that corresponds to the provided description.

Example

$CallDesc = "MyCallDesc" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single call ahead record that corresponds to the provided description.
try {
    $Result = Invoke-RGSACallAheadCallAheadDescriptionCallDescGet -CallDesc $CallDesc -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallAheadCallAheadDescriptionCallDescGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
CallDesc String
ApiKey String API Key

Return type

CallAhead (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-RGSACallAheadGet

CallAhead[] Invoke-RGSACallAheadGet
        [-ApiKey]

Returns all call ahead parameters in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

CallAhead[] (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-RGSACallAheadHighlightHighlightGet

CallAhead[] Invoke-RGSACallAheadHighlightHighlightGet
        [-Highlight]
        [-ApiKey]

Returns a list of call ahead reasons that are, or are not, highlighted based on the provided value.

Example

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

# Returns a list of call ahead reasons that are, or are not, highlighted based on the provided value.
try {
    $Result = Invoke-RGSACallAheadHighlightHighlightGet -Highlight $Highlight -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallAheadHighlightHighlightGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Highlight Boolean
ApiKey String API Key

Return type

CallAhead[] (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-RGSACallAheadIdGet

CallAhead Invoke-RGSACallAheadIdGet
        [-Id]
        [-ApiKey]

Returns a single call ahead record that corresponds to the provided ID.

Example

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

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

CallAhead (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-RGSACallAheadNotificationTypeNotifytypeGet

CallAhead[] Invoke-RGSACallAheadNotificationTypeNotifytypeGet
        [-Notifytype]
        [-ApiKey]

Returns a list of call ahead reasons that have the provided notification type.

Example

$Notifytype = "MyNotifytype" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of call ahead reasons that have the provided notification type.
try {
    $Result = Invoke-RGSACallAheadNotificationTypeNotifytypeGet -Notifytype $Notifytype -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallAheadNotificationTypeNotifytypeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Notifytype String
ApiKey String API Key

Return type

CallAhead[] (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-RGSACallAheadRenewableRenewableGet

CallAhead[] Invoke-RGSACallAheadRenewableRenewableGet
        [-Renewable]
        [-ApiKey]

Returns a list of all call ahead reasons that are, or are not, renewable based on the provided value.

Example

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

# Returns a list of all call ahead reasons that are, or are not, renewable based on the provided value.
try {
    $Result = Invoke-RGSACallAheadRenewableRenewableGet -Renewable $Renewable -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallAheadRenewableRenewableGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Renewable Boolean
ApiKey String API Key

Return type

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