getEventMetadata

Returns an Event Agenda's "metadata" given a valid Event UUID. NOTE: for wall-based events (and by exception) you can pass an API Key in the header. This API Key is speficific to each Company/Event.

Request

GET /rest/user/mi/events/{eventUUID}/metadata

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser
x-nextinteract-company-api-key	Yes	Admin-specific API key UUID provided to company

Parameters

PATH PARAMS:

Parameter	Type	Required	Description
eventUUID	-	Yes	Valid Event UUID (not Event QR Code UUID! Be careful). NOTE: these are globally unique and case insensitive. Added 15 June 2018 (TP#11968).

FIELDS:

Parameter	Type	Required	Description
type	String	-	Representing the type of data. Either S=Session, G=Group, or T=Track/Stream.

NOTE: the below fields can be configured in the backend so that the UI can present titles, agenda name, and stream name as they wish (rather than hard-coding in the asset) e.g. myAgenda vs myProgram, Stream vs Team vs Track eAgendaTitle: "Agenda Title", eAgendaType: "Program", eStreamType: "Stream",

Response

200 OK

Returns Agenda metadata so clients can check for any version changes and also overall structure/complexity of agenda/program and can adjust UI accordingly.

{
  "eId": 123,
  "eUUID": "c638b6b2-4c56-48fe-8efb-1e24e683ae82",
  "eImage": "1/events/images/event-logo.png",
  "eTimezoneId": "Australia/Sydney",
  "eGmtOffsetMinutes": 660,
  "eAgendaVersion": 1,
  "eName": "My Test Event",
  "eUtcStartDate": 1566467813831,
  "eUtcEndDate": 1566640613835,
  "eLocalStartDate": 1566680213835,
  "eLocalEndDate": 1566507413831,
  "eAgendaTitle": "Event Program Guide 2019",
  "eAgendaType": "Program",
  "eStreamType": "Stream",
  "eaPrimaryColour": "FF5733",
  "eaPrimaryFontColour": "33FFE9",
  "eaSecondaryFontColour": "3346FF",
  "eGroups": [
    {
      "type": "G",
      "groupId": 1,
      "groupName": "Concurrent Session 1",
      "groupDesc": "Description of: Concurrent Session 1"
    },
    {
      "type": "G",
      "groupId": 1,
      "groupName": "Concurrent Session 2",
      "groupDesc": "Description of: Concurrent Session 2"
    }
  ],
  "eStreams": [
    {
      "type": "T",
      "streamId": 1,
      "streamName": "Developer",
      "streamDesc": "Description of: Developer",
      "streamColour": "#FF0000",
      "streamOrder": 1,
      "sessions": []
    },
    {
      "type": "T",
      "streamId": 2,
      "streamName": "Manager",
      "streamDesc": "Description of: Manager",
      "streamColour": "#00FF00",
      "streamOrder": 2,
      "sessions": []
    }
  ],
  "eLocations": [
    {
      "locationId": 7,
      "locationName": "Foyer",
      "locationDesc": "Description for: Foyer",
      "locationImage": "foyer.jpg"
    },
    {
      "locationId": 8,
      "locationName": "Room A",
      "locationDesc": "Description for: Room A",
      "locationImage": "a.jpg"
    },
    {
      "locationId": 9,
      "locationName": "Room B",
      "locationDesc": "Description for: Room B"
    }
  ],
  "ePersons": [
    {
      "personId": 4,
      "personTitle": "Mr",
      "personName": "Aaron McMullen",
      "personDesc": "Aaron is CTO of Interact Technology",
      "personQualification": "Bsc",
      "personOrganisation": "Interact Technology",
      "personImage": "aaron.jpg",
      "personHiddenInSpeakerBio": false
    },
    {
      "personId": 5,
      "personTitle": "Mr",
      "personName": "Bill Gates",
      "personDesc": "Bill Gates is founder of Microsoft",
      "personQualification": "Prof",
      "personOrganisation": "Gates Foundation",
      "personImage": "bill.gates.jpg",
      "personHiddenInSpeakerBio": false
    },
    {
      "personId": 6,
      "personTitle": "Mrs",
      "personName": "Marissa Mayer",
      "personDesc": "Last CEO of Yahoo before acquired by Verizon",
      "personQualification": "Bsc",
      "personOrganisation": "Yahoo",
      "personHiddenInSpeakerBio": false
    }
  ],
  "eUrls": [
    {
      "urlName": "AWS",
      "internalUrlName": "INTERNAL NAME",
      "url": "https://aws.amazon.com"
    },
    {
      "urlName": "Yahoo",
      "internalUrlName": "INTERNAL NAME",
      "url": "https://yahoo.com",
      "urlOrder": 1
    }
  ]
}

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSEventNotFoundException	See Error Definitions
WSEventServiceException	See Error Definitions
WSInsufficientPrivilegesException	See Error Definitions
WSAuthorisationServiceException	See Error Definitions
WSRecordNotFoundException	See Error Definitions
WSCompanyApiKeyNotActiveException	See Error Definitions
WSIncorrectApiKeyTypeException	See Error Definitions
WSEventCancelledException	See Error Definitions
WSInvalidSystemConfigurationException	See Error Definitions