ItemNote

A plan item note that belongs to a category.

Note: You can only assign the category on create. If you want to change category; delete the current note, and create a new one passing in the item_note_category_id then.

Example Request

curl https://api.planningcenteronline.com/services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/item_notes

View in API Explorer →

Example Object

{
  "type": "ItemNote",
  "id": "1",
  "attributes": {
    "category_name": "string",
    "content": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "item_note_category": {
      "data": {
        "type": "ItemNoteCategory",
        "id": "1"
      }
    },
    "item": {
      "data": {
        "type": "Item",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`category_name`	`string`
`content`	`string`
`created_at`	`date_time`
`id`	`primary_key`
`updated_at`	`date_time`

Relationships

Name Type Association Type Note

item_note_category

ItemNoteCategory

to_one

Name	Type	Association Type	Note
item_note_category	ItemNoteCategory	to_one	An `ItemNoteCategory` must be assigned when creating an `ItemNote`. This can be done by assigning an `item_note_category_id`: `{ "data": { "type": "ItemNote", "attributes": { "content": "ok", "item_note_category_id": 1 } } }` or including the relationship in the `POST` body: `{ "data": { "type": "ItemNote", "attributes": { "content": "ok", }, "relationships": { "item_note_category": { "data": { "type": "ItemNoteCategory", "id": 1 } } } } }`
item	Item	to_one

An ItemNoteCategory must be assigned when creating an ItemNote.

This can be done by assigning an item_note_category_id:

{
  "data": {
    "type": "ItemNote",
    "attributes": {
      "content": "ok",
      "item_note_category_id": 1
    }
  }
}

or including the relationship in the POST body:

{
  "data": {
    "type": "ItemNote",
    "attributes": {
      "content": "ok",
    },
    "relationships": {
      "item_note_category": {
        "data": {
          "type": "ItemNoteCategory",
          "id": 1
        }
      }
    }
  }
}

item Item to_one

Can Include

Parameter	Value	Description	Assignable
include	item_note_category	include associated itemnotecategory	create and update

Pagination

Name	Parameter	Type	Description
per_page	per_page	integer	how many records to return per page (min=1, max=100, default=25)
offset	offset	integer	get results from given offset

Endpoints

Listing

HTTP Method	Endpoint
GET	`/services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/item_notes`

Reading

HTTP Method	Endpoint
GET	`/services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/item_notes/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/item_notes`	content

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/item_notes/{id}`	content

Deleting

HTTP Method	Endpoint
DELETE	`/services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/item_notes/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/item_notes/{item_note_id}/item_note_category`	ItemNoteCategory

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/item_notes`	Item