Skip to content

RGSACallLogApi.md

Latest commit

 

History

History
98 lines (68 loc) · 3.52 KB

RGSACallLogApi.md

File metadata and controls

98 lines (68 loc) · 3.52 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSACallLogApi

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

Method HTTP request Description
Invoke-RGSACallLogAddCallLogPost POST /CallLog/AddCallLog Add a call log record.
Invoke-RGSACallLogCustomerCustomerIdGet GET /CallLog/Customer/{customerId} Retreive all call logs by customer ID

Invoke-RGSACallLogAddCallLogPost

String Invoke-RGSACallLogAddCallLogPost
        [-ApiKey]
        [-CallLogSimple]

Add a call log record.

Example

$ApiKey = "MyApiKey" # String | API Key
$CallLogSimple = Initialize-CallLogSimple -CustNo 0 -EmpId "MyEmpId" -ActionReasonID 0 -Status "MyStatus" -Note "MyNote" -AuditEmployeeID "MyAuditEmployeeID" -Name "MyName" -PhoneNumber "MyPhoneNumber" # CallLogSimple |  (optional)

# Add a call log record.
try {
    $Result = Invoke-RGSACallLogAddCallLogPost -ApiKey $ApiKey -CallLogSimple $CallLogSimple
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallLogAddCallLogPost: {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
CallLogSimple CallLogSimple [optional]

Return type

String

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

CallLogWithNotes[] Invoke-RGSACallLogCustomerCustomerIdGet
        [-CustomerId]
        [-ApiKey]

Retreive all call logs by customer ID

Example

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

# Retreive all call logs by customer ID
try {
    $Result = Invoke-RGSACallLogCustomerCustomerIdGet -CustomerId $CustomerId -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSACallLogCustomerCustomerIdGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
CustomerId Int32
ApiKey String API Key

Return type

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