class Projects::Api::ProjectsAPI

Public Class Methods

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

Parameters

  • authToken
    • User's authToken.

  • portalId
    • User's portalId.

Calls superclass method Projects::Api::API::new
# File lib/projects/api/ProjectsAPI.rb, line 39
def initialize(authToken,portalId)
        super(authToken,portalId)
end

Public Instance Methods

addProjectStatus(projectId,status) click to toggle source
  • Add the status for the project.

Parameters

  • projectId
    • ID of the project.

  • status
    • Status object.

Returns

  • Status object.

# File lib/projects/api/ProjectsAPI.rb, line 196
def addProjectStatus(projectId,status)
        url = getProjectUrl(projectId)+"statuses/"
        return $projectParser.getStatus(ZohoHTTPClient.post(url, getQueryMap, status.toParamMAP));
end
createProject(project) click to toggle source
  • Create a new project.

Parameters

  • project
    • Project object.

Returns

  • Project object.

# File lib/projects/api/ProjectsAPI.rb, line 92
def createProject(project)
        createProject = ZohoHTTPClient.post(getProjectsUrl,getQueryMap, project.toParamMAP)
        return $projectParser.getProject(createProject)
end
deleteProject(projectId) click to toggle source
  • Delete an existing project.

Parameters

  • projectId
    • ID of the project.

Returns

  • String object.

# File lib/projects/api/ProjectsAPI.rb, line 137
def deleteProject(projectId)
        response = ZohoHTTPClient.delete(getProjectUrl(projectId),getQueryMap)
        return $projectParser.getResult(response)
end
get(projectId) click to toggle source
  • Get the details of a project.

Parameters

  • projectId
    • ID of the project.

Returns

  • Project object.

# File lib/projects/api/ProjectsAPI.rb, line 107
def get(projectId)
        response = ZohoHTTPClient.get(getProjectUrl(projectId),getQueryMap)
        return $projectParser.getProject(response)
end
getProjectActivities(projectId, queryMap=nil) click to toggle source
  • Get list of project activities.

Parameters

  • projectId
    • ID of the project.

  • queryMap
    • This queryMap contains the filters in the form of key-value pair.

Returns

  • List of Activity object.

# File lib/projects/api/ProjectsAPI.rb, line 154
def getProjectActivities(projectId, queryMap=nil)
        url = getProjectUrl(projectId)+"activities/"
        if queryMap == nil
                return $projectParser.getActivities(ZohoHTTPClient.get(url, getQueryMap))
        else
                return $projectParser.getActivities(ZohoHTTPClient.get(url, getQueryMap(queryMap)))
        end
end
getProjectStatuses(projectId,queryMap=nil) click to toggle source
  • Get list of project statuses.

Parameters

  • projectId
    • ID of the project.

  • queryMap
    • This queryMap contains the filters in the form of key-value pair.

Returns

  • List of Status object.

# File lib/projects/api/ProjectsAPI.rb, line 175
def getProjectStatuses(projectId,queryMap=nil)
        url = getProjectUrl(projectId)+"statuses/"
        if queryMap == nil
                return $projectParser.getStatuses(ZohoHTTPClient.get(url, getQueryMap))
        else
                return $projectParser.getStatuses(ZohoHTTPClient.get(url, getQueryMap(queryMap)))
        end
end
getProjectUrl(projectId) click to toggle source
  • Get specific Project url by specifying the projectId.

Returns

String Object

# File lib/projects/api/ProjectsAPI.rb, line 59
def getProjectUrl(projectId)
        return getBaseURL+'projects/'+String(projectId)+'/'
end
getProjects(queryMap=nil) click to toggle source
  • Get list of projects.

Parameters

  • queryMap
    • This queryMap contains the filters in the form of key-value pair.

Returns

  • List of Project object.

# File lib/projects/api/ProjectsAPI.rb, line 74
def getProjects(queryMap=nil)
        if queryMap == nil
                return $projectParser.getProjects(ZohoHTTPClient.get(getProjectsUrl,getQueryMap)) 
        else
                return $projectParser.getProjects(ZohoHTTPClient.get(getProjectsUrl,getQueryMap(queryMap)))
        end
end
getProjectsUrl() click to toggle source
  • Get the genearal url for getting all Projects.

Returns

String Object

# File lib/projects/api/ProjectsAPI.rb, line 49
def getProjectsUrl
        return getBaseURL+'projects/'
end
updateProject(project) click to toggle source
  • Update the details of a project.

Parameters

  • project
    • Project object.

Returns

  • Project object.

# File lib/projects/api/ProjectsAPI.rb, line 122
def updateProject(project)
        updateProject = ZohoHTTPClient.post(getProjectUrl(project.getId),getQueryMap, project.toParamMAP)
        return $projectParser.getProject(updateProject)
end