Account management

You can List, Create, Edit and Delete residents using these endpoints.

Model

A sample Resident object is below

{
    "organization":"1654740730258x343197985783152640",
    "building": "T2",
    "email": "[e-mail]",
    "externalID": "1234456",
    "firstName": "Happy",
    "lastName": "Resident",
    "passphrase": "mypersonalpassphrase3",
    "phone": "4156234444",
    "stopDate": "2023-06-09T02:12:11.858Z",
    "tenantServiceStatus": "Active",
    "terminationMode": "Schedule stop date",
    "unit": "1112"
}

Managing Residents

List all Residents

List all Resident in the Organization

GEThttps://www.cusna.io/api/1.1/obj/resident

Response

200

List all Resident in the Organization

Body

application/json

responseinline_response_200_1_response (object)

Request

JavaScriptCurlPython

const response = await fetch('https://www.cusna.io/api/1.1/obj/resident', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "response": null
}

Create and activate new Residents. The activation email is sent automatically on the service activation date.

Auto generated using Swagger Inspector

POSThttps://www.cusna.io/api/1.1/obj/resident

Body

application/json

tenantServiceStatusstring

firstNamestring

lastNamestring

terminationModestring

unitstring

phonestring

organizationstring

externalIDstring

passphrasestring

buildingstring

emailstring

stopDatestring

Response

201

Auto generated using Swagger Inspector

Body

application/json

idstring

statusstring

Request

JavaScriptCurlPython

const response = await fetch('https://www.cusna.io/api/1.1/obj/resident', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("{\n    \"building\": \"T2\",\n    \"email\": \"[e-mail]\",\n    \"externalID\": \"1234456\",\n    \"firstName\": \"Happy\",\n    \"lastName\": \"Resident\",\n    \"passphrase\": \"mypersonalpassphrase3\",\n    \"phone\": \"4156234444\",\n    \"stopDate\": \"2023-06-09T02:12:11.858Z\",\n    \"tenantServiceStatus\": \"Active\",\n    \"terminationMode\": \"Schedule stop date\",\n    \"unit\": \"1112\"\n}"),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "status": "text"
}

Edit a resident

Edit Resident

PATCHhttps://www.cusna.io/api/1.1/obj/resident/{id}

Path parameters

id*string

Example: "1654740731860x896778368875644200"

Body

application/json

tenantServiceStatusstring

firstNamestring

lastNamestring

terminationModestring

unitstring

phonestring

externalIDstring

passphrasestring

buildingstring

emailstring

stopDatestring

Response

405

Auto generated using Swagger Inspector

Body

application/json

bodyinline_response_405_body (object)

statusCodeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://www.cusna.io/api/1.1/obj/resident/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("{\n    \"building\": \"T2\",\n    \"email\": \"[e-mail]\",\n    \"externalID\": \"1234456\",\n    \"firstName\": \"Happy\",\n    \"lastName\": \"Resident\",\n    \"passphrase\": \"mypersonalpassphrase4\",\n    \"phone\": \"4156234444\",\n    \"stopDate\": \"2023-06-09T02:12:11.858Z\",\n    \"tenantServiceStatus\": \"Active\",\n    \"terminationMode\": \"Schedule stop date\",\n    \"unit\": \"1112\"\n}"),
});
const data = await response.json();

Response

405

{
  "body": null
}

Delete a resident and de-activate automatically its service

delete resident by ID

Delete resident by ID

DELETEhttps://www.cusna.io/api/1.1/obj/resident/{id}

Path parameters

id*string

Example: "1654740731860x896778368875644200"

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://www.cusna.io/api/1.1/obj/resident/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Send activation email

Send again the activation email to a resident

Send activaitn email to resident

POSThttps://www.cusna.io/api/1.1/wf/sendactivationemail

Body

application/json

userstring

Response

200

Auto generated using Swagger Inspector

Body

application/json

responseobject

statusstring

Request

JavaScriptCurlPython

const response = await fetch('https://www.cusna.io/api/1.1/wf/sendactivationemail', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify("{\n    \"user\":\"1654058988310x459285687337671600\"\n}"),
});
const data = await response.json();

Response

200

{
  "response": {},
  "status": "text"
}