oas_zone_inventory: Retrieve Zone Inventory Reports

Description Usage Arguments Value Note Examples

Description

This function returns a data.frame of inventory stats and forecasts broken down by a specified zone

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
oas_zone_inventory(credentials, 
                              report_name=c('Statistics by Zone', 
                                            'Forecast by Zone', 
                                            'Detail Statistics',
                                            'Detail Forecast'), 
                              site_id,
                              max_row="100",
                              zone_name=NULL,
                              start_date=NULL,
                              end_date=NULL)

Arguments

credentials

a character string as returned by oas_build_credentials

report_name

a character string one of the valid zone inventory reports

site_id

a character string containing an identifying name for a Site

max_row

a character integer limiting the number of rows returned. A character is recommended to avoid larger numbers being formatted in scientific notation and not being properly interpreted by the API.

zone_name

a character string of a particular zone name for reporting on.

start_date

a character string for inquiring inventory detail report. This field is optional and must be in the yyyy-mm-dd format.

end_date

a character string for inquiring the inventory detail report by given schedule. This field is optional and must be in the yyyy-mm-dd format.

Value

A data.frame of zone inventory data in the format of the specified report_name

Note

Zone inventory requests are only available if the Custom Zip Zone module is enabled on the account

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## Not run: 
my_credentials <- build_credentials('myaccount', 
                                    'myusername', 
                                    'mypassword')
                                    
# Note that forecast reports must have start and end dates >= Sys.Date()
otherwise they will return 0 row data.frames                                  
zone_forecast <- oas_zone_inventory(credentials=my_credentials, 
                                        report_name='Forecast by Zone',
                                        site_id='www.mysite.com',
                                        max_row='20000',
                                        zone_name='UNKNOWN',
                                        start_date='2015-12-01', 
                                        end_date='2015-12-31')
                                     

## End(Not run)

ReportMort/roas documentation built on May 9, 2019, 9:45 a.m.