Skip to content

RGSASecurityCodeApi.md

Latest commit

 

History

History
95 lines (65 loc) · 3.12 KB

RGSASecurityCodeApi.md

File metadata and controls

95 lines (65 loc) · 3.12 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSASecurityCodeApi

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

Method HTTP request Description
Invoke-RGSASecurityCodeGet GET /SecurityCode Returns all security code parameters in the database.
Invoke-RGSASecurityCodeIdGet GET /SecurityCode/{id} Returns a single security code record that corresponds to the provided ID.

Invoke-RGSASecurityCodeGet

SecurityCode[] Invoke-RGSASecurityCodeGet
        [-ApiKey]

Returns all security code parameters in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

SecurityCode[] (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-RGSASecurityCodeIdGet

SecurityCode Invoke-RGSASecurityCodeIdGet
        [-Id]
        [-ApiKey]

Returns a single security code record that corresponds to the provided ID.

Example

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

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

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