httpRequestOperation

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.

Element
Name		 Element
Type		 Field
Length		 Description

queryScope

QueryScope

 - -

Whether default query results are overridden by QueryScope resulting in SHALLOW or DEEP query results. Refer to 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 Http Request Operation.

enabled

Boolean

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

Is this feature of Http Request Operation enabled or not?

Yes, Http Request Operation is enabled and will occur.

No, Http Request 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.

url

String

255

The URL to which the HTTP Request is being made.

Entity Operations

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

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

    API 1.xx entity ApprovalOperation

    API 1.xx entity EmailOperation

    HttpRequestOperation (described on this page)

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

    API 1.xx entity EmailOperation

    HttpRequestOperation (described on this page)

The Use of Http Request Operation

The HTTP Request Operation Product Action performs an API call. A URL can be configured with User ID and password to enable integration to external web services sending order specific information from Gotransverse to the external system. The HTTP Post can occur when the Product is in progress of being sold or has been sold. This Product Action is launched when Service Devices have a status of Fulfillment, or other Products have a status of In Progress or Completed or Trial.

How to Create Product Actions and Their Operations

In the GUI, 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 Http Request Operations through the API, only query them.

Perform through the GUI

  • CREATE the Actions and their Operations including Http Request Operations

  • View the list of Http Request Operations

Perform through the API

  • Query and view the list of Operations including Http Request Operations

Query for an Http Request Operation

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

Query Key Information

Querying to see Operations including Http Request 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>