Public documentation of Freeman's \"Fuzion\" v2 REST API.
\nThe Fuzion v2 API uses the OAuth 2.0 standard based on RFC 6749 for authentication. Refer to the Accesstokens folder documentation for additional details.
\nUnder a few entities, such as registrations and registrationorders, sessions, subsessions, speakers, posters, it is possible to write multiple related childrenentities with a single JSON POST and PATCH request.
?filter[field][operator]=value
General filter functionality for all the List endpoints of the Fuzion V2 API.
\n?include=entity1,entity2
The READ endpoints of the Fuzion V2 API support including related entities by providing them as a comma-separated list string.
\nBelow is a sample of a validation error where a required field is not provided when creating an entity.
\n{\n \"name\": \"ValidationError\",\n \"message\": \"\\\"shortName\\\" is required\",\n \"requestMethod\": \"POST\",\n \"requestProperty\": \"body\",\n \"statusCode\": 422\n}\n\nBelow is a sample of a validation error where the associated parent id field does not exist when creating a child entity.
\n{\n \"name\": \"ValidationError\",\n \"message\": \"sessionId (d763347b-056d-472a-a1a6-520b6f57d06f) does not exist.\",\n \"requestMethod\": \"POST\",\n \"statusCode\": 422\n}\n\nBelow is a sample of a validation error when the unique field value already exists.
\n{\n \"name\": \"ValidationError\",\n \"message\": \"(fullName)=(Freeman Digital Solutions) already exists.\",\n \"requestMethod\": \"POST\",\n \"statusCode\": 422,\n \"type\": \"unique violation\"\n}\n\nBelow is a sample of a validation error when an unrelated or misspelled entity is included in the read endpoints.
\n{\n \"name\": \"ValidationError\",\n \"message\": \"Invalid entity provided in the include.\",\n \"requestMethod\": \"GET\",\n \"requestProperty\": \"query\",\n \"statusCode\": 422\n}\n\nThe OAuth2 endpoint that provides access tokens.
\nAccess tokens should be cached and re-used until they expire. The exact expiration period is subject to change. There are four fields in the response that can be used to determine the actual expiration of the access.
\nThe Fuzion API uses the OAuth 2.0 standard for authentication. To begin making requests to Fuzion, you must first obtain a client ID and client secret. This must be generated for you by a Fuzion administrator. The client secret is confidential and MUST transmitted and stored securely within client systems.
\n","_postman_id":"8b24293d-1b43-4606-8185-1f7173840dfa","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Retrieve a collection of Event records.
\nRetrieve the single Event record of the supplied Event ID.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Example: 0b02e978-fcb5-44f7-8f47-50c4ad7dddf8
\n","type":"text/plain"},"type":"any","value":"Events are defined as the experiences that Freeman is involved in producing. Events are any experience that gathers together and connects people in meaningful ways: tradeshows, conferences, annual summits, virtual experiences, corporate retreats, trainings, company meetings, expositions.
\nRetrieve a collection of socialmediatypes.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Retrieve a single socialmediatype record.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Socialmediatype ID.
\n","type":"text/plain"},"type":"any","value":"45ad0d90-9b94-4f6f-a894-3199e252d5d1","key":"socialmediatypeId"}]}},"response":[{"id":"b6d83b50-ef11-46b5-9ee1-6e728a5e22dd","name":"Read a socialmediatype","originalRequest":{"method":"GET","header":[],"url":"{{protocol}}://{{domain}}{{port}}/socialmediatypes/v2/45ad0d90-9b94-4f6f-a894-3199e252d5d1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"45ad0d90-9b94-4f6f-a894-3199e252d5d1\",\n \"name\": \"LinkedIn\",\n \"domain\": \"linkedin.com\",\n \"createdAt\": \"2022-06-30T14:21:26.752Z\",\n \"updatedAt\": \"2022-06-30T14:21:26.752Z\",\n \"deletedAt\": null\n}"}],"_postman_id":"b947672e-e84a-4b2a-90bd-1a65ceb00bf0"},{"name":"Socialmediatype based on Speakers","id":"451f8093-5596-4e53-8010-c33600308fa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocol}}://{{domain}}{{port}}/socialmediatypes/v2?filter[speakerId][eq]=488a8bf3-15a5-417c-b1b5-26e47ff52dea","description":"For M:M connected entities, we can use filter queries on both the connected entities.
\nUsing either entity's GET endpoint and applying the IDs of the other entity as a filter.
\nFor this scenario, we are using the socialmediatype GET endpoint and applying the filter based on the speakerId to view all the social media handles tied to a speaker
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Collection of CRUD operations and options to interact with Socialmediatypes.
\nResponse Body
Retrieve a collection of Webhooksubscriptions.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Create a new subscription record
\nRequest Body
Retrieve a single Webhooksubscriptions record.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Update an existing Webhooksubscription record
\nRequest Body
Delete a webhook record.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Collection of CRUD operations and options to interact with Webhook Subscriptions
\nResponse Body
Retrieve a collection of Registration records.
\nCreate a new Registration record.
\nRetrieve the single Registration record of the supplied Registration ID.
\nExample: 27952f34-135b-4f95-9045-51071166c4fc
\n","type":"text/plain"},"type":"any","value":"Modify one or more fields on the single Registration record of the supplied Registration ID.
\nExample: 37960bce-8777-45a8-9e5e-c2799015a70a
\n","type":"text/plain"},"type":"any","value":"Permanently delete the Registration record of the supplied Registration ID.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Example: 37960bce-8777-45a8-9e5e-c2799015a70a
\n","type":"text/plain"},"type":"any","value":"Registrations are the record of people that are registered for an event. Registrations can include attendees, exhibitors, vendors, speakers, anyone who is attending the event. Registration includes the registrant details, addresses, options, orders, transactions, etc.
\nRetrieve a collection of Registrationtype records.
\nCreate a new Registrationtype record.
\nRetrieve the single Registrationtype record of the supplied Registrationtype ID.
\nExample: b0394583-f9ae-46d1-964d-fed134da7cfd
\n","type":"text/plain"},"type":"any","value":"Modify one or more fields on the single Registrationtype record of the supplied Registrationtype ID.
\nExample: 2faaf34d-69c0-4137-9405-876524cd3e03
\n","type":"text/plain"},"type":"any","value":"Permanently delete the Registrationtype record of the supplied Registrationtype ID.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Example: b0394583-f9ae-46d1-964d-fed134da7cfd
\n","type":"text/plain"},"type":"any","value":"Registrationtypes represent the various types of registrants for an Event, who they are and what they can access at an Event. Typically Registrationtypes are defined as Attendees, Full Conference, Exhibit Hall Only, Exhibitor Full Conference, Speakers, Staff, etc.
\nRetrieve a collection of Membershiptype records.
\nCreate a new Membershiptype record.
\neventId and name must be unique.Retrieve the single Membershiptype record of the supplied Membershiptype ID.
\nExample: fdc54ea1-9e30-44d4-b4e6-ba41cc51a323
\n","type":"text/plain"},"type":"any","value":"Modify one or more fields on the single Membershiptype record of the supplied Membershiptype ID.
\neventId and name must be unique.Example: fdc54ea1-9e30-44d4-b4e6-ba41cc51a323
\n","type":"text/plain"},"type":"any","value":"Permanently delete the Membershiptype record of the supplied Membershiptype ID.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Example: fdc54ea1-9e30-44d4-b4e6-ba41cc51a323
\n","type":"text/plain"},"type":"any","value":"Membershiptypes are used by organizations that have memberships. These Membershiptypes can be used to determine what access or what pricing a Registration receives at the event.
\nRetrieve a collection of Admission records.
\nCreate a new Admission record.
\nRetrieve the single Admission record of the supplied Admission ID.
\nExample: 09d59e63-c463-4194-a5f8-8fcbd2829e6e
\n","type":"text/plain"},"type":"any","value":"Modify one or more fields on the single Admission record of the supplied Admission ID.
\nExample: 09d59e63-c463-4194-a5f8-8fcbd2829e6e
\n","type":"text/plain"},"type":"any","value":"Permanently delete the Admission record of the supplied Admission ID.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Example: c2ceafe7-2317-4571-9b6f-82c8847f8e9a
\n","type":"text/plain"},"type":"any","value":"Admissions are the recorded dates/times of a registrant being admitted to the event, be it in person or virtually. Admissions can be used for verification, COA, CE purposes.
\nRetrieve a collection of Registrationaddress records.
\nCreate a new Registrationaddress record.
\nRetrieve the single Registrationaddress record of the supplied Registrationaddress ID.
\nExample: 800abccf-ed34-4371-8864-8d1714c964da
\n","type":"text/plain"},"type":"any","value":"Modify one or more fields on the single Registrationaddress record of the supplied Registrationaddress ID.
\nExample: 800abccf-ed34-4371-8864-8d1714c964da
\n","type":"text/plain"},"type":"any","value":"Permanently delete the Registrationaddress record of the supplied Registrationaddress ID.
\n","auth":{"type":"oauth2","oauth2":{"tokenRequestParams":"Example: 4382cf58-abb5-458b-a9a1-00f8b1b11bde
\n","type":"text/plain"},"type":"any","value":"Registration addresses are the physical addresses of the registrant, a registrant can have multiple addresses.
\nRetrieve a collection of Consent records.
\nCreate a new Consent record.
\neventId and name must be unique.Retrieve the single Consent record of the supplied Consent ID.
\nExample: 6c066726-2083-463a-981a-98ffca3c7808
\n","type":"text/plain"},"type":"any","value":"Modify one or more fields on the single Consent record of the supplied Consent ID.
\n