ApprovalOperation

Version: 1.33

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.xx entity ProductSaleAction has three types of Operations:

    • ApprovalOperation (described on this page)

    • API 1.xx entity EmailOperation

    • API 1.xx entity HttpRequestOperation

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

    • API 1.xx entity EmailOperation

    • API 1.xx entity HttpRequestOperation

The Use of Approval Operation

A Product can be configured to require an Approval before an Order completes. This action keeps the Order in "Pending" status until all the Services on the Order are approved. The Approval is either manual through Gotransverse or through the API from an external system or the Approval can be set in the GUI or through the API to autoApprove. All related services are only activated after the Approval has taken place. This Product Action is triggered on Service Devices with a status of "Fulfillment," or other Products with a status of "In Progress" or "Trial."

Create Product Actions and Their Operations

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

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

Perform through the interface

  • CREATE the Actions and their Operations including Approval Operations

  • View the list of Approval Operations

Perform through the API

  • Query and view the list of Operations including Approval Operations

Parameters

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.

name

String

40

The name of the Approval Operation.

enabled

Boolean

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

Is this feature of Approval Operation enabled or not?


Yes, Approval Operation is enabled and will occur.

No, Approval 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.

autoApprovalDate

DateTime

See
Data Types page
for dateTime
formats

Optional. The date that can be set for Gotransverse to automatically approve the event.
Without a date for autoApprovalDate, then the Approval operation is manual and
needs to be performed by you or another user. For this date to be effective,
the next field of autoApprovalEnabled needs to be set with an earlier date.

autoApprovalEnabled

Boolean

"True"
(Yes)

or

"False"
(No)

AutoApproval ensures for example, that an Order is completed with or without
a manual Approval. Is auto approval enabled or not?

Yes, Auto Approval is enabled.

No, Auto Approval is NOT enabled.

Query an ApprovalOperation

Query Key Information

Querying to see Operations including Approval 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.

Use Operations to retrieve paged results.

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 Endpoint

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>