ProductSaleAction

Version: 1.33

Parameters

Each Product Action 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.

Parameters
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.

operations

 

choice of the following:
-ApprovalOperation
-EmailOperation
-HttpRequestOperation

 - -

The operations that this Product Sale Action contains.

name

String

40

The name of the Product Sale Action.

enabled

Boolean

"True"
(Yes) or "False"
(No)

Is this Product Sale Action enabled or not?


Yes, the Product Sale Action is enabled and will occur.

No, the Product Sale Action 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.

friendlyName

String

40

You may choose to use a shorter or longer less formal name
or a name that is more explanatory than the formal name.

supportsApproval

Boolean

"True"
(Yes) or "False"
(No)

Does this Product Action support the need for Approval?


Yes, this Product Action can have an Approval set or not.

No, this Product Action cannot have an Approval set.

Entity Actions

The entity Actions enables you to see multiple pages of the entity ProductSaleAction (and ServiceAction).

Elements
Element Name Element Type Field Length Description

pageNumber

Integer

as needed

Shows the current page number.

pageSize

Integer

as needed

Shows the page size.

t otalElements

Long

as needed

Shows the total number of items found.

e lementCount

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:
-productSaleAction
-serviceAction

Either:
ProductSaleAction OR
ServiceAction

 - -

Shows the list of
- productSaleActions OR
- serviceActions.

Information for the related entity of Actions:

  • Entity Actions

Overview of Actions and Their Operations

Product Actions result in an event occurring outside of Gotransverse. For example, Product Actions can be used for fulfillment activities, such as service activation, product shipment, user credential creation, order approval, and so forth.

Actions contain Operations.

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

  • Agreement Actions

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

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

    • API 1.хх entity EmailOperation

    • API 1.хх entity HttpRequestOperation

  • API 1.хх entity ServiceAction has two types of Operations:

    • API 1.хх entity EmailOperation

    • API 1.хх entity HttpRequestOperation

The Use of Product Sale Action

The Product Sale Action is launched by the sale of a new Product to a BillingAccount during the SalesOrder process.

How to Create Product Actions and Their Operations

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

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

Perform through the GUI

  • CREATE the Actions and their Operations

  • View the list of Actions

Perform through the API

  • Query and view the list of Actions

Query for a Product Sale Action

Product Sale Actions cannot be queried as a group, but instead query for Actions which include Product Sale Actions. Actions for a particular Product are also shown when querying that Product.

Query Key Information

Querying to see Actions including Product Sale Actions 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
Query Key Value Definition

eid

Long

The unique eid number for the Action.

productEid

Long

The unique eid number of the Product.
Query to Use
Query Query for Parameter Name and Value Returns
SimpleDataQuery Action <parameter name><parameter value> List of your Actions for that parameter name and value.

SOAP Example Query

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

<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>Action</type>
                    <parameter parameter="productEid" parameterValue="774"/>
                </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/actions/<eid>

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

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