People

Lists all Person objects.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /memori/v2/People/{strSessionID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "count": 1,
  "people": [
    {
      "personID": "text",
      "personType": "text",
      "name": "text",
      "information": "text",
      "pin": "text",
      "tag": "text",
      "creationTimestamp": "2025-06-07T14:54:24.264Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T14:54:24.264Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:54:24.264Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Lists Person objects with pagination.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

frominteger · int32Required

The 0-based index of the first Person object to list

howManyinteger · int32Required

The number of the Person objects to list

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /memori/v2/People/{strSessionID}/{from}/{howMany} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "count": 1,
  "people": [
    {
      "personID": "text",
      "personType": "text",
      "name": "text",
      "information": "text",
      "pin": "text",
      "tag": "text",
      "creationTimestamp": "2025-06-07T14:54:24.264Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2025-06-07T14:54:24.264Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:54:24.264Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of a Person object.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

strPersonIDstringRequired

The Person object ID

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET /memori/v2/Person/{strSessionID}/{strPersonID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "person": {
    "personID": "text",
    "personType": "text",
    "name": "text",
    "information": "text",
    "pin": "text",
    "tag": "text",
    "creationTimestamp": "2025-06-07T14:54:24.264Z",
    "creationSessionID": "text",
    "lastChangeTimestamp": "2025-06-07T14:54:24.264Z",
    "lastChangeSessionID": "text"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:54:24.264Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Removes an existing Person object.

delete

This API requires a Giver session. Only Receiver objects can be removed.

Path parameters

strSessionIDstringRequired

The session ID

strPersonIDstringRequired

The Person object ID

Responses

200

Success

application/json

delete

HTTPcURLJavaScriptPython

DELETE /memori/v2/Person/{strSessionID}/{strPersonID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:54:24.264Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates an existing Person object.

patch

This API requires a Giver session. Only non-null (present) fields are considered for update. Null or absent fields are left unaltered.

Path parameters

strSessionIDstringRequired

The session ID

strPersonIDstringRequired

The Person object ID

Body

Specifications for an Update Person request.

personIDstring | nullableOptional

Person object ID.

personTypestring | nullableOptional

Person type, e.g. Giver or Receiver. Required during Add operations.

namestring | nullableOptional

Person name. May be Null only when the Person object is created by the Dialog State Machine and the name has not been set yet.

informationstring | nullableOptional

Person information. Currently this is a free (unprocessed) text.

pinstring | nullableOptional

Person PIN. Must be a code between 000000 and 999999. May be Null only when the Person object is created by the Dialog State Machine and the PIN has not been set yet. Required during Add operations.

tagstring | nullableOptional

Person tag. Can be any publicly visible string that the person recognizes as distinctive. Typically it is an emoji symbol, but could also be an RFID code or something else.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Always present when reading/receiving an object, ignored when writing/sending an object.

creationSessionIDstring | nullableOptional

ID of the session that created this object.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Always present when reading/receiving an object, ignored when writing/sending an object.

lastChangeSessionIDstring | nullableOptional

ID of the latest session that changed this object.

Responses

200

Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /memori/v2/Person/{strSessionID}/{strPersonID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "personID": "text",
  "personType": "text",
  "name": "text",
  "information": "text",
  "pin": "text",
  "tag": "text",
  "creationTimestamp": "2025-06-07T14:54:24.264Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2025-06-07T14:54:24.264Z",
  "lastChangeSessionID": "text"
}

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:54:24.264Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Adds a new Person object.

post

This API requires a Giver session. Only Receiver objects can be created with this API, the Giver object is always created by the Dialog State Machine.

Path parameters

strSessionIDstringRequired

The session ID

Body

Specifications for an Add Person request.

personIDstring | nullableOptional

Person object ID.

personTypestring | nullableOptional

Person type, e.g. Giver or Receiver. Required during Add operations.

namestring | nullableOptional

Person name. May be Null only when the Person object is created by the Dialog State Machine and the name has not been set yet.

informationstring | nullableOptional

Person information. Currently this is a free (unprocessed) text.

pinstring | nullableOptional

Person PIN. Must be a code between 000000 and 999999. May be Null only when the Person object is created by the Dialog State Machine and the PIN has not been set yet. Required during Add operations.

tagstring | nullableOptional

Person tag. Can be any publicly visible string that the person recognizes as distinctive. Typically it is an emoji symbol, but could also be an RFID code or something else.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Always present when reading/receiving an object, ignored when writing/sending an object.

creationSessionIDstring | nullableOptional

ID of the session that created this object.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Always present when reading/receiving an object, ignored when writing/sending an object.

lastChangeSessionIDstring | nullableOptional

ID of the latest session that changed this object.

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST /memori/v2/Person/{strSessionID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "personID": "text",
  "personType": "text",
  "name": "text",
  "information": "text",
  "pin": "text",
  "tag": "text",
  "creationTimestamp": "2025-06-07T14:54:24.264Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2025-06-07T14:54:24.264Z",
  "lastChangeSessionID": "text"
}

200

Success

{
  "personID": "text",
  "requestID": 1,
  "requestDateTime": "2025-06-07T14:54:24.264Z",
  "resultCode": 1,
  "resultMessage": "text"
}