Skip to content

RGSACallReasonApi.md

Latest commit

 

History

History
365 lines (257 loc) · 13.3 KB

RGSACallReasonApi.md

File metadata and controls

365 lines (257 loc) · 13.3 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSACallReasonApi

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

Method HTTP request Description
Invoke-RGSACallReasonActionReasonIDActreasidGet GET /CallReason/ActionReasonID/{actreasid} Returns a single call reason that corresponds to the provided ActionReasonID.
Invoke-RGSACallReasonBlockLeadBlockleadGet GET /CallReason/BlockLead/{blocklead} Returns a list of call reasons that are or are not available for block leading based on the provided blocklead boolean.
Invoke-RGSACallReasonContactOrAttemptContatmptGet GET /CallReason/ContactOrAttempt/{contatmpt} Returns a list of call reasons that are either attempts (A) or contacts (C).
Invoke-RGSACallReasonGet GET /CallReason Returns all call reasons in the database
Invoke-RGSACallReasonHandheldHandheldGet GET /CallReason/Handheld/{handheld} Returns a list of call reasons that are or are not available on handled devices, based on the provided handheld value.
Invoke-RGSACallReasonLetterIDLetteridGet GET /CallReason/LetterID/{letterid} Use for AMA
Invoke-RGSACallReasonSendNoteSendNoteGet GET /CallReason/SendNote/{sendNote} Use for AMA
Invoke-RGSACallReasonStatusStatusGet GET /CallReason/Status/{status} Returns a list of call reasons that have the specified status.

Invoke-RGSACallReasonActionReasonIDActreasidGet

CallReason Invoke-RGSACallReasonActionReasonIDActreasidGet
        [-Actreasid]
        [-ApiKey]

Returns a single call reason that corresponds to the provided ActionReasonID.

Example

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

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

Parameters

Name Type Description Notes
Actreasid Int32
ApiKey String API Key

Return type

CallReason (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-RGSACallReasonBlockLeadBlockleadGet

CallReason[] Invoke-RGSACallReasonBlockLeadBlockleadGet
        [-Blocklead]
        [-ApiKey]

Returns a list of call reasons that are or are not available for block leading based on the provided blocklead boolean.

Example

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

# Returns a list of call reasons that are or are not available for block leading based on the provided blocklead boolean.
try {
    $Result = Invoke-RGSACallReasonBlockLeadBlockleadGet -Blocklead $Blocklead -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallReasonBlockLeadBlockleadGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Blocklead Boolean
ApiKey String API Key

Return type

CallReason[] (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-RGSACallReasonContactOrAttemptContatmptGet

CallReason[] Invoke-RGSACallReasonContactOrAttemptContatmptGet
        [-Contatmpt]
        [-ApiKey]

Returns a list of call reasons that are either attempts (A) or contacts (C).

Example

$Contatmpt = "MyContatmpt" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of call reasons that are either attempts (A) or contacts (C).
try {
    $Result = Invoke-RGSACallReasonContactOrAttemptContatmptGet -Contatmpt $Contatmpt -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallReasonContactOrAttemptContatmptGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Contatmpt String
ApiKey String API Key

Return type

CallReason[] (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-RGSACallReasonGet

CallReason[] Invoke-RGSACallReasonGet
        [-ApiKey]

Returns all call reasons in the database

Example

$ApiKey = "MyApiKey" # String | API Key

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

CallReason[] (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-RGSACallReasonHandheldHandheldGet

CallReason[] Invoke-RGSACallReasonHandheldHandheldGet
        [-Handheld]
        [-ApiKey]

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

Example

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

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

CallReason[] (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-RGSACallReasonLetterIDLetteridGet

CallReason[] Invoke-RGSACallReasonLetterIDLetteridGet
        [-Letterid]
        [-ApiKey]

Use for AMA

Example

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

# Use for AMA
try {
    $Result = Invoke-RGSACallReasonLetterIDLetteridGet -Letterid $Letterid -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallReasonLetterIDLetteridGet: {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

CallReason[] (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-RGSACallReasonSendNoteSendNoteGet

CallReason[] Invoke-RGSACallReasonSendNoteSendNoteGet
        [-SendNote]
        [-ApiKey]

Use for AMA

Example

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

# Use for AMA
try {
    $Result = Invoke-RGSACallReasonSendNoteSendNoteGet -SendNote $SendNote -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallReasonSendNoteSendNoteGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
SendNote Boolean
ApiKey String API Key

Return type

CallReason[] (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-RGSACallReasonStatusStatusGet

CallReason[] Invoke-RGSACallReasonStatusStatusGet
        [-Status]
        [-ApiKey]

Returns a list of call reasons that have the specified status.

Example

$Status = "MyStatus" # String | 
$ApiKey = "MyApiKey" # String | API Key

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

Parameters

Name Type Description Notes
Status String
ApiKey String API Key

Return type

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