householdQuery

  • Web Services

"Householding" describes the grouping of multiple Link IDs based on similarities in their core and/or extended attributes. The householdQuery web service is used to retrieve the collection of Link IDs that have been grouped into a household.

Refer to What is UMPI Householding? to learn more about householding and how to enable it. 

householdQuery request

    • A tracking ID (an optional identifier that the client can supply to track the response)
    • The Link ID or Household ID whose members you want to retrieve
  • { "content": {
          "householdId": "string", 
          "linkId": "string"  
          },
          "trackingId": "string"
        }
    

householdQuery response

    • An ‘echo’ of the same tracking ID from the request
    • Several Boolean and string values with more information about the success/failure of the service
    • Household ID of the household
    • A list of Link ID values in the household
  • { 
      "success": true, 
      "retryableError": true, 
      "message": "string", 
      "content": {
        "householdId": "string", 
        "linkIdsInHousehold": [ 
          "string" 
        ] 
      }, 
      "errors": [ 
        "string" 
      ], 
      "trackingId": "string" 
    }