Tangoe Procurement for Rivermine and Command [MobProc]

Release 1.3.6

New Features

Transferring Ownership of a Service Asset

Three new order transaction types were added that enable transferring ownership of a service asset from corporate to personal and vice versa.

• Transfer Service Out (XFER_SERVICE_OUT) – Used to transfer ownership from a corporate/business account to a personal account.
• Transfer Service In (XFER_SERVICE_IN) – Used to transfer ownership from a personal account to a corporate/business account. This transaction type requires that the business owner supports the same service provider (i.e., carrier). If the carrier is not supported, the Transfer Service In and Port transaction type should be used instead.
• Transfer Service In and Port (XFER_SERVICE_IN_AND_PORT) – Used to transfer ownership from a personal account to a corporate/business account where the business owner does NOT support the same carrier. In this case, service must be ported to a new carrier.

Acknowledgements

This feature enables the new order transaction types for transferring ownership of a service asset from corporate to personal and vice versa.

• /acknowledgements – This new resource is used to present the user with the information and acknowledgements that the vendor requires to be disclosed to the user when placing an order to transfer ownership. Some acknowledgments might require acceptance by the user in order for an order to be accepted by the vendor.

Fixed Issues

(N/A)

Release 1.3.1

New Features

Additional device details optionally available via the device asset collection

Two filters were added to the /assets/devices resource to allow the caller to receive additional data in the collection response to include device asset properties that were previously only available via the specific device asset resource (i.e., /assets/devices/{id}). The two filters are:

• includeServiceDetails – When set to TRUE, all details in the service property of the device asset details will be returned in the response.
• includeUpgradeEligibleDate – When this parameter and the includeServiceDetails parameter (above) are both set to TRUE, then the upgradeEligibleDate property will be included in the service details for each device asset the collection response.

Additional order details optionally available via the orders collection

Six filters were added to the /orders resource to allow the caller to receive additional data in the collection response to include order detail properties previously only available via the specific order resource (i.e., /orders/{id}). The six filters are:

• includeOrderProperties – When set to TRUE, the propertyGroup property will be populated within the order property of the Order (single) response.
• includeApprovers – When set to TRUE, the pendingApprovalLevel and approver properties will be populated within the order property of the Order (single) response.
• includeOrderSegments – When set to TRUE, the segment property will be populated within the order property of the Order (single) response.
• includeOrderShipments – When set to TRUE, the shipment property will be populated within the order property of the Order (single) response.
• includeOrderHistory – When set to TRUE, the history property will be populated within the order property of the Order (single) response.
• includeShipToAddress – When set to TRUE, the shipTo property will be populated within the order property of the Order (single) response.

Fixed Issues

(N/A)

Release 1.2.1

New Features

Filter to exclude device or plan order properties

Two filters were added to the /orders/properties resource to allow the caller to filter the response to exclude device- or plan-specific properties. Those filters are:

• orderExcludesDevice – Set to TRUE if placing an UPGRADE order that does NOT include a new device. The collection of order properties returned will not include device-specific properties.
• orderExcludesPlan – Set to TRUE if placing an UPGRADE order that does NOT include a new plan. The collection of order properties returned will not include plan-specific properties.

Filter to return only orders that are authorized to be approved by a specific employee

Two filters were added to the /orders resource to allow the caller to filter the response to only return orders that are awaiting to be approved by a specific employee:

• eligibleToApproveEmployeeId – Set to the ID (assigned by Tangoe) for the employee who is authorized to approve all of the orders returned in the response.
• eligibleToApproveCompanyEmployeeId – Set to the ID (assigned by the customer/tenant) for the employee who is authorized to approve all of the orders returned in the response.

Fixed Issues

(N/A)

Release 1.2.0

New Features

Device Upgrade Eligiblity Tracking

Properties were added to help to determine when a service asset is eligible for a device upgrade. The upgradeEligibilityDate property was added to responses that contain a service asset. Responses containing the employee object now include the updated property. The dateTimeUpdatedOnOrAfter filter parameter and UPDATED_DATE sort option were added to the /employees endpoint.

Fixed Issues

(N/A)

Release 1.1.0

New Features

Porting an Existing Service to a Different Carrier (i.e., porting a number)

This feature enables the creation of an order to port an existing service asset, including the service number, from one carrier to another. For a tutorial explaining how to use this feature, please refer to the Approving or Rejecting an Order page.

To support this feature, the following endpoints were created or modified:

• /vendors – Added the type filter to the request. This is enables filtering the response to only return carriers. Uses cases for such data includes populating a carrier selection list.
• /vendors/{id} – Added the accessMethod property to the response. This is used by the API caller to determine if a specific carrier supports a technology that is compatible with a specific device.

Approving an Order

This feature enables the approving of a specific order. To support this, the following endpoints were created or modified:

• /orders/{id}/approve – This new endpoint is used to approve or reject an order that is currently pending approval.
• /orders [GET] - Added the dateTimeUpdated filter. Also added the UPDATED_DATE sort option.
• /orders [POST] and /orders/{id} - Added the updated property.
• /me – Added the isApprover property to the response. This property returns a boolean.

Tracking, Sorting and Filtering for when Assets were Last Updated

This feature is useful for determining when an asset was last updated, as well as support for filtering and sorting on the last updated datetime.

• Device and service asset responses now include the updated property.
• Device and service asset collections can be sorted by UPDATED_DATE.
• Device and service asset collections can now be filtered by dateTimeUpdated.

Moving a Service

This feature enables moving the assignment of charges associated with a specific service asset from one employee to another. For a tutorial explaining how to use this feature, please refer to the Moving a Service page.

To support this feature, the following endpoints were created or modified:

• /assets/services/{id}/move – This new endpoint is used to execute a “move” operation.
• /me – Added the canMoveService property to the response. This property returns a boolean.

Filtering for Accessories that are Compatible with a Specific Device Asset

The compatibleWithDeviceAssetId filter parameter was added to the /catalog/accessories endpoint. Previously, API consumers could only filter the accessories catalog by a device catalog ID. This filter enables filtering by an device asset ID as well.

Custom Employee Attributes

Custom attributes can be associated with an employee record. These attributes are customizable and variable name/value pairs that are defined by the client company. Furthermore, the client company can also define what specific values are valid for each attribute. These custom attributes are included within the responses for the /me and /employees/{id} endpoints.

New Features for Premium Mobile

The following new feature only applies to API consumers who are subscribers to Tangoe’s Premium Mobile source system (also known as Command).

/diagnostics

New diagnostics will be set with a boolean value to indicate whether or not each of these three Premium Mobile roles are currently assigned:

• IS_AUTHENTICATED_USER_APPROVER
• IS_ACTOR_APPROVER
• EXECUTE_MOVE_SERVICE_PERMISSION

Fixed Issues

/vendors and /vendors/{id} endpoints

The region associated with a vendor that was returned within the response was missing the _meta block. The response now returns this metadata.