{
  "opencollection": "1.0.0",
  "info": {
    "name": "TMF629- Customer Management",
    "version": "4.0"
  },
  "items": [
    {
      "info": {
        "name": "customer",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List or find Customer objects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/customer",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated properties to be provided in response.The field names should be from the first level of property names as defined in Customer schema."
              },
              {
                "name": "csrId",
                "value": "",
                "type": "query",
                "description": "It is logged in csr id and it is mandatory when List of VIP and Enterprise is fetched."
              },
              {
                "name": "sortKey",
                "value": "",
                "type": "query",
                "description": "To sort the response based on sortkeys. Possible values name. Values will be retrieved from RT perestapi.imp.cust.SORT_KEY"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "To sort the response based on sort order. Possible value ascending, descending"
              },
              {
                "name": "retrievalType",
                "value": "",
                "type": "query",
                "description": "Type of retrieval of data. 1 -> retrieves the list of all object keys along with the number of object details mentioned in retrievalLimit, 2 -> retrieves the list of all object keys, 3 -> retrieves object details for the keys mentioned in objKeys"
              },
              {
                "name": "retrievalLimit",
                "value": "",
                "type": "query",
                "description": "Limit to the number of objects retrieved. Mandatory when retrievalType is 1"
              },
              {
                "name": "objKeys",
                "value": "",
                "type": "query",
                "description": "Comma-separated object keys for which details to be retrieved. Mandatory when retrievalType is 3"
              },
              {
                "name": "customerType",
                "value": "",
                "type": "query",
                "description": "To retrieve the customers by type - SV_MAPPING:Cust_Acct_Type.DisplayName_X - RT api.imp.ALL_CC_CUSTOMER_TYPE. Can be used together with retrievalType parameter or as additional parameter to searchKey and searchValue"
              },
              {
                "name": "customerRank",
                "value": "",
                "type": "query",
                "description": "It tells if VIP list of customers are needed to be retrieved. Possible Value: VIP. Can be used together with retrievalType parameter"
              },
              {
                "name": "listEntCustFlag",
                "value": "",
                "type": "query",
                "description": "It tells if list of enterprise customers are needed to be retrieved. Possible Value: 1. Can be used together with retrievalType parameter"
              },
              {
                "name": "searchKey",
                "value": "",
                "type": "query",
                "description": "Search Keys on which data needs to be filtered. Valid Values: Name | MSISDN | IMSI | National ID | Account Number | Company Number | Passport ID. These values will be retrieved from RT perestapi.imp.cust.GlobalSrchFilters. Can be used together with retrievalType parameter"
              },
              {
                "name": "searchValue",
                "value": "",
                "type": "query",
                "description": "Value of the searchKey passed. Mandatory when searchKey is use."
              },
              {
                "name": "rootNodeId",
                "value": "",
                "type": "query",
                "description": "To retrieve the customers by root customer node id - SV_MAPPING: Cust_Acct.RootCustAcct_R. Can be used together with retrievalType parameter or as additional parameter to searchKey and searchValue."
              },
              {
                "name": "parentNodeId",
                "value": "",
                "type": "query",
                "description": "To retrieve the customers by parent customer node id - SV_MAPPING: Cust_Acct.ParentCustAcct_R. Can be used together with retrievalType parameter or as additional parameter to searchKey and searchValue."
              },
              {
                "name": "individualId",
                "value": "",
                "type": "query",
                "description": "To retrieve customer by Individual Id - SV_MAPPING:CustAcct_Contact.Contact.XSID. Can be used together with retrievalType parameter or with additional parameter customerType, rootNodeId or parentNodeId."
              },
              {
                "name": "reason",
                "value": "",
                "type": "query",
                "description": "The reason for which API is called. Valid values: BalanceTransfer. This value will be retrieved from RT perestapi.REASON. It is used with searchKey is Account Number"
              }
            ]
          },
          "docs": "This operation list or find Customer entities"
        },
        {
          "info": {
            "name": "Creates a Customer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/customer",
            "headers": [
              {
                "name": "Ignored-Warning",
                "value": ""
              }
            ]
          },
          "docs": "Creates a Customer"
        },
        {
          "info": {
            "name": "Retrieves a Customer by customer node id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/customer/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Customer Node Id, SV_MAPPING: Cust_Acct.XSID_I"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated properties to provide in response.The field names should be from the first level of property names as defined in Customer schema."
              },
              {
                "name": "effectiveDate",
                "value": "",
                "type": "query",
                "description": "To search a specific customer history record details based on a given effective date value - Format: yyyy-mm-ddThh:nn:ss "
              },
              {
                "name": "reason",
                "value": "",
                "type": "query",
                "description": "The reason for which API is called. Valid values: BalanceTransfer. This value will be retrieved from RT perestapi.REASON"
              }
            ]
          },
          "docs": "Retrieves a Customer by customer node id"
        },
        {
          "info": {
            "name": "Update a customer by customer node id.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/customer/:id",
            "headers": [
              {
                "name": "Ignored-Warning",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Customer node id, SV_MAPPING: Cust_Acct.XSID_I"
              }
            ]
          },
          "docs": "Update a customer by customer node id."
        }
      ]
    }
  ],
  "bundled": true
}