MoxiWorks.Platform.AgentService Class Reference

Moxi Works Agent objects contain data about agents that your organization can use. For example, you can determine an agent’s office address or primary phone number from an Agent object. More...

Inheritance diagram for MoxiWorks.Platform.AgentService:

Public Member Functions
	AgentService (IMoxiWorksClient client)
async Task< Response< Agent > >	GetAgentAsync (string agentId, string moxiWorksCompanyId)
	When finding an Agent using the Moxi Works platform API More...
async Task< Response< Agent > >	GetAgentWithGoalsAsync (string agentId, string moxiWorksCompanyId, bool includeGciGoals)
	When finding an Agent using the Moxi Works platform API and optionaly include an agents gci goals. More...
async Task< Response< AgentResults > >	GetAgentsAsync (string moxiWorksCompanyId, string moxiWorksOfficeId=null, DateTime? updatedSince=null, int? pageNumber=1)
	When searching for Agent entities using the Moxi Works platform API More...

Properties
IMoxiWorksClient	Client [get, set]
Properties inherited from MoxiWorks.Platform.Interfaces.IAgentService
IMoxiWorksClient	Client [get, set]

Detailed Description

Moxi Works Agent objects contain data about agents that your organization can use. For example, you can determine an agent’s office address or primary phone number from an Agent object.

Member Function Documentation

GetAgentAsync()

async Task<Response<Agent> > MoxiWorks.Platform.AgentService.GetAgentAsync	(	string	agentId,
		string	moxiWorksCompanyId
	)

When finding an Agent using the Moxi Works platform API

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted. Agent ID for your ActionLog request to be accepted.

Parameters

moxiWorksCompanyId

A valid Moxi Works Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use

Returns

the Agent if exists or an empty Agent Object

Implements MoxiWorks.Platform.Interfaces.IAgentService.

GetAgentsAsync()

async Task<Response<AgentResults> > MoxiWorks.Platform.AgentService.GetAgentsAsync	(	string	moxiWorksCompanyId,
		string	moxiWorksOfficeId = null,
		DateTime?	updatedSince = null,
		int?	pageNumber = 1
	)

When searching for Agent entities using the Moxi Works platform API

Parameters

moxiWorksCompanyId	A valid Moxi Works Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.
moxiWorksOfficeId	A valid Moxi Works Office ID. Use Office Endpoint to determine what moxiWorksOfficeId you can use.
updatedSince	any Agent objects updated after this Unix timestamp will be returned in the response. If no updated_since parameter is included in the request, only Agent objects updated in the last seven days will be returned.
pageNumber	For queries with multi-page responses, use the page_number parameter to return data for specific pages. Data for page 1 is returned if this parameter is not included. Use this parameter if total_pages indicates that there is more than one page of data available.

Returns

Returns a Result containing list of agent meeting the criteria.

Implements MoxiWorks.Platform.Interfaces.IAgentService.

GetAgentWithGoalsAsync()

async Task<Response<Agent> > MoxiWorks.Platform.AgentService.GetAgentWithGoalsAsync	(	string	agentId,
		string	moxiWorksCompanyId,
		bool	includeGciGoals
	)

When finding an Agent using the Moxi Works platform API and optionaly include an agents gci goals.

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted. Agent ID for your ActionLog request to be accepted.

Parameters

moxiWorksCompanyId	A valid Moxi Works Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use
includeGciGoals	Whether to include agent’s GCI goals and commissions data in the response data.

Returns

the Agent if exists or an empty Agent Object

Implements MoxiWorks.Platform.Interfaces.IAgentService.

---

The documentation for this class was generated from the following file:

• AgentService.cs