CORE POS - Fannie
The CORE POS back end
Static Public Member Functions | List of all members
COREPOS\Fannie\API\member\MemberREST Class Reference

Static Public Member Functions

static testMode ($mode)
 
static get ($id=0)
 
static post ($id, $json)
 
static setBlueLines ($id)
 
static search ($json, $limit=0, $minimal=false)
 
static nextAccount ($id)
 
static prevAccount ($id)
 
static autoComplete ($field, $val)
 
static getPrimary ($json)
 
static getHousehold ($json)
 

Member Function Documentation

static COREPOS\Fannie\API\member\MemberREST::autoComplete (   $field,
  $val 
)
static

Provide lookups for the autocomplete service

Parameters
$field[string] field name being autocompleted
$val[string] partial field
static COREPOS\Fannie\API\member\MemberREST::get (   $id = 0)
static

Get an array representing a customer account

Parameters
$id[int] account ID (classically card_no / CardNo)
Returns
[array] account info or [boolean] false

Omitting the $id return an array of all accounts as is typical with REST endpoints

static COREPOS\Fannie\API\member\MemberREST::nextAccount (   $id)
static

Get the next account number sequentially

Parameters
$id[int] account identifier
Returns
[int] next account identifier
static COREPOS\Fannie\API\member\MemberREST::post (   $id,
  $json 
)
static

Update a customer account

Parameters
$id[int] account ID (classically card_no / CardNo)
$json[array] settings in same format as returned by get()
Returns
[array] error count
static COREPOS\Fannie\API\member\MemberREST::prevAccount (   $id)
static

Get the previous account number sequentially

Parameters
$id[int] account identifier
Returns
[int] previous account identifier
static COREPOS\Fannie\API\member\MemberREST::search (   $json,
  $limit = 0,
  $minimal = false 
)
static

Search for an account

Parameters
$json[array] account attributes. All fields are optional, but if no search fields are provided this returns zero results rather than every single account.
$limit[int, default=0] optional result set size limit
Returns
[array] of account structures
static COREPOS\Fannie\API\member\MemberREST::setBlueLines (   $id)
static

Assign blueLine values to account based on template configuration

Parameters
$id[int] account identifier

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