MoxiWorks.Platform.OfficeService Class Reference

Moxi Works Platform Office entities represent brokerage offices. More...

Inheritance diagram for MoxiWorks.Platform.OfficeService:

Public Member Functions
	OfficeService (IMoxiWorksClient client)
async Task< Response< Office > >	GetOfficeAsync (string moxiWorksOfficeId, string moxiWorksCompanyId)
	Gets a Brockerages office More...
async Task< Response< OfficeResults > >	GetCompanyOfficesAsync (string moxiWorksCompanyId, int pageNumber=1)
	Get a list of Offices for a brockerage. More...

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

Detailed Description

Moxi Works Platform Office entities represent brokerage offices.

Member Function Documentation

GetCompanyOfficesAsync()

async Task<Response<OfficeResults> > MoxiWorks.Platform.OfficeService.GetCompanyOfficesAsync	(	string	moxiWorksCompanyId,
		int	pageNumber = 1
	)

Get a list of Offices for a brockerage.

Parameters

moxiWorksCompanyId	A valid Moxi Works Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.
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

List of offices for a brockerage.

Implements MoxiWorks.Platform.Interfaces.IOfficeService.

GetOfficeAsync()

async Task<Response<Office> > MoxiWorks.Platform.OfficeService.GetOfficeAsync	(	string	moxiWorksOfficeId,
		string	moxiWorksCompanyId
	)

Gets a Brockerages office

Parameters

moxiWorksOfficeId	A valid Moxi Works Office ID. Use Office Index Endpoint for a list of all Office objects associated with a Company or use the moxi_works_office_id attribute returned in an Agent response.
moxiWorksCompanyId	A valid Moxi Works Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.

Returns

Office response or an empty office if nothing is found

Implements MoxiWorks.Platform.Interfaces.IOfficeService.

---

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

• OfficeService.cs