Household

Perform various operations on house records.

Symitar eDocs References: Coming soon.

Operations

getHousehold

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

HouseholdLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getHousehold

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getHousehold HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "HouseholdLocator": 272,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Household": {
    "Locator": 272,
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getHousehold"
}

getHouseholdSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

HouseholdLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getHouseholdSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "HouseholdLocator": 272,
  "SelectableFields": {
    "IncludeAllHouseholdFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

getHouseholdPagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getHouseholdPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getHouseholdPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

getHouseholdListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/getHouseholdListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getHouseholdListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "SelectableFields": {
    "IncludeAllHouseholdFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "HouseholdList": [],
  "MessageId": "getHouseholdListSelectFields"
}

searchHouseholdSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/searchHouseholdSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchHouseholdSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 281

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "SelectableFields": {
    "IncludeAllHouseholdFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "HouseholdList": [],
  "MessageId": "searchHouseholdSelectFields"
}

getHouseholdPagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getHouseholdPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchHouseholdPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

HouseholdLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/updateHouseholdByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "HouseholdLocator": 272,
  "HouseholdUpdatableFields": {
    "Type": 1,
    "AccountNumber": "0000013324"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateHouseholdByID"
}

createHousehold

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

HouseholdLocatorintegerOptional

post/createHousehold

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "HouseholdCreatableFields": {
    "Type": 0,
    "AccountNumber": "0000013324"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

deleteHousehold

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

HouseholdLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteHousehold

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "HouseholdLocator": 272,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "MessageId": "deleteHousehold"
}