API
⌘K
My Developer Account

Zoom

Describes a zoom level for an attachment

Example Request

curl https://api.planningcenteronline.com/services/v2/media/{media_id}/attachments/{attachment_id}/zooms

View in API Explorer →

Example Object

{
  "type": "Zoom",
  "id": "1",
  "attributes": {
    "aspect_ratio": 1.42,
    "x_offset": 1.42,
    "y_offset": 1.42,
    "zoom_level": 1.42
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "attachable": {
      "data": {
        "type": "Attachment",
        "id": "1"
      }
    },
    "attachment": {
      "data": {
        "type": "Attachment",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
aspect_ratio float The aspect ratio of the device this zoom is for. It is rounded to the nearest 3 decimal places.
id primary_key
x_offset float The percentage of the document's width the zoomed document should be offset by horizontally.
y_offset float The percentage of the document's height the zoomed document should be offset by vertically.
zoom_level float The percentage of the zoom. Must be a value between 1.0 and 5.0

Relationships

Name Type Association Type Note
person Person to_one
attachable Attachment to_one
attachment Attachment to_one

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/media/{media_id}/attachments/{attachment_id}/zooms

Reading

HTTP Method Endpoint
GET /services/v2/media/{media_id}/attachments/{attachment_id}/zooms/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /services/v2/media/{media_id}/attachments/{attachment_id}/zooms
  • zoom_level
  • x_offset
  • y_offset
  • aspect_ratio

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /services/v2/media/{media_id}/attachments/{attachment_id}/zooms/{id}
  • zoom_level
  • x_offset
  • y_offset

Deleting

HTTP Method Endpoint
DELETE /services/v2/media/{media_id}/attachments/{attachment_id}/zooms/{id}

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/media/{media_id}/attachments/{attachment_id}/zooms Attachment