Skip to content

RGSAFlagApi.md

Latest commit

 

History

History
320 lines (225 loc) · 11.4 KB

RGSAFlagApi.md

File metadata and controls

320 lines (225 loc) · 11.4 KB
Raw

RealGreenSaPS.RealGreenSaPS\Api.RGSAFlagApi

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

Method HTTP request Description
Invoke-RGSAFlagAvailableAvailableGet GET /Flag/Available/{available} Returns a list of flags that are or are not avaialble based on the provided boolean value.
Invoke-RGSAFlagGet GET /Flag Returns all flag parameters in the database.
Invoke-RGSAFlagIdGet GET /Flag/{id} Returns a single flag parameter that corresponds to the provided ID
Invoke-RGSAFlagInsertFlagPost POST /Flag/InsertFlag Insert a flag to the database.
Invoke-RGSAFlagShowOnEstimateShowestGet GET /Flag/ShowOnEstimate/{showest} Returns a list of flags that are or are not shown on estimates based on the provided boolean value.
Invoke-RGSAFlagShowOnInvoiceShowinvGet GET /Flag/ShowOnInvoice/{showinv} Returns a list of flags that are or are not shown on invoices based on the provided boolean value.
Invoke-RGSAFlagWebsiteAvailableWebavailGet GET /Flag/WebsiteAvailable/{webavail} Returns a list of flags that are or are not available based on the provided boolean value.

Invoke-RGSAFlagAvailableAvailableGet

Flag[] Invoke-RGSAFlagAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of flags that are or are not avaialble based on the provided boolean value.

Example

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

# Returns a list of flags that are or are not avaialble based on the provided boolean value.
try {
    $Result = Invoke-RGSAFlagAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAFlagAvailableAvailableGet: {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

Flag[] (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-RGSAFlagGet

Flag[] Invoke-RGSAFlagGet
        [-ApiKey]

Returns all flag parameters in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

Flag[] (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-RGSAFlagIdGet

Flag Invoke-RGSAFlagIdGet
        [-Id]
        [-ApiKey]

Returns a single flag parameter that corresponds to the provided ID

Example

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

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

Flag (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-RGSAFlagInsertFlagPost

Int32 Invoke-RGSAFlagInsertFlagPost
        [-ApiKey]
        [-APIFlagInsert]

Insert a flag to the database.

Example

$ApiKey = "MyApiKey" # String | API Key
$APIFlagInsert = Initialize-APIFlagInsert -Description "MyDescription" -Sort 0 -Internet $false -PrintOnInvoice $false -PrintOnEstimate $false # APIFlagInsert |  (optional)

# Insert a flag to the database.
try {
    $Result = Invoke-RGSAFlagInsertFlagPost -ApiKey $ApiKey -APIFlagInsert $APIFlagInsert
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAFlagInsertFlagPost: {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
APIFlagInsert APIFlagInsert [optional]

Return type

Int32

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-RGSAFlagShowOnEstimateShowestGet

Flag[] Invoke-RGSAFlagShowOnEstimateShowestGet
        [-Showest]
        [-ApiKey]

Returns a list of flags that are or are not shown on estimates based on the provided boolean value.

Example

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

# Returns a list of flags that are or are not shown on estimates based on the provided boolean value.
try {
    $Result = Invoke-RGSAFlagShowOnEstimateShowestGet -Showest $Showest -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAFlagShowOnEstimateShowestGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Showest Boolean
ApiKey String API Key

Return type

Flag[] (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-RGSAFlagShowOnInvoiceShowinvGet

Flag[] Invoke-RGSAFlagShowOnInvoiceShowinvGet
        [-Showinv]
        [-ApiKey]

Returns a list of flags that are or are not shown on invoices based on the provided boolean value.

Example

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

# Returns a list of flags that are or are not shown on invoices based on the provided boolean value.
try {
    $Result = Invoke-RGSAFlagShowOnInvoiceShowinvGet -Showinv $Showinv -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAFlagShowOnInvoiceShowinvGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Showinv Boolean
ApiKey String API Key

Return type

Flag[] (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-RGSAFlagWebsiteAvailableWebavailGet

Flag[] Invoke-RGSAFlagWebsiteAvailableWebavailGet
        [-Webavail]
        [-ApiKey]

Returns a list of flags that are or are not available based on the provided boolean value.

Example

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

# Returns a list of flags that are or are not available based on the provided boolean value.
try {
    $Result = Invoke-RGSAFlagWebsiteAvailableWebavailGet -Webavail $Webavail -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAFlagWebsiteAvailableWebavailGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Webavail Boolean
ApiKey String API Key

Return type

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