API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformTeam

Summary

Methods
Properties
Constants
headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
__construct()
find()
search()
$uuid
$name
$email
$address1
$address2
$city
$state
$zipcode
$phone
$fax
$logo_url
$photo_url
$description
$social_media_urls
$alt_phone
$alt_email
$website_url
$active
No constants found
No protected methods found
No protected properties found
N/A
sendRequest()
No private properties found
N/A

Properties

$uuid

$uuid : string

Type

string — The unique ID of the Team

$name

$name : string

Type

string — The human readable name of the team

$email

$email : string

Type

string — Contact email address for the team

$address1

$address1 : string

Type

string — First line of contact address for the team

$address2

$address2 : string

Type

string — Second line of contact address for the team

$city

$city : string

Type

string — City portion of contact address for the team

$state

$state : string

Type

string — State portion of contact address for the team

$zipcode

$zipcode : string

Type

string — Postal Code portion of the contact address for the team

$phone

$phone : string

Type

string — contact phone number for the team

$fax

$fax : string

Type

string — fax number for the team

$logo_url

$logo_url : string

Type

string — URL to a logo image for the team

$photo_url

$photo_url : string

Type

string — First URL to a image representing the team

$description

$description : string

Type

string — Description of the team. can contain embedded HTML

$social_media_urls

$social_media_urls : array

Type

array — Social media URLs associated with the team

$alt_phone

$alt_phone : string

Type

string — Alternate contact phone number for the team

$alt_email

$alt_email : string

Type

string — Alternate contact email address for the team

$website_url

$website_url : string

Type

string — URL to the website for the team

$active

$active : boolean

Type

boolean — Whether the team is active or not

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)

Team constructor.

Parameters

array $data

find()

find(array  $attributes = array()) : \MoxiworksPlatform\Team|null

Find an Team on Moxi Works Platform.

find can be performed including the Moxi Works Team ID in a parameter array \MoxiworksPlatform\Team::find([moxi_works_team_id: 'abc123'])

Parameters

array $attributes


moxi_works_team_id REQUIRED The Moxi Works Team ID for the team

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Team|null

search()

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

Search for Teams by Company on Moxi Works Platform.

search can be performed by including moxi_works_company_id and updated_since in a parameter array \MoxiworksPlatform\Team::search([moxi_works_company_id: 'abc123'])

Parameters

array $attributes


moxi_works_company_id REQUIRED string The Moxi Works Company ID for the company in which we are searching for teams

  <h2>
optional Task search parameters

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 —

array of Team objects:

sendRequest()

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

Parameters

$method
array $opts
null $url

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Team|null