Linear Relationship Candidates Response

Inspect candidate related items, applicable rules, and request status for a source line item.

JSON Example 

1{
2  "lineItemId": "801xx0000012AbcAAE",
3  "offset": 0,
4  "pageSize": 25,
5  "productName": "5G Plan",
6  "relatedItems": [],
7  "rules": [],
8  "status": {"code":"200","errors":[],"message":"OK"},
9  "totalCount": 0
10}

Properties 

Property NameTypeDescriptionRequired or OptionalAvailable Version
lineItemIdStringSource line item ID used for candidate retrieval.Optional68.0
offsetIntegerResponse offset value applied to this page.Optional68.0
pageSizeIntegerPage size used for this response.Optional68.0
productNameStringName of the source product associated with the line item.Optional68.0
relatedItemsObject[]Candidate related line items eligible to link with the source product.Optional68.0
rulesObject[]Applicable Relies On rule records and cardinality state for the source line item.Optional68.0
statusObjectStatus details with request code, message, and error list.Optional68.0
totalCountIntegerTotal number of available candidate items before pagination.Optional68.0