Skip to content

RGSAServiceCodeApi.md

Latest commit

 

History

History
185 lines (129 loc) · 6.72 KB

RGSAServiceCodeApi.md

File metadata and controls

185 lines (129 loc) · 6.72 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAServiceCodeApi

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

Method HTTP request Description
Invoke-RGSAServiceCodeAvailableAvailableGet GET /ServiceCode/Available/{available} Returns a list of service codes that are (available=true) or are not (avaialble=false) avaialble.
Invoke-RGSAServiceCodeCodeServiceCodeGet GET /ServiceCode/Code/{serviceCode} Returns a single service code for the provided service ID
Invoke-RGSAServiceCodeGet GET /ServiceCode Returns all service code parameters in the database.
Invoke-RGSAServiceCodeServiceCodeServiceCodeGet GET /ServiceCode/ServiceCode/{serviceCode} Returns a single service code for the provided service ID

Invoke-RGSAServiceCodeAvailableAvailableGet

ServiceCode Invoke-RGSAServiceCodeAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of service codes that are (available=true) or are not (avaialble=false) avaialble.

Example

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

# Returns a list of service codes that are (available=true) or are not (avaialble=false) avaialble.
try {
    $Result = Invoke-RGSAServiceCodeAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAServiceCodeAvailableAvailableGet: {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

ServiceCode (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-RGSAServiceCodeCodeServiceCodeGet

ServiceCode Invoke-RGSAServiceCodeCodeServiceCodeGet
        [-ServiceCode]
        [-ApiKey]

Returns a single service code for the provided service ID

Example

$ServiceCode = "MyServiceCode" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single service code for the provided service ID
try {
    $Result = Invoke-RGSAServiceCodeCodeServiceCodeGet -ServiceCode $ServiceCode -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAServiceCodeCodeServiceCodeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ServiceCode String
ApiKey String API Key

Return type

ServiceCode (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-RGSAServiceCodeGet

ServiceCode[] Invoke-RGSAServiceCodeGet
        [-ApiKey]

Returns all service code parameters in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

ServiceCode[] (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-RGSAServiceCodeServiceCodeServiceCodeGet

ServiceCode Invoke-RGSAServiceCodeServiceCodeServiceCodeGet
        [-ServiceCode]
        [-ApiKey]

Returns a single service code for the provided service ID

Example

$ServiceCode = "MyServiceCode" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single service code for the provided service ID
try {
    $Result = Invoke-RGSAServiceCodeServiceCodeServiceCodeGet -ServiceCode $ServiceCode -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAServiceCodeServiceCodeServiceCodeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ServiceCode String
ApiKey String API Key

Return type

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