Skip to content

RGSARejectCodeApi.md

Latest commit

 

History

History
140 lines (97 loc) · 4.62 KB

RGSARejectCodeApi.md

File metadata and controls

140 lines (97 loc) · 4.62 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSARejectCodeApi

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

Method HTTP request Description
Deny-RGSACodeAvailableAvailableGet GET /RejectCode/Available/{available} Returns a list of reject codes that are/are not available based on the provided available value.
Deny-RGSACodeGet GET /RejectCode Returns all reject codes in the database.
Deny-RGSACodeIdGet GET /RejectCode/{id} Returns a single reject code that corresponds to the provided ID.

Deny-RGSACodeAvailableAvailableGet

RejectCode[] Deny-RGSACodeAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of reject codes that are/are not available based on the provided available value.

Example

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

# Returns a list of reject codes that are/are not available based on the provided available value.
try {
    $Result = Deny-RGSACodeAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Deny-RGSACodeAvailableAvailableGet: {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

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

Deny-RGSACodeGet

RejectCode[] Deny-RGSACodeGet
        [-ApiKey]

Returns all reject codes in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

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

Deny-RGSACodeIdGet

RejectCode Deny-RGSACodeIdGet
        [-Id]
        [-ApiKey]

Returns a single reject code that corresponds to the provided ID.

Example

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

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

RejectCode (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]