Skip to content

RGSATitleApi.md

Latest commit

 

History

History
95 lines (65 loc) · 2.9 KB

RGSATitleApi.md

File metadata and controls

95 lines (65 loc) · 2.9 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSATitleApi

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

Method HTTP request Description
Invoke-RGSATitleGet GET /Title Returns all title records in the database.
Invoke-RGSATitleIdGet GET /Title/{id} Returns a single title record that correseponds to the provided ID.

Invoke-RGSATitleGet

Title[] Invoke-RGSATitleGet
        [-ApiKey]

Returns all title records in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

Title[] (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-RGSATitleIdGet

Title Invoke-RGSATitleIdGet
        [-Id]
        [-ApiKey]

Returns a single title record that correseponds to the provided ID.

Example

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

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

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