Adminserver: Social: Event API

Endpoint	Method	Description
/jsonRpc/social.createSocialEvent	jsonRpc	Create social event
/jsonRpc/social.updateSocialEvent	jsonRpc	Update social event
/jsonRpc/social.deleteSocialEvent	jsonRpc	Delete social event
/jsonRpc/social.getSocialEvent	jsonRpc	Get social event
/jsonRpc/social.getSocialEvents	jsonRpc	Get social events

Create social event

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/social.createSocialEvent

Permissions:

network.manage /networkId

Request:

{
    "event": {
        "eventId": string
        "title": string
        "description": string
        "startDate": timestamp
        "endDate": timestamp
        "previewResourceId": string  // resourceId of the preview image for the event
        "roomId": string  // default roomId for event sessions
        "participantLimit": int  // limit on number of participants, 0 means no limit
        "price": float  // price of the event, 0 means free event
        "customData": map[string]{ custom structure }  // custom data for the event, like event venue, url, etc.
    }
}

Response:

{
    "data": {
        "event": {
            "id": string
            "created": timestamp
            "updated": timestamp
            "sourceString": string
            "sourceType": string
            "sourcePk": string
            "networkId": string
            "title": string
            "description": string
            "startDate": timestamp
            "endDate": timestamp
            "previewResourceId": string  // resourceId of the preview image for the event
            "roomId": string  // default roomId for event sessions
            "participantLimit": int  // limit on number of participants, 0 means no limit
            "price": float  // price of the event, 0 means free event
            "customData": map[string]{ custom structure }  // custom data for the event, like event venue, url, etc.
            "status": int  // 0 - Draft, 1 - Published
            "formSchema": map[string]{ custom structure }
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Update social event

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/social.updateSocialEvent

Permissions:

network.manage /networkId

Request:

{
    "event": {
        "eventId": string
        "title": string
        "description": string
        "startDate": timestamp
        "endDate": timestamp
        "previewResourceId": string  // resourceId of the preview image for the event
        "roomId": string  // default roomId for event sessions
        "participantLimit": int  // limit on number of participants, 0 means no limit
        "price": float  // price of the event, 0 means free event
        "customData": map[string]{ custom structure }  // custom data for the event, like event venue, url, etc.
    }
}

Response:

{
    "data": {
        "event": {
            "id": string
            "created": timestamp
            "updated": timestamp
            "sourceString": string
            "sourceType": string
            "sourcePk": string
            "networkId": string
            "title": string
            "description": string
            "startDate": timestamp
            "endDate": timestamp
            "previewResourceId": string  // resourceId of the preview image for the event
            "roomId": string  // default roomId for event sessions
            "participantLimit": int  // limit on number of participants, 0 means no limit
            "price": float  // price of the event, 0 means free event
            "customData": map[string]{ custom structure }  // custom data for the event, like event venue, url, etc.
            "status": int  // 0 - Draft, 1 - Published
            "formSchema": map[string]{ custom structure }
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Delete social event

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/social.deleteSocialEvent

Permissions:

network.manage /networkId

Request:

{
    "eventId": string
}

Response:

{ empty }

Get social event

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/social.getSocialEvent

Request:

{
    "eventId": string
}

Response:

{
    "data": {
        "event": {
            "id": string
            "created": timestamp
            "updated": timestamp
            "sourceString": string
            "sourceType": string
            "sourcePk": string
            "networkId": string
            "title": string
            "description": string
            "startDate": timestamp
            "endDate": timestamp
            "previewResourceId": string  // resourceId of the preview image for the event
            "roomId": string  // default roomId for event sessions
            "participantLimit": int  // limit on number of participants, 0 means no limit
            "price": float  // price of the event, 0 means free event
            "customData": map[string]{ custom structure }  // custom data for the event, like event venue, url, etc.
            "status": int  // 0 - Draft, 1 - Published
            "formSchema": map[string]{ custom structure }
        }
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get social events

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/social.getSocialEvents

Request:

{ empty }

Response:

{
    "data": {
        "events": [{
            "id": string
            "created": timestamp
            "updated": timestamp
            "sourceString": string
            "sourceType": string
            "sourcePk": string
            "networkId": string
            "title": string
            "description": string
            "startDate": timestamp
            "endDate": timestamp
            "previewResourceId": string  // resourceId of the preview image for the event
            "roomId": string  // default roomId for event sessions
            "participantLimit": int  // limit on number of participants, 0 means no limit
            "price": float  // price of the event, 0 means free event
            "customData": map[string]{ custom structure }  // custom data for the event, like event venue, url, etc.
            "status": int  // 0 - Draft, 1 - Published
            "formSchema": map[string]{ custom structure }
        }]
    }
    "error": { "status": bool, "code": int, "message": string }
}