- Home
- Models
- Reports
Reports
    Reports can be generated to get an overview of progress for a given month and year.
    
    Reports fields
    
        
            
                | Field | Type | Fillable | Reference | 
            
        
        
                            
                    | id | Integer |  |  | 
                
                    | The unique ID to identify the report | 
                    
    
    
    Reports relations
            There are no relations for this model
        
    Reports endpoints
                    
            
                
GET List all Reports /reports  toggle
            
            
                
                
                Paramaters
                
                                            There are no parameters for this endpoint
                                    
Example response
                    
                             
         
                        
            
                
GET Return data for a specified Report /reports/:id  toggle
            
            
                
                                    URL slugs
                    
                                                    - id
- 
    Integer
 
The unique ID to identify the report
Paramaters
                
                                            There are no parameters for this endpoint
                                    
Example response
                    
                             
         
                        
            
                
POST Save, or update a Report /reports/:id?  toggle
            
            
                
                                    URL slugs
                    
                                                    - id
- 
    Integer
 
The unique ID to identify the report
Paramaters
                
                                            - assigned_id
- 
    Reference
 
    
        Nullable
    
     
    References user model.
- event_id
- 
    Reference
 
    
        Nullable
    
     
    References event model.
- form_id
- 
    Reference
 
    
        Nullable
    
     
    References form model.
- month
- 
    Integer
 
    
        Nullable
    
     
The month the report is to be generated for i.e. 1, 10
    Required
- owner_id
- 
    Reference
 
    
        Nullable
    
     
    References user model.
- title
- 
    String
 
    
        Nullable
    
     
The title of the report, this is for your reference
    Required
- year
- 
    Integer
 
    
        Nullable
    
     
The year the report is to be generated for
    Required
 
         
                        
            
                
POST Refresh the specified report /reports/:id  toggle
            
            
                
                                    URL slugs
                    
                                                    - id
- 
    Integer
 
The unique ID to identify the report
Paramaters
                
                                            There are no parameters for this endpoint
                                    
 
         
                        
            
                
DELETE Delete a Report /reports/:id  toggle
            
            
                
                                    URL slugs
                    
                                                    - id
- 
    Integer
 
The unique ID to identify the report
Paramaters
                
                                            There are no parameters for this endpoint