API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformPresentationLog

Summary

Methods
Properties
Constants
headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
__construct()
search()
$agent_uuid
$agent_fname
$agent_lname
$title
$created
$edited
$agent_office_id
$type
$sent_by_agent
$pdf_requested
$pres_requested
$external_identifier
$external_office_id
$moxi_works_presentation_id
No constants found
No protected methods found
No protected properties found
N/A
sendRequest()
No private properties found
N/A

Properties

$agent_uuid

$agent_uuid : string

Type

string — This is the Moxi Works Platform ID of the presentation_log which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID.

$agent_fname

$agent_fname : string

Type

string — First name of agent. This can be null if there is no data for this attribute.

$agent_lname

$agent_lname : string

Type

string — Last name of agent. This can be null if there is no data for this attribute.

$title

$title : string

Type

string — The title of the presentation. This can be null if there is no data for this attribute.

$created

$created : string

Type

string — This is the Unix timestamp for the creation time of the presentation.

$edited

$edited : string

Type

string — This is the Unix timestamp for the last time the presentation was edited.

$agent_office_id

$agent_office_id : string

Type

string — This is the ID of the office for the Agent associated with the presentation. This will be an integer.

$type

$type : string

Type

string — Whether the presentation is for a buyer or seller.

$sent_by_agent

$sent_by_agent : string

Type

string — The UUID of the agent that sent the presentation to the client. This will be an RFC 4122 compliant UUID.

$pdf_requested

$pdf_requested : string

Type

string — The number of PDF documents requested.

$pres_requested

$pres_requested : string

Type

string — The number of Online presentations requested.

$external_identifier

$external_identifier : string

Type

string — This is the ID of the Agent utilized by their company.

$external_office_id

$external_office_id : string

Type

string — This is the ID of the office for this Agent utilized by their company.

$moxi_works_presentation_id

$moxi_works_presentation_id : string

Type

string — The unique UUID of the presentation. This will be an RFC 4122 compliant UUID.

Methods

headers()

headers()

authHeader()

authHeader()

acceptHeader()

acceptHeader()

contentTypeHeader()

contentTypeHeader()

userAgentHeader()

userAgentHeader()

apiConnection()

apiConnection(  $method,   $url,   $attributes)

Parameters

$method
$url
$attributes

checkForErrorInResponse()

checkForErrorInResponse(  $json)

Parameters

$json

underscore()

underscore(  $attr)

Parameters

$attr

__construct()

__construct(array  $data)

PresentationLog constructor.

Parameters

array $data

search()

search(array  $attributes = array()) : Array

Search for PresentationLogs by Agent ID on Moxi Works Platform.

search can be performed by including moxi_works_company_id and updated_since in a parameter array \MoxiworksPlatform\PresentationLog::search([created_after: 1234, created_before: 2345])

Parameters

array $attributes


moxi_works_company_id string The Moxi Works Company ID for the company in which we are searching for presentation logs

optional Task search parameters 

  <br><b>updated_after </b> integer  Unix timestamp representing the start time for the search. If no <i>updated_after</i> parameter is included in the request, only presentations updated in the last seven days will be included in the response.
  <br><b>updated_before </b> integer  Unix timestamp representing the end time for the search. If no <i>updated_before</i> parameter is included in the request, only presentations updated in the seven days following <i>updated_after</i> will be included in the response.
  <br><b>created_after </b> integer  Unix timestamp representing the start time for the search.
  <br><b>created_before </b> integer  Unix timestamp representing the end time for the search. If no <i>created_before</i> parameter is included in the request, only presentations updated in the seven days following <i>created_after</i> will be included in the response.

Note: only updated_after and updated_before or created_after and created_before can be used when searching.

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\Exception\ArgumentException

if at least one search parameter is not defined

\MoxiworksPlatform\RemoteRequestFailureException

Returns

Array —

paged response array with the format: [ page_number: [Integer], total_pages: [Integer], agents: [Array] containing MoxiworkPlatform\PresentationLog objects ]

sendRequest()

sendRequest(  $method, array  $opts = array(), null  $url = null) : \MoxiworksPlatform\PresentationLog|null

Parameters

$method
array $opts
null $url

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\PresentationLog|null