actindo ->bill__search
actindo -> bill__search: Search thru bills, last modified __TICKET_NAME_RSFK-294__
Signaturstring bill__search( string $sid, ajax_search_query $request [, string $type [, boolean $get_siblings [, boolean $get_positions [, positionsRequest $positionsRequest [, positionsFlags $positionsFlags]]]]] )
 
Parameter
  • string $sid
    Session identier you got from auth__login or auth__token_login
     
  • ajax_search_query $request
    Request and search query
     
  • string $type
    Bill-Type (e.g. RE, RB, AN, etc)
     
  • boolean $get_siblings
    get grouped bills
     
  • boolean $get_positions
    get bill positions
     
  • positionsRequest $positionsRequest
    available since __TICKET_NAME_RSFK-294__
     
  • positionsFlags $positionsFlags
    available since __TICKET_NAME_RSFK-294__
     
Returnsstring
Array of Bills, or FALSE or NULL on error
 
DescriptionSearch thru bills, last modified __TICKET_NAME_RSFK-294__

the parameter array $request has to be used to specify request and search query attributes:
pageno:int
paging method 1: page number for paging

n_per_page:int
paging method 1: number of items per page

start:int
paging method 2: first bill index to display (starts at idx 0)

limit:int
paging method 2: number of bills to display

sortColArray:array of arrays
field:string
column name for sorting
order:string
DESC: descendant, ASC: ascendant

sortColName:string
column name for sorting

sortOrder:string
DESC: descendant, ASC: ascendant

searchText:string
search string

searchColumns:array
columns to perform search on, for example: array( 'column1', 'column2' )

join_filter_by_or:int
if set to 1, multiple filter arrays will be joined by OR, otherwise by AND

filter:array of arrays
this parameter can be used to restrict the request and search query - it has following sub-parameters / structure:
field:string
column name to set filter to
data:array
this parameter contains values which build up the filter - it has following sub-parameters / structure:
type:string
type of the 'value' parameter - possible values: date | list | boolean | string | numeric
comparison:string
comparison operator - possible values: eq | lt | gt | ne
value:mixed
depends on what you specified for 'type' parameter - can be a value of one of the following types: date string in mysql date format 'YYYY-MM-DD' | array | boolean | string | int

example:
array(
array( 'field'=>'desired column name', 'data'=>array( 'type'=>'list', 'comparison'=>'eq', 'value'=>array( 'val1', 'val2', ... ) ) ),
array( 'field'=>'another column name', 'data'=>array( 'type'=>'string', 'comparison'=>'ne', 'value'=>'val3' ) )
)


if $get_positions is set to TRUE, you can specify two parameters, additionally:

the parameter array $positionsRequest can be used to limit or extend positions data

int get_positions_fast: if set to 1 less information is returned (no lager status, no artikel details concerning dimensions)
int get_positions_deliver_status: if set to 1 the field "delivered_amount" is returned
int get_extended_serialno_info: if set to 1, extended serialno information will be returned

HINT: get_positions_fast=1 and get_extended_serialno_info=1 is an invalid combination

the parameter array $positionsFlags has three optional values
no_lager: disable returning the lager information
sperrlager: also return lager information about sperrlager
no_stock: disable returning the stock status