class Projects::Api::API

Attributes

authToken[RW]
portalId[RW]

Public Class Methods

new(authToken, portalId) click to toggle source
  • Construct a new API using User's authToken and portalId.

Parameters

  • authToken
    • User's authToken.

  • portalId
    • User's portalId.

# File lib/projects/api/API.rb, line 23
def initialize(authToken, portalId)
@authToken = authToken
@portalId = portalId
end

Public Instance Methods

getBaseURL() click to toggle source
  • Get the base URL of the service.

Returns

  • Base URL.

# File lib/projects/api/API.rb, line 36
def getBaseURL
         return @@baseURL+"portal/"+String(portalId)+"/";
 end
getQueryMap(queryMap=nil) click to toggle source
  • Creates a query map using User's authToken and filters.

Returns

  • HashMap.

# File lib/projects/api/API.rb, line 45
def getQueryMap(queryMap=nil)
        if queryMap != nil
               queryMap1 = queryMap
               queryMap1["authtoken"] = authToken
       else
               queryMap1 = Hash.new
                queryMap1["authtoken"] = authToken
       end
return queryMap1
end