Skip to content

RGSAZipCodeApi.md

Latest commit

 

History

History
92 lines (62 loc) · 2.78 KB

RGSAZipCodeApi.md

File metadata and controls

92 lines (62 loc) · 2.78 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAZipCodeApi

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

Method HTTP request Description
Invoke-RGSAZipCodeAllGet GET /ZipCode/All Returns all zip code records in the database.
Invoke-RGSAZipCodeGet GET /ZipCode Returns all zip code records in the database.

Invoke-RGSAZipCodeAllGet

ZipCode[] Invoke-RGSAZipCodeAllGet
        [-ApiKey]

Returns all zip code records in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

ZipCode[] (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-RGSAZipCodeGet

ZipCode[] Invoke-RGSAZipCodeGet
        [-ApiKey]

Returns all zip code records in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

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