MoxiWorks.Platform.ListingService Class Reference

Moxi Works Platform Listing entities represent a Brokerage’s listings. More...

Inheritance diagram for MoxiWorks.Platform.ListingService:

Public Member Functions
	ListingService (IMoxiWorksClient client)
async Task< Response< Listing > >	GetListingAsync (string moxiWorksListingId, string moxiWorksCompanyId)
	Return a single listing More...
async Task< Response< ListingResults > >	GetListingsUpdatedSinceAsync (string moxiWorksCompanyId, AgentIdType agentIdType, string agentId=null, DateTime? updatedSince=null, string lastMoxiWorksListingId=null)
	Index will return a paged response of listings that have been updated since a given timestamp for a specified company. For a list of company IDs that you can request listings for, use the Company Endpoint. More...
async Task< Response< ListingResults > >	UpdateListingData (ListingUpdate listingUpdate)
	Updates the listing data specified in ListingUpdatableData of the ListingUpdate object More...
async Task< Response< ListingResults > >	UpdateListingDataAsync (ListingUpdate listingUpdate)
	Updates the listing data specified in ListingUpdatableData of the ListingUpdate object More...

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

Detailed Description

Moxi Works Platform Listing entities represent a Brokerage’s listings.

Member Function Documentation

GetListingAsync()

async Task<Response<Listing> > MoxiWorks.Platform.ListingService.GetListingAsync	(	string	moxiWorksListingId,
		string	moxiWorksCompanyId
	)

Return a single listing

Parameters

moxiWorksListingId	This is the Moxi Works Platform ID of the Listing which you are requesting to Show. This data is required and must reference a valid Moxi Works Listing ID for your Show request to be accepted.
moxiWorksCompanyId	A valid Moxi Works Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.

Returns

Listing or a empty listing

Implements MoxiWorks.Platform.Interfaces.IListingService.

GetListingsUpdatedSinceAsync()

async Task<Response<ListingResults> > MoxiWorks.Platform.ListingService.GetListingsUpdatedSinceAsync	(	string	moxiWorksCompanyId,
		AgentIdType	agentIdType,
		string	agentId = null,
		DateTime?	updatedSince = null,
		string	lastMoxiWorksListingId = null
	)

Index will return a paged response of listings that have been updated since a given timestamp for a specified company. For a list of company IDs that you can request listings for, use the Company Endpoint.

Parameters

moxiWorksCompanyId	A valid Moxi Works Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.
agentId	Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Listing 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 Listing request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Listing 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 Listing request to be accepted. Agent ID for your Listing request to be accepted.

Parameters

agentIdType	What agentId type you are using.
updatedSince	Paged responses of all Listing objects updated after this Unix timestamp will be returned in the response. If no updated_since parameter is included in the request, only Listing objects updated in the last seven days will be returned.
lastMoxiWorksListingId	If fetching a multi-page response, this should be the MoxiWorksListingId found in the last Listing object of the previously fetched page.

Returns

Implements MoxiWorks.Platform.Interfaces.IListingService.

UpdateListingData()

async Task<Response<ListingResults> > MoxiWorks.Platform.ListingService.UpdateListingData

(

ListingUpdate

listingUpdate

)

Updates the listing data specified in ListingUpdatableData of the ListingUpdate object

Parameters

listingUpdate

Returns

ListingResu

UpdateListingDataAsync()

async Task<Response<ListingResults> > MoxiWorks.Platform.ListingService.UpdateListingDataAsync

(

ListingUpdate

listingUpdate

)

Updates the listing data specified in ListingUpdatableData of the ListingUpdate object

Parameters

listingUpdate

Returns

ListingResu

---

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

• ListingService.cs