Household

Perform various operations on house records.

Symitar eDocs References: Coming soon.

Operations

getHouseholdSelectFields

post
Authorizations
Body
AccountNumberstringOptional
HouseholdLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getHouseholdSelectFields
POST /nexum/627/persistent/account/getHouseholdSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "HouseholdLocator": 1,
  "SelectableFields": {
    "IncludeAllHouseholdFields": true,
    "HouseholdFields": {
      "AccountNumber": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Household": {
    "AccountNumber": "text",
    "Locator": 1,
    "RecordChangeDate": "2025-11-07",
    "Type": 1
  }
}

getHouseholdPagedListSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getHouseholdPagedListSelectFields
POST /nexum/627/persistent/account/getHouseholdPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 402

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllHouseholdFields": true,
    "HouseholdFields": {
      "AccountNumber": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Household": [
    {
      "AccountNumber": "text",
      "Locator": 1,
      "RecordChangeDate": "2025-11-07",
      "Type": 1
    }
  ],
  "Token": "text"
}

searchHouseholdPagedSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/searchHouseholdPagedSelectFields
POST /nexum/627/persistent/account/searchHouseholdPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 434

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllHouseholdFields": true,
    "HouseholdFields": {
      "AccountNumber": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Household": [
    {
      "AccountNumber": "text",
      "Locator": 1,
      "RecordChangeDate": "2025-11-07",
      "Type": 1
    }
  ],
  "Token": "text"
}

updateHouseholdByID

post
Authorizations
Body
AccountNumberstringOptional
HouseholdLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/updateHouseholdByID
POST /nexum/627/persistent/account/updateHouseholdByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "HouseholdLocator": 1,
  "HouseholdFields": {
    "AccountNumber": "text",
    "Locator": 1,
    "RecordChangeDate": "2025-11-07",
    "Type": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": {
      "Record": "text",
      "ErrorCode": "text",
      "ErrorMessage": "text",
      "PrimaryKeyField": [
        {
          "Name": "text",
          "Value": "text"
        }
      ]
    }
  }
}

createHousehold

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/createHousehold
POST /nexum/627/persistent/account/createHousehold HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "HouseholdFields": {
    "AccountNumber": "text",
    "Locator": 1,
    "RecordChangeDate": "2025-11-07",
    "Type": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "HouseholdLocator": 1
}

deleteHousehold

post
Authorizations
Body
AccountNumberstringOptional
HouseholdLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/deleteHousehold
POST /nexum/627/persistent/account/deleteHousehold HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "HouseholdLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "nxAttributes": {}
}
PreviousFmHistoryPagedListNextIrs

Last updated

Was this helpful?