Event
The HiveSocial event provides ability to your groups users not only to be informed about an upcoming event, but also confirm or deny their presence. It is very effective tool for time management, as it is presented in an exportable calendar to all users, and provides also an ability to match the participating events between users.
Method: get
Authorization is required.
Request
HTTP request
GET https://<YOUR_DOMAIN>/api/v1/en_US/event/{eventId}
Parameters
| property | value | description |
|---|---|---|
| eventId | integer | The events's ID |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"success": true,
"message": "Adipisicing commodo consectetur ad mollit minim nisi excepteur officia amet ut ex elit elit ut.",
"timestamp": "2014-03-03T23:20:23Z",
"errors": [],
"object": {
"id": 1,
"type": "event",
"group": {
"id": "50b88e09-141a-4a2e-811c-d7e086910951",
"name": "ad",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "b77fa1be-e5d9-47d7-bfae-cd57aa1ec4f3",
"alias": "amet do",
"extendedAlias": "sunt dolore id commodo dolor",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"editor": {
"id": "faa12466-80b0-4ba2-82c7-f3977bfca5a1",
"alias": "ad nulla",
"extendedAlias": "minim tempor Lorem enim sint",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"allDay": true,
"startDate": "2014-03-03T20:20:23Z",
"endDate": "2014-03-03T22:20:23Z",
"organizer": "esse excepteur",
"location": "ad anim",
"title": "Sint reprehenderit excepteur et officia ullamco minim.",
"content": "Nostrud mollit sit cillum irure dolore id. Id ex voluptate magna tempor.",
"url": "http://demo.hivesocialnow.com/event/permalink",
"accessWarnings": [
{
"key": "title",
"code": "ACCESS_DENIED",
"message": "You do not have permission to read the event content"
}
]
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| id | integer | the id of the record |
| group | object | some common properties of the group in which the record was created: id, name, slug, thumbUrl, url (of the group home page) |
| createdOn | date | When the event was created in ISO 8601 date string and UTC time zone |
| author | object | some common properties of the user that created the record: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| editor | object | some common properties of the user that modified the record last: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| allDay | boolean | whether this is an all day event |
| startDate | date | When the event will start in ISO 8601 date string and UTC time zone |
| endDate | date | When the event will end in ISO 8601 date string and UTC time zone. Can be null if this is an all day event |
| organizer | string | Information about the event's organizer |
| location | string | Where the event will take place |
| title | string | Event's title |
| content | string | Event's content |
| url | string | Event's permalink |
Method: upcoming list
Authorization is required. This method returns all events that has start dates greater than the provided timeStamp.
Request
HTTP request
GET https://<YOUR_DOMAIN>/api/v1/en_US/event/list/upcoming/{groupId}?timeStamp={timeStamp}&offset={offset}&pageSize={pageSize}&filter={filter}
Parameters
| property | value | description |
|---|---|---|
| groupId | guid | The events' group ID |
| timeStamp | date | A date in ISO 8601 string format and UTC time zone. The method will return events that are with starting dates greater than the timeStamp. |
| offset | integer | Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response. |
| pageSize | integer | How many records to be returned by the system. Usually 15 |
| filter | string | Query string to be looked for when filtering the records |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"success": true,
"message": "Aliquip quis voluptate veniam sint ut aute nostrud incididunt quis officia sunt.",
"timestamp": "2014-03-03T23:20:23Z",
"errors": [],
"object": {
"offset": 1,
"events": [
{
"id": 11,
"type": "event",
"group": {
"id": "5ecda199-615f-4597-8dff-89765cac9a42",
"name": "commodo",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "5faf25f3-e3ab-41d3-954f-8c8bf4df84aa",
"alias": "deserunt Lorem",
"extendedAlias": "fugiat cillum Lorem voluptate consequat",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"editor": {
"id": "60310928-48da-462c-b7d9-85218d8fe757",
"alias": "commodo magna",
"extendedAlias": "aute consequat aliquip occaecat ex",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"allDay": true,
"startDate": "2014-03-03T20:20:23Z",
"endDate": "2014-03-03T22:20:23Z",
"organizer": "laborum pariatur",
"location": "sunt sunt",
"title": "Excepteur est mollit irure ullamco.",
"content": "Sunt anim eu minim sint. Veniam incididunt aute commodo quis.",
"url": "http://demo.hivesocialnow.com/event/permalink",
"accessWarnings": [
{
"key": "title",
"code": "ACCESS_DENIED",
"message": "You do not have permission to read the event content"
}
]
}
]
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| id | integer | the id of the record |
| group | object | some common properties of the group in which the record was created: id, name, slug, thumbUrl, url (of the group home page) |
| createdOn | date | When the event was created in ISO 8601 date string and UTC time zone |
| author | object | some common properties of the user that created the record: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| editor | object | some common properties of the user that modified the record last: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| allDay | boolean | whether this is an all day event |
| startDate | date | When the event will start in ISO 8601 date string and UTC time zone |
| endDate | date | When the event will end in ISO 8601 date string and UTC time zone. Can be null if this is an all day event |
| organizer | string | Information about the event's organizer |
| location | string | Where the event will take place |
| title | string | Event's title |
| content | string | Event's content |
| url | string | Event's permalink |
Method: expired list
Authorization is required. This method returns all events that has start dates smaller than the provided timeStamp.
Request
HTTP request
GET https://<YOUR_DOMAIN>/api/v1/en_US/event/list/expired/{groupId}?timeStamp={timeStamp}&offset={offset}&pageSize={pageSize}&filter={filter}
Parameters
| property | value | description |
|---|---|---|
| groupId | guid | The events' group ID |
| timeStamp | date | A date in ISO 8601 string format and UTC time zone. The method will return events that are with starting dates smaller than the timeStamp. |
| offset | integer | Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response. |
| pageSize | integer | How many records to be returned by the system. Usually 15 |
| filter | string | Query string to be looked for when filtering the records |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"success": true,
"message": "Aliquip quis voluptate veniam sint ut aute nostrud incididunt quis officia sunt.",
"timestamp": "2014-03-03T23:20:23Z",
"errors": [],
"object": {
"offset": 1,
"events": [
{
"id": 11,
"type": "event",
"group": {
"id": "5ecda199-615f-4597-8dff-89765cac9a42",
"name": "commodo",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "5faf25f3-e3ab-41d3-954f-8c8bf4df84aa",
"alias": "deserunt Lorem",
"extendedAlias": "fugiat cillum Lorem voluptate consequat",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"editor": {
"id": "60310928-48da-462c-b7d9-85218d8fe757",
"alias": "commodo magna",
"extendedAlias": "aute consequat aliquip occaecat ex",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"allDay": true,
"startDate": "2014-03-03T20:20:23Z",
"endDate": "2014-03-03T22:20:23Z",
"organizer": "laborum pariatur",
"location": "sunt sunt",
"title": "Excepteur est mollit irure ullamco.",
"content": "Sunt anim eu minim sint. Veniam incididunt aute commodo quis.",
"url": "http://demo.hivesocialnow.com/event/permalink",
"accessWarnings": [
{
"key": "title",
"code": "ACCESS_DENIED",
"message": "You do not have permission to read the event content"
}
]
}
]
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| id | integer | the id of the record |
| group | object | some common properties of the group in which the record was created: id, name, slug, thumbUrl, url (of the group home page) |
| createdOn | date | When the event was created in ISO 8601 date string and UTC time zone |
| author | object | some common properties of the user that created the record: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| editor | object | some common properties of the user that modified the record last: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| allDay | boolean | whether this is an all day event |
| startDate | date | When the event will start in ISO 8601 date string and UTC time zone |
| endDate | date | When the event will end in ISO 8601 date string and UTC time zone. Can be null if this is an all day event |
| organizer | string | Information about the event's organizer |
| location | string | Where the event will take place |
| title | string | Event's title |
| content | string | Event's content |
| url | string | Event's permalink |
Method: calendar list
Authorization is required. This method will return list of events for a period of time. It is suitable for use with calendar plugins, such as the FullCalendar JQuery plugin.
Request
HTTP request
GET https://<YOUR_DOMAIN>/api/v1/en_US/event/list/calendar/{groupId}?calendarStartDate={calendarStartDate}&calendarEndDate={calendarEndDate}
Parameters
| property | value | description |
|---|---|---|
| groupId | guid | The bookmarks group's ID |
| calendarStartDate | date | The initial date of the period you want the event list for. It should be in ISO 8601 string format and UTC time zone |
| calendarEndDate | date | The final date of the period you want the event list for. It should be in ISO 8601 string format and UTC time zone |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": true,
"message": "Proident non ea amet duis ex et eiusmod consequat veniam ex aute consequat.",
"errors": [],
"object": {
"offset": 0,
"events": [
{
"id": 11,
"type": "event",
"group": {
"id": "6a7d0945-bb7c-48c9-a111-4df4c52b083f",
"name": "commodo",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "b7c0514a-41d5-4b7a-9a70-8f0de7212da6",
"alias": "est eu",
"extendedAlias": "tempor proident sit non non",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"editor": {
"id": "d1c63b32-20c3-47e8-8976-dadf5e8fb4a8",
"alias": "nisi exercitation",
"extendedAlias": "occaecat consectetur ullamco sint elit",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"allDay": false,
"startDate": "2014-03-03T20:20:23Z",
"endDate": "2014-03-03T22:20:23Z",
"organizer": "est amet",
"location": "dolor laboris",
"title": "Lorem velit pariatur sunt qui laboris adipisicing incididunt consectetur eu commodo culpa minim.",
"content": "Lorem elit sint do elit duis dolor elit cillum esse aliqua do mollit irure mollit. ",
"url": "/event/permalink",
"accessWarnings": []
}
]
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| id | integer | the id of the record |
| group | object | some common properties of the group in which the record was created: id, name, slug, thumbUrl, url (of the group home page) |
| createdOn | date | When the event was created in ISO 8601 date string and UTC time zone |
| author | object | some common properties of the user that created the record: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| editor | object | some common properties of the user that modified the record last: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| allDay | boolean | whether this is an all day event |
| startDate | date | When the event will start in ISO 8601 date string and UTC time zone |
| endDate | date | When the event will end in ISO 8601 date string and UTC time zone. Can be null if this is an all day event |
| organizer | string | Information about the event's organizer |
| location | string | Where the event will take place |
| title | string | Event's title |
| content | string | Event's content |
| url | string | Event's permalink |
Method: create
Authorization is required.
Request
HTTP request
POST https://<YOUR_DOMAIN>/api/v1/en_US/event
Parameters
Do not supply a request parameters with this method.
Request body
| property | value | description |
|---|---|---|
| groupId | guid | In which group to create the record |
| startDate | date | What is the event start date in ISO 8601 string and UTC time zone |
| endDate | date | What is the event end date in ISO 8601 string and UTC time zone |
| allDay | boolean | Whether this is an all day event. |
| title | string | The event's title |
| content | string | The event's contents HTML |
| organizer | string | Short info about the organizer |
| location | string | Short info about the location |
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": true,
"message": "The event was successfully created!",
"errors": [],
"object": {
"id": 11,
"type": "event",
"group": {
"id": "6a7d0945-bb7c-48c9-a111-4df4c52b083f",
"name": "commodo",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "b7c0514a-41d5-4b7a-9a70-8f0de7212da6",
"alias": "est eu",
"extendedAlias": "tempor proident sit non non",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"editor": {
"id": "d1c63b32-20c3-47e8-8976-dadf5e8fb4a8",
"alias": "nisi exercitation",
"extendedAlias": "occaecat consectetur ullamco sint elit",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"allDay": true,
"startDate": "2014-03-03T20:20:23Z",
"endDate": "2014-03-03T22:20:23Z",
"organizer": "est amet",
"location": "dolor laboris",
"title": "Lorem velit pariatur sunt qui laboris adipisicing incididunt consectetur eu commodo culpa minim.",
"content": "Lorem elit sint do elit duis dolor elit cillum esse aliqua do mollit irure mollit.",
"url": "/event/permalink",
"accessWarnings": []
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| id | integer | the id of the record |
| group | object | some common properties of the group in which the record was created: id, name, slug, thumbUrl, url (of the group home page) |
| createdOn | date | When the event was created in ISO 8601 date string and UTC time zone |
| author | object | some common properties of the user that created the record: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| editor | object | some common properties of the user that modified the record last: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page) |
| allDay | boolean | whether this is an all day event |
| startDate | date | When the event will start in ISO 8601 date string and UTC time zone |
| endDate | date | When the event will end in ISO 8601 date string and UTC time zone. Can be null if this is an all day event |
| organizer | string | Information about the event's organizer |
| location | string | Where the event will take place |
| title | string | Event's title |
| content | string | Event's content |
| url | string | Event's permalink |
Method: update
Authorization is required.
Request
HTTP request
PUT https://<YOUR_DOMAIN>/api/v1/en_US/event/{eventId}
Parameters
| property | value | description |
|---|---|---|
| eventId | integer | In id of the updated record |
Request body
| property | value | description |
|---|---|---|
| groupId | guid | In which group to create the record |
| startDate | date | What is the event start date in ISO 8601 string and UTC time zone |
| endDate | date | What is the event end date in ISO 8601 string and UTC time zone |
| allDay | boolean | Whether this is an all day event. |
| title | string | The event's title |
| content | string | The event's contents HTML |
| organizer | string | Short info about the organizer |
| location | string | Short info about the location |
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": true,
"message": "The event was successfully created!",
"errors": [],
"object": {
"id": 11,
"type": "event",
"group": {
"id": "6a7d0945-bb7c-48c9-a111-4df4c52b083f",
"name": "commodo",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "b7c0514a-41d5-4b7a-9a70-8f0de7212da6",
"alias": "est eu",
"extendedAlias": "tempor proident sit non non",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"editor": {
"id": "d1c63b32-20c3-47e8-8976-dadf5e8fb4a8",
"alias": "nisi exercitation",
"extendedAlias": "occaecat consectetur ullamco sint elit",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"allDay": true,
"startDate": "2014-03-03T20:20:23Z",
"endDate": "2014-03-03T22:20:23Z",
"organizer": "est amet",
"location": "dolor laboris",
"title": "Lorem velit pariatur sunt qui laboris adipisicing incididunt consectetur eu commodo culpa minim.",
"content": "Lorem elit sint do elit duis dolor elit cillum esse aliqua do mollit irure mollit.",
"url": "/event/permalink",
"accessWarnings": []
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | List of validation errors, if any. The "key" property value is matched to one of the record's fields |
| object | object | The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one. |
Method: calendar update
Authorization is required. This method is suitable for use with calendar plugins, such as the FullCalendar JQuery plugin.
Request
HTTP request
PUT https://<YOUR_DOMAIN>/api/v1/en_US/event/{eventId}/calendar
Parameters
| property | value | description |
|---|---|---|
| startDate | date | What is the event start date in ISO 8601 string and UTC time zone |
| endDate | date | What is the event end date in ISO 8601 string and UTC time zone |
| allDay | boolean | Whether this is an all day event. |
| calendarStartDate | date | The start of the period for which to return the updated data in ISO 8601 format and UTC time zone |
| calendarEndDate | date | The end of the period for which to return the updated data in ISO 8601 format and UTC time zone |
Response
If successful, this method returns a response JSON with a structure similar to the calendar list method:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": true,
"message": "Proident non ea amet duis ex et eiusmod consequat veniam ex aute consequat.",
"errors": [],
"object": {
"offset": 0,
"events": [
{
"id": 11,
"type": "event",
"group": {
"id": "6a7d0945-bb7c-48c9-a111-4df4c52b083f",
"name": "commodo",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "b7c0514a-41d5-4b7a-9a70-8f0de7212da6",
"alias": "est eu",
"extendedAlias": "tempor proident sit non non",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"editor": {
"id": "d1c63b32-20c3-47e8-8976-dadf5e8fb4a8",
"alias": "nisi exercitation",
"extendedAlias": "occaecat consectetur ullamco sint elit",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"allDay": false,
"startDate": "2014-03-03T20:20:23Z",
"endDate": "2014-03-03T22:20:23Z",
"organizer": "est amet",
"location": "dolor laboris",
"title": "Lorem velit pariatur sunt qui laboris adipisicing incididunt consectetur eu commodo culpa minim.",
"content": "Lorem elit sint do elit duis dolor elit cillum esse aliqua do mollit irure mollit. ",
"url": "/event/permalink",
"accessWarnings": []
}
]
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
About the specific properties of the event content item look in the previous sections.
Method: delete
Authorization is required.
Request
HTTP request
DELETE https://<YOUR_DOMAIN>/api/v1/en_US/event/{eventId}
Parameters
| property | value | description |
|---|---|---|
| eventId | integer | In id of the deleted record |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response JSON with the following structure:
{
"timestamp": "2014-03-03T23:20:23Z",
"success": true,
"message": "The event was deleted",
"errors": {},
"object": {
"id": 11,
"type": "event",
"group": {
"id": "6a7d0945-bb7c-48c9-a111-4df4c52b083f",
"name": "commodo",
"slug": "Home",
"thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
"url": "http://demo.hivesocialnow.com/Home/"
},
"createdOn": "2014-03-03T23:20:23Z",
"author": {
"id": "b7c0514a-41d5-4b7a-9a70-8f0de7212da6",
"alias": "est eu",
"extendedAlias": "tempor proident sit non non",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"editor": {
"id": "d1c63b32-20c3-47e8-8976-dadf5e8fb4a8",
"alias": "nisi exercitation",
"extendedAlias": "occaecat consectetur ullamco sint elit",
"slug": "Home",
"avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
"url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
},
"allDay": true,
"startDate": "2014-03-03T20:20:23Z",
"endDate": "2014-03-03T22:20:23Z",
"organizer": "est amet",
"location": "dolor laboris",
"title": "Lorem velit pariatur sunt qui laboris adipisicing incididunt consectetur eu commodo culpa minim.",
"content": "Lorem elit sint do elit duis dolor elit cillum esse aliqua do mollit irure mollit.",
"url": "/event/permalink",
"accessWarnings": []
}
}
The general response properties are described on the Response format page. Here are the list of the specific properties for this method.
| property | value | description |
|---|---|---|
| success | Boolean | Whether the requested operation is successful or not |
| message | String | Human readable error information |
| errors | List (object) | This list very rarely contains records during delete method processing |
| object | object | The object that was deleted |