ZSPEC Sample

We will use the example of developing the Trips API for a Travel Bureau product. When writing an effective ZSPEC, it’s crucial to consider the core components that make up any API, including domains, endpoints, methods, parameters, request payload, response, error handling, throttling, and authentication.

Authentication and a few responses are re-used from a common resource to keep this sample short and crisp. We have used almost covered all the elements of ZSPEC in this product to provide you an overview of their functionalities. To learn more, download this zip file and take a look at the dependencies. You can also upload the same zip to ZEST and witness the life cycle of the APIs in a few clicks.

    

        
copy
        

            

        
    
    

         

    
        
            
                Name of the trip.
            
            
                The unique record ID of the trip.
            
            
                Destination of the trip.
            
            
                The starting time of the trip.
            
            
                
                The ending time of the trip.
            
            
                The total number of trip days.
            
            
                Your preferred medium of transport.
             
            
                Elaborate your hybrid details and the list of your preferred medium of transport.
            
            
                Type of your accommodation.
            
            
                Details of the travelers.
                
                    
                        Name of the traveler.
                    
                    
                        Email ID of the traveler.
                    
                
            
            
                Budget of your trip.
            
            
                 
                    List of adventure activities according to the suggestions of traveler(s).
                    
                        
                    
                
                
                    Denotes whether adventure activities can be included in the trip. 
                        - **true**: Adventure activities will be included in the trip. 
                        - **false**: Adventure activities are not included in the trip. 
                
            
        
        
            
                
            
        
        
            
            
        
        
            
        
        
            Specify the id(s) for which the operation has to take place.
            
                
                
                    
                
            
        
        
            Specify the service from which the resource is consumed.
            
                
                
                    
                
            
        
    
    
        Trips holds details such as trip itineraries, departure and arrival information, and other relevant data regarding a trip in the Travel Bureau. It offers all four CRUD operations for the effective management of records in the resource.
        
        
        
    
    
        
            
        
    
    
    
        
            This operation fetches the trips details available in the Travel Bureau. You can also provide the IDs of the records to get only the details of particular records.
            
            
            
                These are the response JSON keys that represents the trips resource in the Travel Bureau.
                
            
            
            
        
        
            It helps you to add new trips to the Travel Bureau.
            
            
            
            
            
        
        
            It aids you in updating the details of the existing trips data in the Travel Bureau.
            
            
            
            
            
        
        
            This helps you to delete the existing trips records in the Travel Bureau.