Skip to content

RGSAProductsApi.md

Latest commit

 

History

History
621 lines (421 loc) · 19.7 KB

RGSAProductsApi.md

File metadata and controls

621 lines (421 loc) · 19.7 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAProductsApi

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

Method HTTP request Description
Invoke-RGSAProductsAnyBranchAnybranchGet GET /Products/AnyBranch/{anybranch}
Invoke-RGSAProductsAvailableOnHandheldHandheldGet GET /Products/AvailableOnHandheld/{handheld}
Invoke-RGSAProductsEPANumberEpanoGet GET /Products/EPANumber/{epano}
Invoke-RGSAProductsGet GET /Products
Invoke-RGSAProductsIdGet GET /Products/{id}
Invoke-RGSAProductsIsLaborIslaborGet GET /Products/IsLabor/{islabor}
Invoke-RGSAProductsIsMasterIsmasterGet GET /Products/IsMaster/{ismaster}
Invoke-RGSAProductsIsNonInventoryNoninvGet GET /Products/IsNonInventory/{noninv}
Invoke-RGSAProductsIsProductionForproducGet GET /Products/IsProduction/{forproduc}
Invoke-RGSAProductsIsWorkOrderForworkordGet GET /Products/IsWorkOrder/{forworkord}
Invoke-RGSAProductsOnHandOnhandGet GET /Products/OnHand/{onhand}
Invoke-RGSAProductsOnHoldOnholdGet GET /Products/OnHold/{onhold}
Invoke-RGSAProductsPost POST /Products
Invoke-RGSAProductsProductCodeProdcodeGet GET /Products/ProductCode/{prodcode}

Invoke-RGSAProductsAnyBranchAnybranchGet

void Invoke-RGSAProductsAnyBranchAnybranchGet
        [-Anybranch]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAProductsAnyBranchAnybranchGet -Anybranch $Anybranch -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsAnyBranchAnybranchGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Anybranch Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsAvailableOnHandheldHandheldGet

void Invoke-RGSAProductsAvailableOnHandheldHandheldGet
        [-Handheld]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAProductsAvailableOnHandheldHandheldGet -Handheld $Handheld -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsAvailableOnHandheldHandheldGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Handheld Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsEPANumberEpanoGet

void Invoke-RGSAProductsEPANumberEpanoGet
        [-Epano]
        [-ApiKey]

Example

$Epano = "MyEpano" # String | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSAProductsEPANumberEpanoGet -Epano $Epano -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsEPANumberEpanoGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Epano String
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsGet

void Invoke-RGSAProductsGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSAProductsGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsGet: {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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsIdGet

void Invoke-RGSAProductsIdGet
        [-Id]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAProductsIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsIdGet: {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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsIsLaborIslaborGet

void Invoke-RGSAProductsIsLaborIslaborGet
        [-Islabor]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAProductsIsLaborIslaborGet -Islabor $Islabor -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsIsLaborIslaborGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Islabor Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsIsMasterIsmasterGet

void Invoke-RGSAProductsIsMasterIsmasterGet
        [-Ismaster]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAProductsIsMasterIsmasterGet -Ismaster $Ismaster -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsIsMasterIsmasterGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Ismaster Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsIsNonInventoryNoninvGet

void Invoke-RGSAProductsIsNonInventoryNoninvGet
        [-Noninv]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAProductsIsNonInventoryNoninvGet -Noninv $Noninv -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsIsNonInventoryNoninvGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Noninv Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsIsProductionForproducGet

void Invoke-RGSAProductsIsProductionForproducGet
        [-Forproduc]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAProductsIsProductionForproducGet -Forproduc $Forproduc -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsIsProductionForproducGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Forproduc Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsIsWorkOrderForworkordGet

void Invoke-RGSAProductsIsWorkOrderForworkordGet
        [-Forworkord]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAProductsIsWorkOrderForworkordGet -Forworkord $Forworkord -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsIsWorkOrderForworkordGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Forworkord Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsOnHandOnhandGet

void Invoke-RGSAProductsOnHandOnhandGet
        [-Onhand]
        [-ApiKey]

Example

$Onhand = 1.2 # Double | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSAProductsOnHandOnhandGet -Onhand $Onhand -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsOnHandOnhandGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Onhand Double
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsOnHoldOnholdGet

void Invoke-RGSAProductsOnHoldOnholdGet
        [-Onhold]
        [-ApiKey]

Example

$Onhold = 1.2 # Double | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSAProductsOnHoldOnholdGet -Onhold $Onhold -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsOnHoldOnholdGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Onhold Double
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAProductsPost

void Invoke-RGSAProductsPost
        [-ApiKey]
        [-APIProductInsert]

Example

$ApiKey = "MyApiKey" # String | API Key
$APIProductInsert = Initialize-APIProductInsert -ProductCode "MyProductCode" -Description "MyDescription" -EpaNumber "MyEpaNumber" -OnHand 0 -UnitCost 0 -UnitPrice 0 -ProductCategoryId 0 -UnitofMeasure 0 -ProposalNotes "MyProposalNotes" -CrewNotes "MyCrewNotes" # APIProductInsert |  (optional)

try {
    $Result = Invoke-RGSAProductsPost -ApiKey $ApiKey -APIProductInsert $APIProductInsert
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsPost: {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
APIProductInsert APIProductInsert [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

Invoke-RGSAProductsProductCodeProdcodeGet

void Invoke-RGSAProductsProductCodeProdcodeGet
        [-Prodcode]
        [-ApiKey]

Example

$Prodcode = "MyProdcode" # String | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSAProductsProductCodeProdcodeGet -Prodcode $Prodcode -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAProductsProductCodeProdcodeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Prodcode String
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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