GetProductLineProducts Method

Gets a list of products for given product line and context.

Syntax

• URI:

  http://ServerName:port/siebel/v1.0/service/PDS Product Data
            Service/GetProductLineProducts?matchrequestformat=y

• HTTP Method: POST
• Content-Type: application/json
• Authorization: Basic

Arguments

Argument	Type	Description
Input Arguments	In	Hierarchy: SiebelMessage (Integration object PDS Product Line Product Interface) String: EligibilityMode String: PricingMode String: ContextMode (Optional) Hierarchy: SiebelMessage (Integration object PDS Catalog Context)
Output Arguments	Out	Hierarchy: SiebelMessage (Integration object PDS Product Line Product Interface)

Example of Input Arguments

{
  "EligibilityMode": "1",
  "PricingMode": "Y",
  "ContextMode": "SiebelContext",
  "Context": {
    "MessageId": "",
    "MessageType": "Integration Object",
    "IntObjectName": "PDS Catalog Context",
    "IntObjectFormat": "Siebel Hierarchical",
    "ListOfPDS Catalog Context": {
      "Context": {
        "ListOfSiebel Context": {
          "Siebel Context": {
            "BusObjName": "Quote",
            "ContextRowId": " 1-10MLH",
            "SignalMode": "Quote",
            "BusCompName": "Quote"
          }
        }
      }
    }
  },
  "SiebelMessage": {
    "IntObjectFormat": "Siebel Hierarchical",
    "IntObjectName": "PDS Product Line Product Interface",
    "MessageType": "Integration Object",
    "ListOfPDS Product Line Product Interface": {
      "Admin Product Line": [
        {
          "Name": "Mobile Product Line",
          "ListOfProduct": {
            "Product": {
              "searchspec": " [Product Type Code] = 'Promotion' AND [Name] LIKE '*Play*' "
            }
          }
        }
      ]
    }
  }
}

Example of Output Arguments

{
  "SiebelMessage": {
    "IntObjectFormat": "Siebel Hierarchical",
    "MessageId": "88-ARFMA",
    "IntObjectName": "PDS Product Line Product Interface",
    "MessageType": "Integration Object",
    "ListOfPDS Product Line Product Interface": {
      "Admin Product Line": [
        {
          "Primary Position Id": "No Match Row Id",
          "Name": "Supremo TV Services",
          "Id": "88-3G4XK9",
          "External Integration Id": "",
          "Description": "",
          "Integration Id": "",
          "ListOfProduct": {
            "Product": [
              {
                "#value": "88-3C1AY3",
                "Effective To": "",
                "Eligibility Status": "N",
                "Id": "88-3C1AY3",
                "Name": "Supremo QuadPlay",
                "Integration Id": "",
                "Vendor Integration Id": "",
                "Pre Pick": "Y",
                "Parent Item Id": "",
                "ThumbnImageFileExt": "",
                "Reference Price": "",
                "Sequence Number": "",
                "Description": "",
                "Part #": "88-3C1AY3",
                "Net Price": "200",
                "List Price Type Code": "STANDARD",
                "Price List Id": "88-3FZAZV",
                "Product Id": "88-3C1AY3",
                "Unit of Measure": "Per Month",
                "Product Line Id": "88-3G4XK9",
                "Original List Price": "200",
                "Category Product Active Flag": "",
                "ImageFileName": "",
                "Product Configuration Model Id": "88-3C1AY3",
                "List Price": "200",
                "Class Id": "",
                "ImageFileExt": "",
                "Eligibility Reason": "This product is not sold to:  [State] = TX",
                "ThumbnImageFileName": "",
                "Price Type": "Recurring",
                "Orderable": "Y",
                "Price List Name": "Mobile Pricelist",
                "Effective From": "",
                "Quantity": "1",
                "Product Type Code": "Promotion",
                "Currency Code": "USD",
                "Product Def Type Code": "None",
                "Inclusive Eligibility Flag": "N"
              },
              {
                "#value": "88-3C2L5B",
                "Effective To": "",
                "Eligibility Status": "Y",
                "Id": "88-3C2L5B",
                "Name": "Supremo DualPlay",
                "Integration Id": "",
                "Vendor Integration Id": "",
                "Pre Pick": "Y",
                "Parent Item Id": "",
                "ThumbnImageFileExt": "",
                "Reference Price": "",
                "Sequence Number": "",
                "Description": "Supremo Dualplay",
                "Part #": "88-3C2L5B",
                "Net Price": "100",
                "List Price Type Code": "STANDARD",
                "Price List Id": "88-3FZAZV",
                "Product Id": "88-3C2L5B",
                "Unit of Measure": "",
                "Product Line Id": "88-3G4XK9",
                "Original List Price": "100",
                "Category Product Active Flag": "",
                "ImageFileName": "",
                "Product Configuration Model Id": "88-3C2L5B",
                "List Price": "100",
                "Class Id": "",
                "ImageFileExt": "",
                "Eligibility Reason": "",
                "ThumbnImageFileName": "",
                "Price Type": "One-Time",
                "Orderable": "Y",
                "Price List Name": "Mobile Pricelist",
                "Effective From": "",
                "Quantity": "1",
                "Product Type Code": "Promotion",
                "Currency Code": "USD",
                "Product Def Type Code": "None",
                "Inclusive Eligibility Flag": "N"
              }
            ]
          }
        }
      ]
    }
  }
}

Error Conditions

Error ID	Error Message Text	User Action/Resolution
IDS_ERR_ANIESALES_MISSING_SERVICE_NAME	The '%1' user property is not defined in business service '%2'.	Need to define user prop Data Sync Service (GetProductLineProducts) in Product Selection Service.
SSAOMErrCannotCreateService	Unable to create the Business Service '%1	Check to see if the business service defined in user prop Data Sync Service (GetProductLineProducts) in Product Selection Service is defined correctly.