Environment

It provides the environment details of the server.

Possible Locations

Server

Child Elements

Description

Attributes

Name	Type	Description
type required	String (enum)	The environment in which the user can access the resource. The possible values are development, sandbox, production.
location	String (enum)	The possible locations of the argument are header and param.
name	String	Name of the header / param.
value	String	Value of the header / param.

Note:

The value and location attributes become mandatory when you have specified a value for the name attribute.

Example

Following are the environment details of the <server> used for trips resource,

    
        copy
        
            
        
    
    
         
environments: development, sandbox
location and value of argument for development: param and dev 
location and value of argument for sandbox: param and sand

Now, define the environment with these details as shown here.

    
        copy
        
            
        
    
    
         
<server name="travel_bureau_server" url="https://travelbureauapis.com" dc="US">
    <environment type="development" name="env" value="dev" location="param">
        <description> To switch the resource to development environment, provide this name and value in the parameter. </description>
    </environment>
    <environment type="sandbox" name="env" value="sand" location="param">
        <description> To switch the resource to sand box environment, provide this name and value in the parameter. </description>
    </environment>
</server>

Last Updated 2025-05-30 16:54:59 +0530 +0530

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit