Skip to content

RGSABatchApi.md

Latest commit

 

History

History
162 lines (119 loc) · 5.98 KB

RGSABatchApi.md

File metadata and controls

162 lines (119 loc) · 5.98 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSABatchApi

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

Method HTTP request Description
Invoke-RGSABatchIdGet GET /Batch/{id} Get a single batch record by ID.
Invoke-RGSABatchSearchGet GET /Batch/Search Search for one or many batches.
Invoke-RGSABatchSearchPost POST /Batch/Search Search for one or many batches.

Invoke-RGSABatchIdGet

Batch Invoke-RGSABatchIdGet
        [-Id]
        [-ApiKey]
        [-Fields]

Get a single batch record by ID.

Example

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

# Get a single batch record by ID.
try {
    $Result = Invoke-RGSABatchIdGet -Id $Id -ApiKey $ApiKey -Fields $Fields
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSABatchIdGet: {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

Batch (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-RGSABatchSearchGet

Batch[] Invoke-RGSABatchSearchGet
        [-ApiKey]
        [-BatchDateMinValue] <System.Nullable[System.DateTime]>
        [-BatchDateMaxValue] <System.Nullable[System.DateTime]>
        [-BatchType]
        [-PrintedBy]
        [-Fields]

Search for one or many batches.

Example

$ApiKey = "MyApiKey" # String | API Key
$BatchDateMinValue = (Get-Date) # System.DateTime |  (optional)
$BatchDateMaxValue = (Get-Date) # System.DateTime |  (optional)
$BatchType = "None" # BatchType |  (optional)
$PrintedBy = "MyPrintedBy" # String |  (optional)
$Fields = "MyFields" # String |  (optional)

# Search for one or many batches.
try {
    $Result = Invoke-RGSABatchSearchGet -ApiKey $ApiKey -BatchDateMinValue $BatchDateMinValue -BatchDateMaxValue $BatchDateMaxValue -BatchType $BatchType -PrintedBy $PrintedBy -Fields $Fields
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSABatchSearchGet: {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
BatchDateMinValue System.DateTime [optional]
BatchDateMaxValue System.DateTime [optional]
BatchType BatchType [optional]
PrintedBy String [optional]
Fields String [optional]

Return type

Batch[] (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-RGSABatchSearchPost

Batch[] Invoke-RGSABatchSearchPost
        [-ApiKey]
        [-Fields]
        [-BatchLookup]

Search for one or many batches.

Example

$ApiKey = "MyApiKey" # String | API Key
$Fields = "MyFields" # String |  (optional)
$DateTimeRange = Initialize-DateTimeRange -MinValue (Get-Date) -MaxValue (Get-Date)
$BatchLookup = Initialize-BatchLookup -BatchDate $DateTimeRange -BatchType "None" -PrintedBy "MyPrintedBy" # BatchLookup |  (optional)

# Search for one or many batches.
try {
    $Result = Invoke-RGSABatchSearchPost -ApiKey $ApiKey -Fields $Fields -BatchLookup $BatchLookup
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSABatchSearchPost: {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]
BatchLookup BatchLookup [optional]

Return type

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