Skip to content

Latest commit

 

History

History
293 lines (211 loc) · 11 KB

RGSAProgramCodeApi.md

File metadata and controls

293 lines (211 loc) · 11 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAProgramCodeApi

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

Method HTTP request Description
Invoke-RGSAProgramCodeCodeIdGet GET /ProgramCode/Code/{id} Returns a single program code record that corresponds to the provided program code.
Invoke-RGSAProgramCodeCompanyGet GET /ProgramCode/Company Returns a list of programs that are available forthe specified company IDs Warning: This includes inactive ProgramCodes
Invoke-RGSAProgramCodeCompanyPost POST /ProgramCode/Company Returns a list of programs that are available forthe specified company IDs
Invoke-RGSAProgramCodeGet GET /ProgramCode Returns a list of all program code parameters from the database.
Invoke-RGSAProgramCodeIdGet GET /ProgramCode/{id} Returns a single program code record that correseponds to the provided ID.
Invoke-RGSAProgramCodeIdServicesGet GET /ProgramCode/{id}/Services Returns the services that are contained within a program/repeating special.

Invoke-RGSAProgramCodeCodeIdGet

ProgramCodes Invoke-RGSAProgramCodeCodeIdGet
        [-Id]
        [-ApiKey]
        [-Fields]

Returns a single program code record that corresponds to the provided program code.

Example

$Id = "MyId" # String | 
$ApiKey = "MyApiKey" # String | API Key
$Fields = "MyFields" # String |  (optional)

# Returns a single program code record that corresponds to the provided program code.
try {
    $Result = Invoke-RGSAProgramCodeCodeIdGet -Id $Id -ApiKey $ApiKey -Fields $Fields
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProgramCodeCodeIdGet: {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
Fields String [optional]

Return type

ProgramCodes (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-RGSAProgramCodeCompanyGet

ProgramService[] Invoke-RGSAProgramCodeCompanyGet
        [-ApiKey]
        [-CompanyIds]
        [-Fields]

Returns a list of programs that are available forthe specified company IDs Warning: This includes inactive ProgramCodes

Example

$ApiKey = "MyApiKey" # String | API Key
$CompanyIds = "MyCompanyIds" # String |  (optional)
$Fields = "MyFields" # String |  (optional)

# Returns a list of programs that are available forthe specified company IDs  Warning: This includes inactive ProgramCodes
try {
    $Result = Invoke-RGSAProgramCodeCompanyGet -ApiKey $ApiKey -CompanyIds $CompanyIds -Fields $Fields
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProgramCodeCompanyGet: {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
CompanyIds String [optional]
Fields String [optional]

Return type

ProgramService[] (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-RGSAProgramCodeCompanyPost

ProgramService[] Invoke-RGSAProgramCodeCompanyPost
        [-ApiKey]
        [-Fields]
        [-CompanyID]

Returns a list of programs that are available forthe specified company IDs

Example

$ApiKey = "MyApiKey" # String | API Key
$Fields = "MyFields" # String |  (optional)
$CompanyID = Initialize-CompanyID -CompanyIDs 0 # CompanyID |  (optional)

# Returns a list of programs that are available forthe specified company IDs
try {
    $Result = Invoke-RGSAProgramCodeCompanyPost -ApiKey $ApiKey -Fields $Fields -CompanyID $CompanyID
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProgramCodeCompanyPost: {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
Fields String [optional]
CompanyID CompanyID [optional]

Return type

ProgramService[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSAProgramCodeGet

ProgramCodes[] Invoke-RGSAProgramCodeGet
        [-ApiKey]
        [-Fields]

Returns a list of all program code parameters from the database.

Example

$ApiKey = "MyApiKey" # String | API Key
$Fields = "MyFields" # String |  (optional)

# Returns a list of all program code parameters from the database.
try {
    $Result = Invoke-RGSAProgramCodeGet -ApiKey $ApiKey -Fields $Fields
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProgramCodeGet: {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
Fields String [optional]

Return type

ProgramCodes[] (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-RGSAProgramCodeIdGet

ProgramCodes Invoke-RGSAProgramCodeIdGet
        [-Id]
        [-ApiKey]
        [-Fields]

Returns a single program code record that correseponds to the provided ID.

Example

$Id = 56 # Int32 | 
$ApiKey = "MyApiKey" # String | API Key
$Fields = "MyFields" # String |  (optional)

# Returns a single program code record that correseponds to the provided ID.
try {
    $Result = Invoke-RGSAProgramCodeIdGet -Id $Id -ApiKey $ApiKey -Fields $Fields
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProgramCodeIdGet: {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
Fields String [optional]

Return type

ProgramCodes (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-RGSAProgramCodeIdServicesGet

ProgramService[] Invoke-RGSAProgramCodeIdServicesGet
        [-Id]
        [-ApiKey]
        [-Fields]

Returns the services that are contained within a program/repeating special.

Example

$Id = 56 # Int32 | 
$ApiKey = "MyApiKey" # String | API Key
$Fields = "MyFields" # String |  (optional)

# Returns the services that are contained within a program/repeating special.
try {
    $Result = Invoke-RGSAProgramCodeIdServicesGet -Id $Id -ApiKey $ApiKey -Fields $Fields
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProgramCodeIdServicesGet: {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
Fields String [optional]

Return type

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