Last updated 10 months ago
Was this helpful?
Perform various operations on house records.
Symitar eDocs References: Coming soon.
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"UserNumberCredentials":{"UserNumber":1995,"Password":"2dfKQYR!TeXJwe"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/persistent/account/getHouseholdSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT 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" } } }
Successful operation.
{ "Household": { "AccountNumber": "text", "Locator": 1, "RecordChangeDate": "2025-05-18", "Type": 1 } }
POST /nexum/627/persistent/account/getHouseholdPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT 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" } } }
{ "Household": [ { "AccountNumber": "text", "Locator": 1, "RecordChangeDate": "2025-05-18", "Type": 1 } ], "Token": "text" }
POST /nexum/627/persistent/account/searchHouseholdPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT 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" } } }
POST /nexum/627/persistent/account/updateHouseholdByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT 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-05-18", "Type": 1 }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } } }
POST /nexum/627/persistent/account/createHousehold HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 258 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "HouseholdFields": { "AccountNumber": "text", "Locator": 1, "RecordChangeDate": "2025-05-18", "Type": 1 }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "HouseholdLocator": 1 }
POST /nexum/627/persistent/account/deleteHousehold HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 183 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "HouseholdLocator": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "nxAttributes": {} }
