Household

Perform various operations on house records.

Symitar eDocs References: Coming soon.

Operations

getHouseholdSelectFields

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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: 241

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013454",
  "HouseholdLocator": 271,
  "SelectableFields": {
    "IncludeAllHouseholdFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Household": {
    "Locator": 271,
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getHouseholdSelectFields"
}

getHouseholdPagedListSelectFields

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

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: 390

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllHouseholdFields": false,
    "HouseholdFields": {
      "Locator": true,
      "Type": true,
      "AccountNumber": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Household": [],
  "Token": null,
  "MessageId": "getHouseholdPagedListSelectFields"
}

searchHouseholdPagedSelectFields

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

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: 410

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013454",
  "Query": "LOCATOR=0",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllHouseholdFields": false,
    "HouseholdFields": {
      "Locator": true,
      "Type": true,
      "AccountNumber": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Household": [],
  "Token": null,
  "MessageId": "searchHouseholdPagedSelectFields"
}

updateHouseholdByID

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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: 245

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "HouseholdLocator": 271,
  "HouseholdFields": {
    "Type": 1,
    "AccountNumber": "0000013324"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateHouseholdByID"
}

createHousehold

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

HouseholdLocatorintegerOptional

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: 222

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "HouseholdFields": {
    "Type": 0,
    "AccountNumber": "0000013324"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "HouseholdLocator": 271,
  "MessageId": "createHousehold"
}

deleteHousehold

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

HouseholdLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

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: 187

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "HouseholdLocator": 271,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "MessageId": "deleteHousehold"
}