Skip to content

RGSASuffixApi.md

Latest commit

 

History

History
140 lines (97 loc) · 4.58 KB

RGSASuffixApi.md

File metadata and controls

140 lines (97 loc) · 4.58 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSASuffixApi

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

Method HTTP request Description
Invoke-RGSASuffixFullSuffixFullsuffixGet GET /Suffix/FullSuffix/{fullsuffix} Returns a single suffix record that is assigned the provided full suffix.
Invoke-RGSASuffixGet GET /Suffix Returns all suffixes in the database.
Invoke-RGSASuffixIdGet GET /Suffix/{id} Returns a single suffix that corresponds to the provided ID.

Invoke-RGSASuffixFullSuffixFullsuffixGet

Suffix Invoke-RGSASuffixFullSuffixFullsuffixGet
        [-Fullsuffix]
        [-ApiKey]

Returns a single suffix record that is assigned the provided full suffix.

Example

$Fullsuffix = "MyFullsuffix" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single suffix record that is assigned the provided full suffix.
try {
    $Result = Invoke-RGSASuffixFullSuffixFullsuffixGet -Fullsuffix $Fullsuffix -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSASuffixFullSuffixFullsuffixGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Fullsuffix String
ApiKey String API Key

Return type

Suffix (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-RGSASuffixGet

Suffix[] Invoke-RGSASuffixGet
        [-ApiKey]

Returns all suffixes in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

Suffix[] (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-RGSASuffixIdGet

Suffix Invoke-RGSASuffixIdGet
        [-Id]
        [-ApiKey]

Returns a single suffix that corresponds to the provided ID.

Example

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

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

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