TAG LINE
SMALL TITLE

Note

(API Version v3)


What can you do with Note?


Properties

Property Details
identity
READ-ONLY
"identity": 2
Type: Number
This is the unique numeric identifier for the Note
subject
"subject": "Hello World"
Type: String
text
"text": "Hello World"
Type: String
noteTypeId
"noteTypeId": 11
Type: Number
Unique identifier for the associated NoteType object.
noteTypeName
"noteTypeName": "Sample Name"
Type: String
The name of the object associated with the noteTypeId property.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
createdByUserId
"createdByUserId": 15
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
updated
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
updatedByUserId
"updatedByUserId": 3
Type: Number
Unique identifier for the associated User object.
updatedByUserName
"updatedByUserName": "Sample Name"
Type: String
The name of the object associated with the updatedByUserId property.
showOnOverview
"showOnOverview": true
Type: Boolean
isImportant
"isImportant": true
Type: Boolean


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • identity
  • subject
  • text
  • noteTypeId
  • created
  • createdByUserId
  • updated
  • updatedByUserId
  • showOnOverview
  • isImportant

End Points

DELETEapi/v3/Note/{id}
Delete an instance of the Note object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the Note object.
Delete an instance of the Note object.
DELETE api/v3/Note/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "note"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/Note/
Retrieve all of the Note objects.
Retrieve all of the Note objects.
GET api/v3/Note/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "subject": "Sample Text Data",
            "text": "Sample Text Data",
            "noteTypeId": 19,
            "noteTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 25,
            "createdByUserName": "Sample Text Data",
            "updated": "2021-04-26T15:25:27.587Z",
            "updatedByUserId": 19,
            "updatedByUserName": "Sample Text Data",
            "showOnOverview": true,
            "isImportant": true
        }
    ]
}
GETapi/v3/Note/Paged
Retrieve all of the Note objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the Note objects in a paged fashion.
GET api/v3/Note/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "subject": "Sample Text Data",
                "text": "Sample Text Data",
                "noteTypeId": 11,
                "noteTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 21,
                "createdByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 20,
                "updatedByUserName": "Sample Text Data",
                "showOnOverview": true,
                "isImportant": true
            }
        ]
    }
}
GETapi/v3/Note/{id}
Retrieve an instance of the Note object by its ID.
{id}Unique identifier for the Note object.
Retrieve an instance of the Note object by its ID.
GET api/v3/Note/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "subject": "Sample Text Data",
        "text": "Sample Text Data",
        "noteTypeId": 10,
        "noteTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 18,
        "createdByUserName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z",
        "updatedByUserId": 13,
        "updatedByUserName": "Sample Text Data",
        "showOnOverview": true,
        "isImportant": true
    }
}
POSTapi/v3/Note/
Create a new instance of the Note object.
Create a new instance of the Note object.
POST api/v3/Note/

{
    "subject": "Sample Text Data",
    "text": "Sample Text Data",
    "noteTypeId": 13,
    "createdByUserId": 1,
    "updated": "2021-04-26T15:25:27.587Z",
    "updatedByUserId": 17,
    "showOnOverview": true,
    "isImportant": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "subject": "Sample Text Data",
                "text": "Sample Text Data",
                "noteTypeId": 2,
                "noteTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 23,
                "createdByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 4,
                "updatedByUserName": "Sample Text Data",
                "showOnOverview": true,
                "isImportant": true
            }
        ]
    }
}
PUTapi/v3/Note/{id}
Update an existing instance of the Note object.
Update an existing instance of the Note object.
PUT api/v3/Note/{id}

{
    "identity": 1,
    "subject": "Sample Text Data",
    "text": "Sample Text Data",
    "noteTypeId": 20,
    "createdByUserId": 9,
    "updated": "2021-04-26T15:25:27.587Z",
    "updatedByUserId": 23,
    "showOnOverview": true,
    "isImportant": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "subject": "Sample Text Data",
                "text": "Sample Text Data",
                "noteTypeId": 11,
                "noteTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 24,
                "createdByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 10,
                "updatedByUserName": "Sample Text Data",
                "showOnOverview": true,
                "isImportant": true
            }
        ]
    }
}