CustomDictionary

Lists all Custom Word objects.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

Responses

200

Success

application/json

Response of a List Custom Words request.

countinteger · int32Optional

Total number of Custom Word objects.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/memori/v2/CustomWords/{strSessionID}

HTTPcURLJavaScriptPython

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

200

Success

{
  "count": 1,
  "customWords": [
    {
      "customWordID": "text",
      "word": "text",
      "definition": "text",
      "creationTimestamp": "2026-03-07T11:38:13.583Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2026-03-07T11:38:13.583Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:38:13.583Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Lists Custom Word 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 Custom Word to list

howManyinteger · int32Required

The number of the Custom Word to list

Responses

200

Success

application/json

Response of a List Custom Words request.

countinteger · int32Optional

Total number of Custom Word objects.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/memori/v2/CustomWords/{strSessionID}/{from}/{howMany}

HTTPcURLJavaScriptPython

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

200

Success

{
  "count": 1,
  "customWords": [
    {
      "customWordID": "text",
      "word": "text",
      "definition": "text",
      "creationTimestamp": "2026-03-07T11:38:13.583Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2026-03-07T11:38:13.583Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:38:13.583Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of a Custom Word object.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

strCustomWordIDstringRequired

The Custom Word object ID

Responses

200

Success

application/json

Response of a Get Custom Word request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/memori/v2/CustomWord/{strSessionID}/{strCustomWordID}

HTTPcURLJavaScriptPython

GET /memori/v2/CustomWord/{strSessionID}/{strCustomWordID} HTTP/1.1
Accept: */*

200

Success

{
  "customWord": {
    "customWordID": "text",
    "word": "text",
    "definition": "text",
    "creationTimestamp": "2026-03-07T11:38:13.583Z",
    "creationSessionID": "text",
    "lastChangeTimestamp": "2026-03-07T11:38:13.583Z",
    "lastChangeSessionID": "text"
  },
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:38:13.583Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Removes an existing Custom Word object.

delete

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

strCustomWordIDstringRequired

The Custom Word object ID

Responses

200

Success

application/json

Base response.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

delete

/memori/v2/CustomWord/{strSessionID}/{strCustomWordID}

HTTPcURLJavaScriptPython

DELETE /memori/v2/CustomWord/{strSessionID}/{strCustomWordID} HTTP/1.1
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:38:13.583Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates an existing Custom Word object.

patch

This API requires a Giver session. Only the Definition field is considered for update. To change the Word field a new Custom Word must be added and the existing must be removed.

Path parameters

strSessionIDstringRequired

The session ID

strCustomWordIDstringRequired

The Custom Word object ID

Body

application/json

customWordIDstring · nullableOptional

Custom Word object ID.

wordstring · nullableOptional

Custom Word.

definitionstring · nullableOptional

Definition of the Custom Word, in terms of sums and subtractions of existing words or custom words. The syntax for a Custom Word definition is as follows: word1 [+-] word2 [+-] word3... If the operator is omitted it is assumed to be the last specified from the left, and if no operator has been specified it is assumed to be the sum. E.g.: alpha beta gamma is equivalent to alpha + beta + gamma alpha beta - gamma delta is equivalent to alpha + beta - gamma - delta

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

Base response.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

patch

/memori/v2/CustomWord/{strSessionID}/{strCustomWordID}

HTTPcURLJavaScriptPython

PATCH /memori/v2/CustomWord/{strSessionID}/{strCustomWordID} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "customWordID": "text",
  "word": "text",
  "definition": "text",
  "creationTimestamp": "2026-03-07T11:38:13.583Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2026-03-07T11:38:13.583Z",
  "lastChangeSessionID": "text"
}

200

Success

{
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:38:13.583Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Adds a new Custom Word object.

post

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

Body

application/json

customWordIDstring · nullableOptional

Custom Word object ID.

wordstring · nullableOptional

Custom Word.

definitionstring · nullableOptional

Definition of the Custom Word, in terms of sums and subtractions of existing words or custom words. The syntax for a Custom Word definition is as follows: word1 [+-] word2 [+-] word3... If the operator is omitted it is assumed to be the last specified from the left, and if no operator has been specified it is assumed to be the sum. E.g.: alpha beta gamma is equivalent to alpha + beta + gamma alpha beta - gamma delta is equivalent to alpha + beta - gamma - delta

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

Response of an Add Custom Word request.

customWordIDstring · nullableOptional

Custom Word object ID.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous response.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous response.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

post

/memori/v2/CustomWord/{strSessionID}

HTTPcURLJavaScriptPython

POST /memori/v2/CustomWord/{strSessionID} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "customWordID": "text",
  "word": "text",
  "definition": "text",
  "creationTimestamp": "2026-03-07T11:38:13.583Z",
  "creationSessionID": "text",
  "lastChangeTimestamp": "2026-03-07T11:38:13.583Z",
  "lastChangeSessionID": "text"
}

200

Success

{
  "customWordID": "text",
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:38:13.583Z",
  "resultCode": 1,
  "resultMessage": "text"
}