EmailOperation

Version: 1.33

Parameters

Each Operation 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	Element Type	Field Length	Description
queryScope	QueryScope	- -	Whether default query results are overridden by QueryScope resulting in SHALLOW or DEEP query results. See QueryScope for details.
eid	Long	System Generated	System generated unique identity number assigned to all entities in Gotransverse.
name	String	40	The name of the Email Operation.
enabled	Boolean	"True" (Yes) or "False" (No)	Is this feature of Email Operation enabled or not? Yes, Email Operation is enabled and will occur. No, Email Operation is not enabled and will not occur unless it is enabled. This feature is useful for creating Product Actions that you do not need to use immediately or all the time, but you want their information stored.
recipientEmail	String	255	The e-mail address of the person receiving the email.
useDefaultEmail	Boolean	"True" (Yes) or "False" (No)	Use the Default e-mail address that is on the Billing Account? Yes, use the default e-mail address on the Billing Account. No, do NOT use the default e-mail address on the Billing Account, use or enter a different e-mail address.
promptForEmail	Boolean	"True" (Yes) or "False" (No)	Prompt for a different e-mail address than the default e-mail address on the Billing Account)? Yes, prompt for a different e-mail address. No, do NOT prompt for an e-mail address.

Entity Operations

The entity Operations enables you to see multiple pages of the entity EmailOperation (and ApprovalOperation and HttpRequestOperation).

Entity Operations
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.
Select one: -approvalOperation -emailOperation -httpRequestOperation	Either: ApprovalOperation OR EmailOperation OR HttpRequestOperation	- -	Shows the list of - ApprovalOperation OR - EmailOperation OR - HttpRequestOperation

Information for the related entity of Operations:

Entity Operations

Overview of Actions and Their Operations

Operations are part of Actions.

Different Actions are accessible in the Gotransverse Graphical User Interface (GUI) including:

Agreement Actions
Product Actions (this link is for the GUI documentation in this documentation)

Different Types of Products have different types of Product Actions available to them. Depending upon the type of Product, within Product Actions are three to five types of Product Actions accessed through the GUI. Of those three to five types of Product Actions, two types can also be queried through the API:

API 1.хх entity ProductSaleAction has three types of Operations:
- API 1.хх entity ApprovalOperation
- EmailOperation (described on this page)
- API 1.хх entity HttpRequestOperation
API 1.хх entity ServiceAction has two types of Operations:
- EmailOperation (described on this page)
- API 1.хх entity HttpRequestOperation

The Use of Email Operation

An e-mail is sent automatically to a specific person to inform that person that the Product is in progress of being sold or has been sold. This action could be for any number of business reasons such as inventory control, 3rd party warehouse drop-shipping, manual activation of services in 3rd party systems, or statistics keeping. This Product Action is triggered on Service Devices with a status of Fulfillment or other Products with a status of In Progress or Completed or Trial.

Create Product Actions and Their Operations

In the GUI, create Product Actions of the type (new) Product Sale Actions and Service Actions that include EmailOperation. Refer to the Gotransverse Help site for more information.

You cannot create Actions or Operations including Email Operations through the API, only query them.

Perform through the GUI

CREATE the Actions and their Operations including Email Operations
View the list of Email Operations

Perform through the API

Query and view the list of Operations including Email Operations

How to Query for an Email Operation

Email Operations cannot be queried as a group, but instead, query for Operations which include Email Operations.

Query Key Information

Querying to see Operations including Email Operations needs to include one of the following parameters. If you do not know the value for the parameter, query separately to learn the value.

Query Key Parameters

Operation
Query Key	Value	Definition
eid	Long	The unique eid number for the Operation.
actionEid	Long	The unique eid number of the Action of which the Operation is a component.

Query to Use
Query	Query for	Parameter Name and Value	Returns
SimpleDataQuery	Operation	<parameter name><parameter value>	List of your Operations for that parameter name and value.

SOAP Example Query

In the following example SOAP query of Operation, the parameter of actionEid was used. The Action's EID value (in this example "1134"), was learned through a previous query on Actions.

<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>Operation</type>
                    <parameter parameter="actionEid" parameterValue="1134"/>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Query
GET https://my.tractbilling.com/t/s/r/1.33/operations/<eid>

GET https://my.tractbilling.com/t/s/r/1.33/operations?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/operations?actionEid=<actionEid>