Skip to content

Latest commit

 

History

History
155 lines (97 loc) · 3.79 KB

CustomerApi.md

File metadata and controls

155 lines (97 loc) · 3.79 KB

RentCentric::CustomerApi

All URIs are relative to https://www6.rentcentric.com:443/Client7020/UpNorthApi

Method HTTP request Description
customer_get_customer GET /api/Customer/GetCustomer
customer_get_customer_active_credit_card GET /api/Customer/GetCustomerActiveCreditCard
customer_get_customers POST /api/Customer/GetCustomers

customer_get_customer

ResponseGetCustomerResponse customer_get_customer(customer_id, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::CustomerApi.new

customer_id = 56 # Integer | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.customer_get_customer(customer_id, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling CustomerApi->customer_get_customer: #{e}"
end

Parameters

Name Type Description Notes
customer_id Integer
authorization String {token_type} {access_token} [optional]

Return type

ResponseGetCustomerResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

customer_get_customer_active_credit_card

ResponseCustomerCreditCardDTOResponse customer_get_customer_active_credit_card(customer_id, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::CustomerApi.new

customer_id = 56 # Integer | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.customer_get_customer_active_credit_card(customer_id, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling CustomerApi->customer_get_customer_active_credit_card: #{e}"
end

Parameters

Name Type Description Notes
customer_id Integer
authorization String {token_type} {access_token} [optional]

Return type

ResponseCustomerCreditCardDTOResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

customer_get_customers

ResponseListGetCustomerResponse customer_get_customers(request, opts)

Example

# load the gem
require 'rent_centric'

api_instance = RentCentric::CustomerApi.new

request = RentCentric::GetCustomersRequest.new # GetCustomersRequest | 

opts = { 
  authorization: 'authorization_example' # String | {token_type} {access_token}
}

begin
  result = api_instance.customer_get_customers(request, opts)
  p result
rescue RentCentric::ApiError => e
  puts "Exception when calling CustomerApi->customer_get_customers: #{e}"
end

Parameters

Name Type Description Notes
request GetCustomersRequest
authorization String {token_type} {access_token} [optional]

Return type

ResponseListGetCustomerResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml