Skip to content

RGSATerritoryApi.md

Latest commit

 

History

History
185 lines (129 loc) · 6.48 KB

RGSATerritoryApi.md

File metadata and controls

185 lines (129 loc) · 6.48 KB
Raw

RealGreenSaPS.RealGreenSaPS\Api.RGSATerritoryApi

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

Method HTTP request Description
Invoke-RGSATerritoryAvailableAvailableGet GET /Territory/Available/{available} Returns a list of territory records that are/are not available based on the provided available value.
Invoke-RGSATerritoryCompanyIDCompIdGet GET /Territory/CompanyID/{comp_id} Returns a list of territory records that are assigned to the provided CompanyID.
Invoke-RGSATerritoryGet GET /Territory Returns all territoriese in the database.
Invoke-RGSATerritoryIdGet GET /Territory/{id} Returns a single territory parameter record that corresponds to the provided ID.

Invoke-RGSATerritoryAvailableAvailableGet

Territory[] Invoke-RGSATerritoryAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of territory records that are/are not available based on the provided available value.

Example

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

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

Territory[] (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-RGSATerritoryCompanyIDCompIdGet

Territory[] Invoke-RGSATerritoryCompanyIDCompIdGet
        [-CompId]
        [-ApiKey]

Returns a list of territory records that are assigned to the provided CompanyID.

Example

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

# Returns a list of territory records that are assigned to the provided CompanyID.
try {
    $Result = Invoke-RGSATerritoryCompanyIDCompIdGet -CompId $CompId -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSATerritoryCompanyIDCompIdGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
CompId Int32
ApiKey String API Key

Return type

Territory[] (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-RGSATerritoryGet

Territory[] Invoke-RGSATerritoryGet
        [-ApiKey]

Returns all territoriese in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

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

Territory[] (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-RGSATerritoryIdGet

Territory Invoke-RGSATerritoryIdGet
        [-Id]
        [-ApiKey]

Returns a single territory parameter record that corresponds to the provided ID.

Example

$Id = "MyId" # String | 
$ApiKey = "MyApiKey" # String | API Key

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

Return type

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