This endpoint uses the following HTTP methods and urls:
GET | Used for retrieving all events | https://api.equipcalendar.com/v2/events |
GET | Used for retrieving a single event | https://api.equipcalendar.com/v2/events/{id:int} |
POST | Used for creating an event | https://api.equipcalendar.com/v2/events |
PUT | Used for updating an event | https://api.equipcalendar.com/v2/events/{id:int} |
DELETE | Used for deleting an event | https://api.equipcalendar.com/v2/events/{id:int} |
All requests to this endpoint must contain an access_token (encoded using base64) in the Authorization HTTP Header. See the Authentication endpoint for more details.
GET /v2/events HTTP/1.1 Host: https://api.equipcalendar.com Connection: keep-alive User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 Chrome/43.0.2357.124 Safari/537.36 Content-Type: application/json Accept: */* Accept-Encoding: gzip, deflate Accept-Language: en-US,en;q=0.8 Authorization: bearer MmViNDg0OGEtNDk1ZS00NDQ2LWE0MjEtYjBiOTYwM2E1Mno5Omd1aWQ=
NONE
{ "data": [ { "id": 1, "eventStatusId": 1, "rentalBlockId": 654, "startDate": "2015-06-11T16:00:00.000", "endDate": "2015-06-11T18:00:00.000", "dropoffDate": "2015-06-11T14:30:00.000", "teardownDate": "2015-06-11T18:00:00.000", "pickupDate": "2015-06-11T18:30:00.000", "eventName": "MacabreFest 2015", "eventAddress1": "123 W Something", "eventAddress2": null, "eventCity": "Amityville", "eventState": "NY", "eventPostalCode": "11701", "eventContacts": "Arnie Carnold - 347-154-6592", "eventSpecialRequirements": null, "customerName": "Benny Britten", "customerAddress1": "456 W 2nd Ave", "customerAddress2": null, "customerCity": "Amityville", "customerState": "NY", "customerPostalCode": "11708", "customerContacts": "Benny Britten - 646-678-9521", "amountDeposit": 1000.00, "amountDelivery": 600.00, "amountLabor": 450.50, "amountMisc": 12.75, "amountDiscount": 0, "amountSalesTax": 0, "cancelDate": null, "cancelReason": null, "internalNotes": null, "Links": [ { "rel": "self", "method": "GET", "href": "https://api.equipcalendar.com/v2/events/1" }, { "rel": "edit", "method": "PUT", "href": "https://api.equipcalendar.com/v2/events/1" }, { "rel": "delete", "method": "DELETE", "href": "https://api.equipcalendar.com/v2/events/1" }, { "rel": "add", "method": "POST", "href": "https://api.equipcalendar.com/v2/events" }, { "rel": "web", "method": "GET", "href": "https://equipcalendar.com/event/edit/1" } ] }, { "id": 2, "eventStatusId": 2, "rentalBlockId": 10, "startDate": "2015-04-02T18:00:00", "endDate": "2015-04-02T22:00:00", "dropoffDate": "2015-04-02T08:00:00", "teardownDate": "2015-04-02T22:00:00", "pickupDate": "2015-04-02T22:30:00", "eventName": "380 Design Anniversary Party", "eventAddress1": "9852 N Cottonwood", "eventAddress2": null, "eventCity": "Berwyn", "eventState": "IL", "eventPostalCode": "60402", "eventContacts": null, "eventSpecialRequirements": null, "customerName": "380 Design, Inc", "customerAddress1": null, "customerAddress2": null, "customerCity": null, "customerState": null, "customerPostalCode": null, "customerContacts": null, "amountDeposit": 0, "amountDelivery": 0,</snipped for brevity>
Field | Description | Data Type | Comments | |
---|---|---|---|---|
id | the identifier of the object to address | integer | 2^31-1 (2,147,483,647) | Required |
NONE
{ "data": [ { "id": 1, "eventStatusId": 1, "rentalBlockId": 654, "startDate": "2015-06-11T16:00:00.000", "endDate": "2015-06-11T18:00:00.000", "dropoffDate": "2015-06-11T14:30:00.000", "teardownDate": "2015-06-11T18:00:00.000", "pickupDate": "2015-06-11T18:30:00.000", "eventName": "MacabreFest 2015", "eventAddress1": "123 W Something", "eventAddress2": null, "eventCity": "Amityville", "eventState": "NY", "eventPostalCode": "11701", "eventContacts": "Arnie Carnold - 347-154-6592", "eventSpecialRequirements": null, "customerName": "Benny Britten", "customerAddress1": "456 W 2nd Ave", "customerAddress2": null, "customerCity": "Amityville", "customerState": "NY", "customerPostalCode": "11708", "customerContacts": "Benny Britten - 646-678-9521", "amountDeposit": 1000.00, "amountDelivery": 600.00, "amountLabor": 450.50, "amountMisc": 12.75, "amountDiscount": 0, "amountSalesTax": 0, "cancelDate": null, "cancelReason": null, "internalNotes": null, "Links": [ { "rel": "self", "method": "GET", "href": "https://api.equipcalendar.com/v2/events/1" }, { "rel": "edit", "method": "PUT", "href": "https://api.equipcalendar.com/v2/events/1" }, { "rel": "delete", "method": "DELETE", "href": "https://api.equipcalendar.com/v2/events/1" }, { "rel": "add", "method": "POST", "href": "https://api.equipcalendar.com/v2/events" }, { "rel": "web", "method": "GET", "href": "https://equipcalendar.com/event/edit/1" } ] } ] }
NONE
Field | Description | Data Type | Comments | |
---|---|---|---|---|
eventStatusId | integer | Use values from Event Status Endpoint | Required | |
rentalBlockId | integer | Use values from Rental Blocks Endpoint | Required | |
startDate | Event start | datetime | YYYY-MM-DD HH:MM:SS | Required |
endDate | Event end | datetime | YYYY-MM-DD HH:MM:SS | Required |
dropoffDate | Inventory drop off | datetime | YYYY-MM-DD HH:MM:SS | Required |
teardownDate | Inventory/Event tear down | datetime | YYYY-MM-DD HH:MM:SS | Required |
pickupDate | Inventory pickup | datetime | YYYY-MM-DD HH:MM:SS | Required |
eventName | Name of event | string | Max: 100 chars | Required |
eventAddress1 | string | Max: 255 chars | ||
eventAddress2 | string | Max: 255 chars | ||
eventCity | string | Max: 255 chars | ||
eventState | string | Max: 50 chars | ||
eventPostalCode | string | Max: 50 chars | ||
eventContacts | string | Max: 4000 chars | ||
eventSpecialRequirements | string | Max: 4000 chars | ||
customerName | string | Max: 255 chars | ||
customerAddress1 | string | Max: 255 chars | ||
customerAddress2 | string | Max: 255 chars | ||
customerCity | string | Max: 255 chars | ||
customerState | string | Max: 50 chars | ||
customerPostalCode | string | Max: 50 chars | ||
customerContacts | string | Max: 4000 chars | ||
amountDeposit | decimal | Avoid commas and currency symbols | ||
amountDelivery | decimal | Avoid commas and currency symbols | ||
amountLabor | decimal | Avoid commas and currency symbols | ||
amountMisc | decimal | Avoid commas and currency symbols | ||
amountDiscount | decimal | Avoid commas and currency symbols | ||
amountSalesTax | decimal | Avoid commas and currency symbols | ||
cancelDate | Cancellation date, if any | datetime | YYYY-MM-DD HH:MM:SS | |
cancelReason | Internal notes regarding cancellation | string | Max: 4000 chars | |
internalNotes | Internal notes that do not show on any report | string | Max: 4000 chars |
{ "eventStatusId": 1, "rentalBlockId": 10, "startDate": "2015-06-10T16:00:00.000", "endDate": "2015-06-11T16:00:00.000", "dropoffDate": "2015-06-11T16:00:00.000", "teardownDate": "2015-06-11T16:00:00.000", "pickupDate": "2015-06-11T16:00:00.000", "eventName": "Clark Graduation", "eventAddress1": "789 Mulberry", "eventAddress2": null, "eventCity": "Clinton", "eventState": "TX", "eventPostalCode": "20735", "eventContacts": null, "eventSpecialRequirements": null, "customerName": "John Clark", "customerAddress1": null, "customerAddress2": null, "customerCity": null, "customerState": null, "customerPostalCode": null, "customerContacts": "301-544-5566", "amountDeposit": 0, "amountDelivery": 10, "amountLabor": 10, "amountMisc": 10, "amountDiscount": 10, "amountSalesTax": 12.85, "cancelDate": null, "cancelReason": null, "internalNotes": null }
{ "data": [ { "id": 162544, "eventStatusId": 1, "rentalBlockId": 10, "startDate": "2015-06-10T16:00:00.000", "endDate": "2015-06-11T16:00:00.000", "dropoffDate": "2015-06-11T16:00:00.000", "teardownDate": "2015-06-11T16:00:00.000", "pickupDate": "2015-06-11T16:00:00.000", "eventName": "Clark Graduation", "eventAddress1": "789 Mulberry", "eventAddress2": null, "eventCity": "Clinton", "eventState": "TX", "eventPostalCode": "20735", "eventContacts": null, "eventSpecialRequirements": null, "customerName": "John Clark", "customerAddress1": null, "customerAddress2": null, "customerCity": null, "customerState": null, "customerPostalCode": null, "customerContacts": "301-544-5566", "amountDeposit": 0, "amountDelivery": 10, "amountLabor": 10, "amountMisc": 10, "amountDiscount": 10, "amountSalesTax": 12.85, "cancelDate": null, "cancelReason": null, "internalNotes": null, "Links": [ { "rel": "self", "method": "GET", "href": "https://api.equipcalendar.com/v2/events/162544" }, { "rel": "edit", "method": "PUT", "href": "https://api.equipcalendar.com/v2/events/162544" }, { "rel": "delete", "method": "DELETE", "href": "https://api.equipcalendar.com/v2/events/162544" }, { "rel": "add", "method": "POST", "href": "https://api.equipcalendar.com/v2/events" }, { "rel": "web", "method": "GET", "href": "https://equipcalendar.com/event/edit/162544" } ] } ] }
Field | Description | Data Type | Comments | |
---|---|---|---|---|
id | the identifier of the object to address | integer | 2^31-1 (2,147,483,647) | Required |
Field | Description | Data Type | Comments | |
---|---|---|---|---|
id | Object identifier | integer | 2^31-1 (2,147,483,647) | Required |
eventStatusId | integer | Use values from Event Status Endpoint | Required | |
rentalBlockId | integer | Use values from Rental Blocks Endpoint | Required | |
startDate | Event start | datetime | YYYY-MM-DD HH:MM:SS | Required |
endDate | Event end | datetime | YYYY-MM-DD HH:MM:SS | Required |
dropoffDate | Inventory drop off | datetime | YYYY-MM-DD HH:MM:SS | Required |
teardownDate | Inventory/Event tear down | datetime | YYYY-MM-DD HH:MM:SS | Required |
pickupDate | Inventory pickup | datetime | YYYY-MM-DD HH:MM:SS | Required |
eventName | Name of event | string | Max: 100 chars | Required |
eventAddress1 | string | Max: 255 chars | ||
eventAddress2 | string | Max: 255 chars | ||
eventCity | string | Max: 255 chars | ||
eventState | string | Max: 50 chars | ||
eventPostalCode | string | Max: 50 chars | ||
eventContacts | string | Max: 4000 chars | ||
eventSpecialRequirements | string | Max: 4000 chars | ||
customerName | string | Max: 255 chars | ||
customerAddress1 | string | Max: 255 chars | ||
customerAddress2 | string | Max: 255 chars | ||
customerCity | string | Max: 255 chars | ||
customerState | string | Max: 50 chars | ||
customerPostalCode | string | Max: 50 chars | ||
customerContacts | string | Max: 4000 chars | ||
amountDeposit | decimal | Avoid commas and currency symbols | ||
amountDelivery | decimal | Avoid commas and currency symbols | ||
amountLabor | decimal | Avoid commas and currency symbols | ||
amountMisc | decimal | Avoid commas and currency symbols | ||
amountDiscount | decimal | Avoid commas and currency symbols | ||
amountSalesTax | decimal | Avoid commas and currency symbols | ||
cancelDate | Cancellation date, if any | datetime | YYYY-MM-DD HH:MM:SS | |
cancelReason | Internal notes regarding cancellation | string | Max: 4000 chars | |
internalNotes | Internal notes that do not show on any report | string | Max: 4000 chars |
{ "id": "162544", "eventStatusId": 1, "rentalBlockId": 10, "startDate": "2015-06-10T16:00:00.000", "endDate": "2015-06-11T16:00:00.000", "dropoffDate": "2015-06-11T16:00:00.000", "teardownDate": "2015-06-11T16:00:00.000", "pickupDate": "2015-06-11T16:00:00.000", "eventName": "Clark Graduation", "eventAddress1": "789 Mulberry", "eventAddress2": null, "eventCity": "Clinton", "eventState": "TX", "eventPostalCode": "20735", "eventContacts": null, "eventSpecialRequirements": null, "customerName": "John Clark", "customerAddress1": null, "customerAddress2": null, "customerCity": null, "customerState": null, "customerPostalCode": null, "customerContacts": "301-544-5566", "amountDeposit": 0, "amountDelivery": 10, "amountLabor": 10, "amountMisc": 10, "amountDiscount": 10, "amountSalesTax": 12.85, "cancelDate": null, "cancelReason": null, "internalNotes": null }
{ "data": [ { "id": 162544, "eventStatusId": 1, "rentalBlockId": 10, "startDate": "2015-06-10T16:00:00.000", "endDate": "2015-06-11T16:00:00.000", "dropoffDate": "2015-06-11T16:00:00.000", "teardownDate": "2015-06-11T16:00:00.000", "pickupDate": "2015-06-11T16:00:00.000", "eventName": "Clark Graduation", "eventAddress1": "789 Mulberry", "eventAddress2": null, "eventCity": "Clinton", "eventState": "TX", "eventPostalCode": "20735", "eventContacts": null, "eventSpecialRequirements": null, "customerName": "John Clark", "customerAddress1": null, "customerAddress2": null, "customerCity": null, "customerState": null, "customerPostalCode": null, "customerContacts": "301-544-5566", "amountDeposit": 0, "amountDelivery": 10, "amountLabor": 10, "amountMisc": 10, "amountDiscount": 10, "amountSalesTax": 12.85, "cancelDate": null, "cancelReason": null, "internalNotes": null, "Links": [ { "rel": "self", "method": "GET", "href": "https://api.equipcalendar.com/v2/events/162544" }, { "rel": "edit", "method": "PUT", "href": "https://api.equipcalendar.com/v2/events/162544" }, { "rel": "delete", "method": "DELETE", "href": "https://api.equipcalendar.com/v2/events/162544" }, { "rel": "add", "method": "POST", "href": "https://api.equipcalendar.com/v2/events" }, { "rel": "web", "method": "GET", "href": "https://equipcalendar.com/event/edit/162544" } ] } ] }
Field | Description | Data Type | Comments | |
---|---|---|---|---|
id | the identifier of the object to address | integer | 2^31-1 (2,147,483,647) | Required |
NONE
{ "id": 162 }
© 2024 EQPD, LLC