Page tree

 

 

 

 

 

 

 

Recommendation API
Conformance Profile

 

Document Number TMF680B

July 2017

 

 

 

 

 

 

 

Release: Frameworx Release 17.5

Status: Member Evaluation

Version: 1.0.1

IPR Mode: RAND

NOTICE

Copyright © TM Forum 2017. All Rights Reserved.

 

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to TM FORUM, except as needed for the purpose of developing any document or deliverable produced by a TM FORUM Collaboration Project Team (in which case the rules applicable to copyrights, as set forth in the TM FORUM IPR Policy , must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by TM FORUM or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and TM FORUM DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

 

Direct inquiries to the TM Forum office:

4 Century Drive
Suite 100
Parsippany, NJ 07054, USA

Tel No.   +1 973 944 5100

Fax No.   +1 973 944 5110

TM Forum Web Page: www.tmforum.org

Table of Contents

NOTICE

Table of Contents

List of Tables

Introduction

API Description

RESOURCE MODEL CONFORMANCE

Recommendation API MANDATORY AND OPTIONAL RESOURCES

Recommendation Resource MANDATORY AND OPTIONAL ATTRIBUTES

API OPERATIONS CONFORMANCE

Recommendation MANDATORY AND OPTIONAL OPERATIONS

API GET  OPERATION CONFORMANCE

GET / recommendation?fields=...&{filtering}

Administrative Appendix

VERSION HISTORY

Release History

Acknowledgments

Contributors to Document

 

List of Tables

N/A

 

Introduction

This document describes the REST API Conformance for the Recommendation API (TMF***)..

 

 

API Description

-           The Recommendation API provides the standardized client interface to   get the recommendation based on the related information.              

The operations that can be exercised over a recommendation resource using the API and covered in this document are those identified as mandatory to be supported such as

This document identifies the parameters that must be included in a request related to the operations above as well as the parameters expected in the response.

 

 

RESOURCE MODEL CONFORMANCE

Recommendation API MANDATORY AND OPTIONAL RESOURCES

For the Resources defined by the API, here the following table indicates which are mandatory and which ones are optional.

 

Resource Name

Mandatory / Optional

Comments

Recommendation

M

 

 

Recommendation Resource MANDATORY AND OPTIONAL ATTRIBUTES

For every single resource managed by the API, please refer to the following table indicating which attributes are mandatory and which ones are optional.

 

Parameter

Mandatory / Optional

Comments

@type

O

 

@schemaLocation

O

 

@baseType

O

 

description

O

 

i d

M (in response messages)

Generated by the  server and provided in the response upon resource creation.

h ref

M (in response messages)

Value in response must be the same as the one set in Location header provided upon entity creation

name

M

 

validFor

O

 

type

O

 

recommendationI tem

O

A list of  recommendation item s. ( Item [*] )

priority

M

 

 

productOffering

M

 

 

id

M

 

 

href

M

 

 

name

M

 

category

O

 

id

M

 

href

M

 

name

M

 

Channel

O

 

Id

M

 

href

M

 

name

M

 

S hoppingCart

O

 

Id

M

 

href

M

 

ProductOrder

O

 

Id

M

 

href

M

 

GeographicLocation

O

 

Id

M

 

href

M

 

name

M

 

type

O

 

relatedParty

O

 

Id

M

 

href

M

 

name

M

 

role

O

 

API OPERATIONS CONFORMANCE

For every single resource, here use the following templates to define what operations are optional and what operations are mandatory.

Recommendation MANDATORY AND OPTIONAL OPERATIONS

Fill the following table and indicate which ones are mandatory and which ones are optional.

 

Uniform API Operation

Mandatory/Optional

Comments

GET

O

GET must be used to retrieve  the representation of a set of resource

 

API GET  OPERATION CONFORMANCE

 

For every single resource, use the following template to specify the mandatory and optional features supported by the GET operation.

 

GET

O

THIS PATCH OPERATION

Status Code 20 0

M

 

Other Status Codes

NA

 

GET / recommendation? fields=...&{filtering}

Definitions

 

Filtered Search :

A filtered search can be applied using query parameters in order to obtain only the resource entities that meet the criteria defined by the filtering parameters included in the query request. Several elements can be applied to the filtered search. In that case logic, a logical AND is applied to combine the criteria

Filtered Data (Attribute selection):

In order to apply a filter and limit the number of attributes included in the response, the GET request can include the “?fields=” query parameter. Several elements can be applied to the filter. In that case, a logical AND is applied to combine the values  will provide in the response only the values assigned to attributes category and channel. Attribute selection capabilities are the same for collections retrieval and individual resource queries

Attribute name

Filtered search

First Level

Attribute Selection

First Level

id

M

M

href

NA

M

description

O

O

name

M

O

type

O

O

validFor

O

O

recommendationI tem

O

O

relatedParty

O

O

channel

O

O

category

O

O

geographicLocation

O

O

shoppingCart

O

O

p roductOrder

O

O

Administrative Appendix

VERSION HISTORY

Version Number

Date

Modified by

Description

Version 1.0.0

8/0 5 /2017

Ma Xu

Maxu@huawei.com

Hongxia Hao

haohongxia @huawei.com

initial version

Version 1.0. 1

7 /1 2 /2017

 

U pdated version

 

Release History

Release Number

Date

Release led by:

Description

 

 

 

 

 

Acknowledgments

This document was reviewed by members of the TM Forum API Program team.

Contributors to Document

 

  • MaXu, Huawei

maxu@huawei.com

  • Hongxia Hao , Huawei

haohongxia @huawei.com

Initial version

  • MaXu, Huawei

maxu@huawei.com

  • Hongxia Hao , Huawei

haohongxia @huawei.com

  • Lu dovic Robert

ludovic.robert@orange.com

  • Serafettin ACIR

serafettin.acir@etiya.com

Add some related information