SystemSetting

Version: 1.33

Using systemSetting is optional and four System Settings in Gotransverse through the API can be queried:

  • "Max Number of API Requests" — Maximum number of API requests to be processed per batch in an API batch request.

  • "Overall Invoice Distribution" — This setting defines which invoice distribution methods should be used during the process of invoice generation. Possible values: None, Email, Paper.

  • "Max Number of API Entities Returned in Query Response" — Maximum number of top level entities allowed in an API query response.

  • "Mandatory Billing Address" — This parameter determines if a billing address is required during billing account and order creation.

To see the other 80+ System Settings or to change any of the System Settings, use Gotransverse's Graphical User Interface (GUI).

This page provides the following Gotransverse API information for this entity of SystemSetting:

Parameters

Each systemSetting shown from the Query shows information for a number of elements in the entity. The following table shows the elements, details of the elements, and brief descriptions.

Elements
Element Name Query
Key		 Element
Type		 Field
Length		 Description

queryScope

QueryScope

 - -

The depth of the query results, whether
they are SHALLOW or DEEP.
See QueryScope for details.

eid

Long

System
Generated

System generated unique identity number
assigned to all entities in Gotransverse.

name

Y

String

40

The name of the System Setting.

value

String

255

The value of the System Setting. For example,
if the value is boolean, then a "yes" or "no."
If the value is numeric, then the number.

description

String

255

The description of the System Setting

Entity SystemSettings

The entity SystemSettings enables you to see multiple pages of the entity SystemSetting.

SystemSetting
Element Name Element
Type		 Field
Length		 Description

pageNumber

Integer

as needed

Shows the current page number.

pageSize

Integer

 

as needed

Shows the page size.

totalElements

 

Long

as needed

 

Shows the total number of items found.

 

elementCount

Integer

as needed

Shows the current count of the item
in the number of items that were found.

totalPages

Integer

as needed

 

Shows the total number of pages.

 

systemSetting

SystemSetting

 - -

Shows the list of SystemSettings

Information for the related entity of SystemSettings:

  • Entity SystemSettings

Query for a SystemSetting

Query Key Information

To query for all System Settings, use the SimpleDataQuery with no parameters.

SimpleDataQuery
Query to Use Query for Returns

SimpleDataQuery

SystemSetting

List of all of your System Settings.

To query for more specific information, use the SimpleDataQuery with the parameter of one of the following Query Keys:

SystemSetting
Query Key Value Definition

name

String

The name of the systemSetting.

Do Not Know Query Key Information

If you do not know the System Setting's name, or you want a list of the SystemSettings (in increments of 50):

SystemSetting
Query to Use Query for Returns

SimpleDataQuery

SystemSetting

List of all of your System Settings.

SOAP Example Query and Response

The following SOAP example is a general query of PriceList: 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:query xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:queryRequest>
                <simpleDataQuery startIndex="0" size="50">
                    <type>SystemSetting</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

This was the response: 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:queryResponse xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:return successful="true">
                <systemSettings pageNumber="1" pageSize="50" totalElements="4" elementCount="4" totalPages="1">
                    <systemSetting name="Max Number of API Requests" 
value="50" description="Maximum number of API requests to be processed per batch 
in an API batch request"/>
                    <systemSetting name="Overall Invoice Distribution" value="Email,None" 
description="This setting defines which invoice distribution methods should be used 
during the process of invoice generation. Possible values: None, Email, Paper"/>
                    <systemSetting name="Max Number of API Entities Returned in Query Response" 
value="50" description="Maximum number of top level entities allowed in an API query response."/>
                    <systemSetting name="Mandatory Billing Address" value="true" 
description="This parameter determines if a billing address is required during billing account and order creation"/>
                </systemSettings>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Query
GET https://my.tractbilling.com/t/s/r/1.33/systemSettings

GET https://my.tractbilling.com/t/s/r/1.33/systemSettings/<name>
GET https://my.tractbilling.com/t/s/r/1.33/systemSettings?name=<name>

REST Example Query and Response

The following REST example is a general query of SystemSettings:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<systemSettings xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="4" elementCount="4" totalPages="1">
    <ns2:systemSetting name="Max Number of API Requests" value="50" 
description="Maximum number of API requests to be processed per batch in an 
API batch request"/>
    <ns2:systemSetting name="Overall Invoice Distribution" value="Email,None" 
description="This setting defines which invoice distribution methods should be 
used during the process of invoice generation. Possible values: None, Email, Paper"/>
    <ns2:systemSetting name="Max Number of API Entities Returned in Query Response" value="50" 
description="Maximum number of top level entities allowed in an API query response."/>
    <ns2:systemSetting name="Mandatory Billing Address" value="true" 
description="This parameter determines if a billing address is required during billing account 
and order creation"/>
</systemSettings>