_get

Fetch the values of an array of settings.

Parameters

names

The array of settings whose values you want to retrieve.

Example

FM_api('Settings_get', ['names' => ['acc-labour-nominal',
                                    'acc-labour-taxtype',
                                    'acc-mileage-nominal',
                                    'acc-mileage-taxtype',
                                    'acc-rates-nominal',
                                    'acc-rates-taxtype',
                                    'acc-default-nominal',
                                    'acc-default-taxtype',
                                    'allow-job-import-with-duplicate-job-ref',
                                    'app-icon',
                                    'app-header',
                                    'appointment-amber-days',
                                    'appointment-priorities',
                                    'block-task-email-notifications',
                                    'company-address',
                                    'customer-landline-unique',
                                    'customer-portal-asset-set',
                                    'customers-require-landlines',
                                    'date-format',
                                    'default-vat',
                                    'disable-app-archives',
                                    'disable-app-customer-files',
                                    'disable-app-job-ref',
                                    'disable-app-referrals',
                                    'disable-appointment-time-in-progress-update',
                                    'disable-job-notification',
                                    'disable-job-ref-in-appointment-creation',
                                    'do-not-copy-customer-ref-to-new-recurrences',
                                    'do-not-copy-user-to-new-recurrences'
                                    'ip-restriction',
                                    'job-ref-method',
                                    'job-time-increments',
                                    'overtime-multiplier',
                                    'replyto-email',
                                    'recurrence-days'
                                    'restrict-appointment-selection',
                                    'schedule-of-rates-source',
                                    'stock-trigger-email',
                                    'time-format',
                                    'travel-is-labour-cost',
                                    'vat-registration-number',
                                    'week-begins',
                                    'wizard',
                                    'work-day-start',
                                    'work-day-end',
                                    'work-start-location']]);

Results

On Success

A JSON array of the submitted settings with their values, if they have any. For example:

{'acc-labour-nominal':'',
 'acc-labour-taxtype':'',
 'acc-mileage-nominal':'',
 'acc-mileage-taxtype':'',
 'acc-rates-nominal':'',
 'acc-rates-taxtype':'',
 'acc-default-nominal':'',
 'acc-default-taxtype':'',
 'allow-job-import-with-duplicate-job-ref':'0',
 'app-icon':'\/images\/appicon-35.png',
 'app-header':'\/images/\appheader.png',
 'appointment-amber-days':'5',
 'appointment-priorities':'None Low Normal High Top 4 Hour|4 8 Hour|8 24 Hour|24 48 Hour|48 1 Week|168 4 Week|672',
 'block-task-email-notifications':'',
 'company-address':'',
 'customer-landline-unique':'0',
 'customer-portal-asset-set':'',
 'customers-require-landlines':'0',
 'date-format':'dd/mm/yy',
 'default-vat':'20',
 'disable-app-archives':'',
 'disable-app-customer-files':'',
 'disable-app-job-ref':'',
 'disable-app-referrals':'',
 'disable-appointment-time-in-progress-update':'0',
 'disable-job-notification':'0',
 'disable-job-ref-in-appointment-creation':'1',
 'do-not-copy-customer-ref-to-new-recurrences':'0',
 'do-not-copy-user-to-new-recurrences':'0'
 'ip-restriction':'',
 'job-ref-method':'0',
 'job-time-increments':'5',
 'overtime-multiplier':'1',
 'replyto-email':'',
 'recurrence-days':'30',
 'restrict-appointment-selection':'',
 'schedule-of-rates-source':'0',
 'stock-trigger-email':'',
 'time-format':'24h',
 'travel-is-labour-cost':'0',
 'vat-registration-number':'',
 'week-begins':'',
 'wizard':'1',
 'work-day-start':'510',
 'work-day-end':'1020',
 'work-start-location':''}

On Failure

If the user is not logged in:

{'error':'not logged in'}

Last updated