19 |
20 | {method && (
21 | <>
22 | {method}{' '}
23 |
24 | )}
25 | {header}
26 | {headerSubText && (
27 |
28 | {headerSubText}
29 |
30 | )}
31 |
32 |
33 | {children}
34 |
35 |
36 | );
37 | }
--------------------------------------------------------------------------------
/docs/guides/intro.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | hide_table_of_contents: true
4 | ---
5 |
6 | # Introduction
7 |
8 | Welcome to ConCat! We've created some helpful guides to help you get started with our platform and get your
9 | event up and running.
10 |
11 | href OR to, not both.
21 |
27 |
45 | );
46 | }
--------------------------------------------------------------------------------
/src/pages/pricing.module.scss:
--------------------------------------------------------------------------------
1 | @import '@site/src/css/_variables.scss';
2 |
3 | .main {
4 | padding: 1.25rem 1rem 1rem 2rem;
5 |
6 | h3 {
7 | margin: 2.5rem 0 1rem !important;
8 | }
9 | }
10 |
11 | .price-card {
12 | header {
13 | text-align: center;
14 | }
15 |
16 | .pricing {
17 | div {
18 | font-size: 2rem;
19 | text-align: center;
20 | margin-bottom: -0.75rem;
21 |
22 | small {
23 | font-size: 1rem;
24 | }
25 | }
26 | }
27 |
28 | .buttons a {
29 | width: 100%;
30 | }
31 |
32 | hr {
33 | opacity: 0.5;
34 | border-width: 0.5px;
35 | }
36 |
37 | ul {
38 | list-style: none;
39 | padding: 0;
40 | margin: 0;
41 | margin-left: 1rem;
42 |
43 | li {
44 | display: inline-flex;
45 | width: 100%;
46 | height: 26px;
47 |
48 | :global(.material-symbols-outlined) {
49 | margin-right: 1rem;
50 | width: 24px;
51 | height: 24px;
52 | }
53 |
54 | &.feature-on {
55 | :global(.material-symbols-outlined) {
56 | color: $brand-primary;
57 | }
58 | }
59 | }
60 | }
61 | }
62 |
63 | @media screen and (max-width: 966px) {
64 | .main {
65 | padding: 1.1rem;
66 | }
67 |
68 | .price-card {
69 | ul {
70 | margin-left: 0;
71 |
72 | li :global(.material-symbols-outlined) {
73 | margin-right: 0.5rem;
74 | }
75 | }
76 | }
77 | }
--------------------------------------------------------------------------------
/src/theme/MDXComponents.tsx:
--------------------------------------------------------------------------------
1 | // Import the original mapper
2 | import MDXComponents from '@theme-original/MDXComponents';
3 | import Highlight from '@site/src/components/Highlight';
4 | import { Attribute, ParentAttribute } from '@site/src/components/Attribute';
5 | import MaterialIcon from '@site/src/components/MaterialIcon';
6 | import RESTElement from '@site/src/components/RESTElement';
7 | import RESTList from '@site/src/components/RESTList';
8 | import EndpointRequest from '@site/src/components/EndpointRequest';
9 | import EndpointResponse from '@site/src/components/EndpointResponse';
10 | import ExampleBox from '@site/src/components/ExampleBox';
11 | import SplitColumn from '@site/src/components/SplitColumn';
12 | import BigButton from '@site/src/components/BigButton';
13 | import Card from '@site/src/components/Card';
14 | import Link from '@docusaurus/Link';
15 | import Admonition from '@theme/Admonition';
16 |
17 | export default {
18 | // Re-use the default mapping
19 | ...MDXComponents,
20 | // Map the "highlight" tag to our
29 | {href ? (
30 |
31 | {title}
32 |
33 | ) : (
34 |
35 | {title}
36 |
37 | )}
38 | {children && (
39 |
44 |
40 | {children}
41 |
42 | )}
43 | -
15 |
- 16 | 17 | In Housekeeping, navigate to the product page for the product you want to add addons to. 18 | 19 | 20 |
- 21 | 22 | Click the green plus (add) button next to the "Addons" section. 23 | 24 | 25 |
- 26 | 27 | Search for the product you want to add as an addon and select it from the dropdown. 28 | 29 | 30 |
- 31 | 32 | Check the "Addon is complimentary" checkbox, then click "Create Add-on". 33 | 34 | 35 |
10 |
32 | 11 | If an attendee is unable or no longer wants to attend they can choose to transfer their registration to another user instead of requesting a refund. 12 |
13 |Steps
14 |-
15 |
- 16 | Click "Register for EVENTNAME" in the left navigation bar. 17 | 18 |
- 19 | Using the three-dots menu bar (more_horiz), click "Transfer Registration". 20 | 21 |
- 22 | Enter the email address of the attendee you want to receive the registration. 23 | 24 |
- 25 | Enter your password to confirm the transfer. 26 | 27 |
- 28 | Click "Transfer Registration". 29 | 30 |
33 | 
34 |
35 |
34 |
15 |
16 |
41 |
42 |
17 |
37 | 18 | Manage your event, not a spreadsheet. 19 |
20 |21 | Simple event management for events of all sizes. Whether you're just 22 | starting out or already established, we're right there with you. 23 |
24 |
25 |
28 | View Pricing
29 |
30 |
33 | Learn More
34 |
35 |
36 |
38 | 
39 |
40 |
39 | docs directory.
29 |
30 | ),
31 | },
32 | {
33 | title: 'Powered by React',
34 | image: '/img/undraw_docusaurus_react.svg',
35 | description: (
36 | <>
37 | Extend or customize your website layout by reusing React. Docusaurus can
38 | be extended while reusing the same header and footer.
39 |
40 | ),
41 | },
42 | ];
43 |
44 | function Feature({title, image, description}: FeatureItem) {
45 | return (
46 |
47 |
55 | );
56 | }
57 |
58 | export default function HomepageFeatures(): JSX.Element {
59 | return (
60 |
48 | 
49 |
50 |
51 |
54 | {title}
52 |{description}
53 |
62 |
68 |
63 | {FeatureList.map((props, idx) => (
64 |
67 | -
16 |
- 17 | 18 | In Housekeeping, navigate to the product page for the product you want to add a discount to. 19 | 20 | 21 |
- 22 | 23 | Click the green plus (add) button next to the "Discounts" section. 24 | 25 | 26 |
- 27 | 28 | Enter the discounted price. This is the price that attendees will pay if they purchase the product, not how much the discount is. 29 | 30 | 31 |
- 32 | 33 | (Optional) If you want to limit the discount to a single or set of roles, search for them and select them from the dropdown. 34 | 35 | 36 |
- 37 | 38 | (Optional) By default, discounts will become active immediately, but you can customize both the Available From and Available Until dates. 39 | 40 | 41 |
- 42 | 43 | Click "Create Discount Price". 44 | 45 | 46 |
48 | 
49 |
50 |
49 |
17 |
45 |
46 | The full scanner manual can be found [here](/img/cashier/barcodes/TEEMI_2D_Barcode_Scanner_Manual.pdf).
47 |
48 | # Configuring the cashier interface
49 |
50 | Once the scanner is configured, you can now configure the cashier interface to use the scanner. Open the cashier interface, and click on the top left printer icon to configure devices.
51 |
52 | -
18 |
-
19 | Factory reset the scanner to the base settings.
20 |
21 |
22 |
23 | -
24 | Reduce the noise of the beeps.
25 |
26 |
27 |
28 | -
29 | Disable all barcode scan types.
30 |
31 |
32 |
33 | -
34 | Enable PDF417 to be scanned. (Used by driver's licenses)
35 |
36 |
37 |
38 | -
39 | Eanble USB COM mode. This will allow the scanner to interface with the computer as a serial interface, instead of a keyboard, and allow for faster input of the driver's license information once scanned.
40 |
41 |
42 |
43 |
53 |
54 | Configure the Scanner, by clicking "Add Manually" and then "Scanner with Web Serial", and follow the browser's prompts to add the device.
55 |
56 | 
--------------------------------------------------------------------------------
/docs/guides/dealers/managment.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # Dealers
6 |
7 | Attendees can apply to be dealers, by specifying information about their business, what products they intend to sell, and what amenities they need during the convention.
8 |
9 | Amenities are products that need to be created within the dealer product category. Such amenities are usually products such as the table size, the need for electricity, or the need to be in an 18+ section.
10 |
11 | Dealer applications then need to be approved by a vendor administrator, at which point the vendor will be sent an email, and the products will be added to their cart.
12 |
13 | After the vendor pays for their amenities, the vendor will be promoted to an Approved (Paid)” status.
14 |
15 | :::info Note
16 | Dealers are still expected to pay for their registration. If you'd like to offer a discount or registration for free, you can do so via a [Product Discount](/docs/guides/products/discounts)
17 | :::
18 |
19 | # Dealer Areas
20 |
21 | Dealers may apply to more than one dealer area (if only one exists then they will not be given the option). Each dealer area have a different product category, which gives the dealer different choices of table types to pick from. This category **must** be created before creating the dealer area.
22 |
23 | # Creating a Vendor Category
24 |
25 | You can manage Vendor Categories directly from the Dealers tab.
26 |
27 | Head to the "Products" tab, you'll see any existing Vendor Categories. Create one with the "Create Category" button at the top.
28 |
29 | Visible products will be displayed as table types that the dealer can choose.
30 |
31 | Hidden products that are set as "Addons" to the visible products will be displayed as additional optional choices for dealers to pick.
32 |
33 | ## Dealer Assistants
34 |
35 | Dealers are allowed to request for assistants, which when approved, will be also given a “Dealer” status on their badge.
36 |
37 | Once they have been approved and pay for their table, Dealers can head to the "Vendor" tab (where they applied) and select the "Manage Assistants" button in order to add and manage their assistants. They will need to know the assistant's username.
38 |
39 | ## Seating Preferences
40 |
41 | Dealers can also request to be next to other vendors. By selecting the "Seating Preferences" button on the Vendor tab, dealers can view their Vendor ID to share with others in order to request shared seating.
--------------------------------------------------------------------------------
/docs/api/errors/errors.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | displayed_sidebar: apiSidebar
4 | ---
5 |
6 | # Errors
7 |
8 | ConCat uses conventional HTTP response codes to indicate the success or failure of a request.
9 |
10 | Typically, response codes in the `2xx` range indicate success, `4xx` range indicate an error with the data provided in a request, while `5xx` codes indicate a error with the platform.
11 |
12 | Some `4xx` codes may indicate a problem with your integration or application, such as a rate-limit error, instead of an issue with the provided data.
13 |
14 | ### Base Format
15 |
16 | ```json
17 | {
18 | "errors": {
19 | "server": {},
20 | "access": {},
21 | "logic": {},
22 | "resource": {},
23 | "usage": {},
24 | "authentication": {},
25 | "validation": {},
26 | "rateLimit": {},
27 | "internal": {}
28 | }
29 | }
30 | ```
31 |
32 | ### Server Errors
33 |
34 | Server Errors indicate a problem with the ConCat platform that is not related to the data provided in the request. Usually these will accompany a
12 |
23 |
24 | ## Before first day of registration
25 |
26 | Discuss policy about refunds
13 | Discuss refund policy for attendees who do not attend the convention
14 | Discuss if the end of the pre-registration period (Or if the registration can remain open all the way up to the convention)
15 | Discuss pre-registration discount date ranges
16 | Update the registration flags settings. (Settings > Reg flags)
17 | -
18 |
- Verify that the convnetion is okay with having user's accounts redacted after the convention is over (The 'nukeme' setting) 19 |
Add additional addons for swag pickup for Sponsor+ registration levels. It is recommended that only a single "Swag" bag product is added, as the cashiers will have to individually mark each item as picked up.
21 | Check your Stripe payoff schedule. ConCat recommends to have daily automatic transfers.
22 |
27 |
35 |
36 | ## After the event
37 |
38 | Go over the cashier interface.
28 | Verify that the convention has a badge design that needs to be printed. (Settings > Badge Designer)
29 | Verify that the printer works with the cashier station.
30 | Verify that driver license's scanner is working.
31 | Have a method to collect payments at the convention. ConCat does not yet have a method to directly collect payments, but orders can be mark as paid from an external 'cash' or 'card' method.
32 | Verify that all dealers have paid for registration. (Check Attendee Statistics > Dealers)
33 | Verify that the correct label sizes have been bought for the printer.
34 |
39 |
44 |
45 |
--------------------------------------------------------------------------------
/src/components/attribute.module.scss:
--------------------------------------------------------------------------------
1 | .attribute, .attribute-parent {
2 | margin-top: 0.5rem;
3 | padding-bottom: 0.5rem;
4 | margin-left: 1.3rem;
5 | }
6 |
7 | .attribute {
8 | scroll-margin-top: calc(var(--ifm-navbar-height) + 0.5rem);
9 |
10 | &:hover {
11 | .attribute-link {
12 | opacity: 1;
13 | }
14 | }
15 | }
16 |
17 | .attribute:not(:last-child) {
18 | border-bottom: 1px solid rgb(45, 45, 45);
19 | }
20 |
21 | details .attribute:not(:last-child) {
22 | border-bottom: 1px solid rgb(75, 100, 120);
23 | }
24 |
25 | .attribute-info, .attribute-info-perms {
26 | font-size: 14px;
27 |
28 | small {
29 | font-size: 12px;
30 | }
31 | }
32 |
33 | .attribute-info-perms {
34 | code {
35 | margin-left: 1.5rem;
36 | }
37 |
38 | :global(.material-symbols-outlined) {
39 | color: #ddac30;
40 | position: absolute;
41 | font-size: 18px;
42 | margin-top: 4px;
43 | cursor: default;
44 | }
45 | }
46 |
47 | .attribute-link {
48 | cursor: pointer;
49 | position: absolute;
50 | margin-left: -1.7rem;
51 | margin-top: 0.1rem;
52 | opacity: 0;
53 | transition: opacity var(--ifm-transition-fast);
54 | }
55 |
56 | .attribute-permissions {
57 | margin-top: 0.5rem;
58 | }
59 |
60 | .attribute-deprecated {
61 | display: inline-block;
62 | margin-left: 0.5rem;
63 |
64 | span {
65 | background-image: repeating-linear-gradient(
66 | -70deg,
67 | #00000020 0px,
68 | #00000020 10px,
69 | #ffb30120 10px,
70 | #ffb10120 20px
71 | );
72 | }
73 | }
74 |
75 | .attribute-optional, .attribute-required {
76 | float: right;
77 | }
78 |
79 | .attribute-required {
80 | color: #ddac30;
81 | }
82 |
83 | .attribute-optional {
84 | font-style: italic;
85 | }
86 |
87 | .attribute-parent {
88 | > .attribute {
89 | border-bottom: 0;
90 | margin-left: 0;
91 | }
92 |
93 | border-bottom: 1px solid rgb(45, 45, 45);
94 | }
95 |
96 | .attribute-children {
97 | display: none;
98 |
99 | &.attribute-children-visible {
100 | display: block;
101 | border: 1px solid rgb(45, 45, 45);
102 | }
103 |
104 | .attribute-link :global(.material-symbols-outlined) {
105 | background-color: white;
106 | }
107 |
108 | > .attribute {
109 | margin-left: 1rem;
110 |
111 | &:last-child {
112 | border-bottom: 0 !important;
113 | }
114 | }
115 |
116 | .attribute-optional, .attribute-required {
117 | margin-right: 1rem;
118 | }
119 |
120 | .attribute-children {
121 | margin-right: 1rem;
122 | }
123 | }
124 |
125 | .attribute-showhide-children {
126 | border: 1px solid rgb(45, 45, 45);
127 | border-radius: 0.5rem;
128 | padding: 0.15rem 0.55rem 0.15rem 0.5rem;
129 | width: fit-content;
130 | font-size: 12px;
131 | cursor: pointer;
132 |
133 | &.attribute-children-visible {
134 | border-bottom-left-radius: 0;
135 | border-bottom-right-radius: 0;
136 | margin-bottom: -1px;
137 | }
138 | }
139 |
140 | [data-theme='dark'] {
141 | .attribute-children .attribute-link :global(.material-symbols-outlined) {
142 | background-color: #1b1b1d;
143 | }
144 | }
--------------------------------------------------------------------------------
/src/components/Attribute.tsx:
--------------------------------------------------------------------------------
1 | import React, { FunctionComponent, ReactNode, useCallback, useState } from 'react';
2 | import MaterialIcon from './MaterialIcon';
3 |
4 | import styles from './attribute.module.scss';
5 | import Highlight from './Highlight';
6 | import clsx from 'clsx';
7 |
8 | interface Props {
9 | children: ReactNode;
10 | id: string;
11 | name: string;
12 | type: string;
13 | optional?: boolean;
14 | response?: boolean;
15 | deprecated?: boolean;
16 | permissions?: string[];
17 | }
18 |
19 | export function Attribute({
20 | children, name, id, type, response = false, optional = false, deprecated = false, permissions = [],
21 | }: Props) {
22 | const hasPermissions = permissions.length > 0;
23 |
24 | return (
25 | Go over any outstanding refund requests.
40 | Discuss with ConCat if a mass refund needs to be performed for attendees who did paid, but did not attend.
41 | Discuss with ConCat if user information needs to be redacted.
42 | Discuss with ConCat for creating a new convention for the next year.
43 |
26 |
67 | );
68 | }
69 |
70 | interface ParentProps extends Props {
71 | children: ReactNode[];
72 | }
73 |
74 | export function ParentAttribute(props: ParentProps): JSX.Element {
75 | const [childState, setChildState] = useState(false);
76 | const toggleChildren = useCallback(() => setChildState(!childState), [childState]);
77 |
78 | return (
79 |
27 |
28 |
31 |
32 | {hasPermissions && (
33 |
58 | {name}
36 |
37 | {type}
38 | {optional && (optional)}
39 | {deprecated && (
40 |
41 |
42 | Deprecated
43 |
44 |
45 | )}
46 | {(!optional && !response) && (
47 |
48 | Required
49 |
50 | )}
51 | {(optional && response) && (
52 |
53 | nullable
54 |
55 | )}
56 |
57 |
59 | {children}
60 | {permissions.length > 0 && (
61 |
66 |
62 | Required Scope(s): {permissions.join(', ')}
63 |
64 | )}
65 |
80 |
88 | )
89 | }
--------------------------------------------------------------------------------
/docs/api/gettingstarted/gettingstarted.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | displayed_sidebar: apiSidebar
4 | ---
5 |
6 | # Getting Started
7 |
8 | :::caution
9 | The ConCat APIs are in **early access**, are subject to change, and are available to event customers and select external partners only.
10 |
11 | If you're interested in integrating with ConCat, please reach out to **developers@concat.systems** with your use-case.
12 | :::
13 |
14 | There are two ways to integrate with the ConCat APIs: On Behalf Of (OBO) a user, or as a service. Service-level integration is the preferred method and will allow modification of data in the future, whereas OBO integration will remain read-only and intended for primarily authentication purposes.
15 |
16 | ## Which method should I use?
17 |
18 | #### On Behalf Of (OBO) a user
19 | The OBO method is intended primarily for authenticating a user to a third-party service and providing metadata about the user, such as their name, email address, and any roles or permissions they have.
20 |
21 | OBO requires the service to redirect the user to an authentication page displaying the requested permission scopes, a basic description of the service, and the ability to grant or deny access.
22 |
23 | #### As a service
24 | The as a service method is intended for allowing a third-party service to retrieve and modify data within the ConCat platform. This is useful for micro-services that need to perform automated actions based on webhooks, or that need to perform actions that require elevated permissions.
25 |
26 | Permissions for a service integration are granted by an event customer at the time the integration is created. There is no additional approval or authentication step. If your service requires additional permissions, you will need to contact the event customer to request them.
27 |
28 | ## Registering as a developer
29 |
30 | Developer registration is by invitation only. To register as a developer, please reach out to **developers@concat.systems** with the following:
31 |
32 | * Your name
33 | * Your company name, website, and contact information
34 | * A display name for your application
35 | * A short description of your use-case
36 | * A list of our event customers you are interested in, or are already working with *(optional)*
37 |
38 | Upon approval, you will be given a unique API ID and secret key. You can use these to authenticate your requests to the ConCat APIs in both OBO and as a service methods.
39 |
40 | ## Authenticating requests
41 |
42 | All requests to the ConCat APIs **must** be done through a HTTPS connection, with a minimum TLS protocol of v1.2 or newer. A time-limited authentication Bearer token must be obtained and provided in the Authorization header of each request.
43 |
44 | :::info
45 | The Authorization header should always be provided even if the request is not authenticated. This helps us prevent abuse of the APIs, and collect usage statistics to improve the service.
46 | :::
47 |
48 | ## Revoking access
49 | If there's no activity by your integration for a year or more, we reserve the right to revoke your API credentials to prevent abuse. You can reach back out to us to re-activate at any time.
50 |
51 | If you're no longer planning to use the ConCat APIs, we ask that you reach out to us to let us know. We'll revoke your API credentials and remove your integration from our systems.
52 |
53 | ### Handling revocations
54 | In the event your integration is revoked, you'll receive a revocation email and will no longer be able to authenticate to the APIs. You **must** delete all associated event data stored by your application within 30 days of receiving the revocation email.
--------------------------------------------------------------------------------
/docs/api/endpoints/v0/_registrationModel.mdx:
--------------------------------------------------------------------------------
1 |
82 | {childState ? 'Hide' : 'Show'} child attributes
83 |
84 |
85 | {props.children[1]}
86 |
87 | The type of the option as defined by the event.
30 |
31 | Possible values:
33 | select, multi, text, number.
32 | | Option | 32 |Explanation | 33 |
|---|---|
| Enable payment acceptance | 36 |If enabled, this registration station will be able to accept payments. This will allow cashiers to take payments for any balance due on an attendee's account. Otherwise, cashiers will be informed they should direct the attendee to a different registration station. | 37 |
| Require ID barcode scan | 40 |If enabled, this registration station require an ID barcode to be scanned before a badge can be printed. Otherwise, cashiers will be informed they should direct the attendee to a different registration station. | 41 |
| Enable staff check-in | 44 |If enabled, this registration station will be able to print staff and volunteer badges. This affects printing badges for anyone with an approved volunteer application. Otherwise, cashiers will be informed they should direct the attendee to a different registration station. | 45 |
| Print separate staff badge | 48 |If enabled, this registration station will print two badges, one with the attendee's chosen attendance type, and one with the "STAFF" text. Otherwise, a combination badge will be printed with the attendee's chosen attendance type and the "STAFF" text together, separated by a slash. | 49 |
| Print separate vendor badge | 52 |If enabled, this registration station will print two badges, one with the attendee's chosen attendance type, and one with the "VENDOR" text. Otherwise, a combination badge will be printed with the attendee's chosen attendance type and the "VENDOR" text together, separated by a slash. | 53 |
--------------------------------------------------------------------------------
/docs/guides/orders/orders.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | hide_table_of_contents: true
4 | ---
5 |
6 | # Orders
7 |
8 | An order is a collection of products (such as an event registration, vendor table, or event store purchase) a given attendee wants to purchase. Order are created automatically when an attendee has a product added to their cart.
9 |
10 | Orders can be viewed through the "**Orders**" page in Housekeeping, or through the orders tab on an attendee's profile.
11 |
12 | ### Order states
13 |
14 | Orders can be in one of two states: **unpaid** and **paid**. Orders will transition from the unpaid to paid state whenever payment is made in full, a voucher meets or exceeds the order total, or the order is manually marked as paid via the "**Orders**" page.
15 |
16 | Unpaid orders currently do not expire, but can be edited and cancelled at any time through the housekeeping interface.
17 |
18 | ### Creating an order
19 |
20 | Most of the time, an order is created automatically when an attendee adds a product to their cart. However, if you need to manually add a product to an attendee's cart, but they don't have an existing unpaid order, you can create one using the following steps:
21 |
22 | -
23 |
- 24 | 25 | Navigate to your event website, then click "Housekeeping" from the left-hand sidebar. 26 | 27 | 28 |
- 29 | 30 | Click "User Search" from the left-hand sidebar, then click the "Orders" tab. 31 | 32 | 33 |
- 34 | 35 | Click "Create New Order". 36 | 37 | 38 |
- 39 | 40 | Click "Show Details" on the newly created order to open it in the "Orders" page. Click the plus (add) icon next to "Pending Payment" to add a product to the order. 41 | 42 | 43 |
61 |
88 | 62 | If a paid order contains a fulfillable product, the order will be shown in yellow on the order list as "Pending Fulfillment". Fulfillable products are any products outside of the registration and vendor / dealer categories, with the exception of QuikTicket™-enabled products. 63 |
64 |To fulfill an order, follow the steps below:
65 |-
66 |
- 67 | 68 | Navigate to the order you want to fulfill. 69 | 70 | 71 |
- 72 | 73 | Click "Mark as Fulfilled". 74 | 75 | 76 |
- 77 | 78 | Click the checkbox next to each product you want to fulfill. 79 | 80 | 81 |
- 82 | 83 | Click "Fulfill Order". 84 | 85 | 86 |
89 | 
90 |
91 |
90 | -
19 |
- 20 | 21 | Navigate to your event website, then click "Housekeeping" from the left-hand sidebar. 22 | 23 | 24 |
- 25 | 26 | Click "Raffles" from the left-hand sidebar, under the "Product Management" section. 27 | 28 | 29 |
- 30 | 31 | Click "Create New Raffle". 32 | 33 | 34 |
- 35 | 36 | Enter a name for the raffle. You can also allow staff and volunteers to bypass the raffle by relevant checkbox. 37 | 38 | 39 |
-
40 | 41 |44 |Use the wizard to configure the weight configuration.42 |To operate a raffle with equal chances, select "Add Static Weight" and enter a value of "1".43 |
45 |
- 46 | 47 | Under "Associated Products", search for and select the products that will be included in the raffle. 48 | 49 | 50 |
- 51 | 52 | Click "Create Raffle". 53 | 54 | 55 |
-
60 |
- 61 | 62 | Navigate to the raffle you want to draw. 63 | 64 | 65 |
- 66 | 67 | Click the "Entrants" tab, then "Run Raffle". 68 | 69 | 70 |
-
71 | 72 |79 |73 | Enter the number of winners to draw, what should happen to existing winners (if any), and what should happen to any entrants who do not win in this draw. 74 |75 |
76 | If you plan to run multiple draws, leave the "non-winners" option as "Do Nothing". 77 | 78 |
80 | - 81 | 82 | (Optional) If you plan to run multiple draws and want to accept new entries in between draws, uncheck "Close the raffle to new entries". 83 | 84 | 85 |
- 86 | 87 | (Optional) You can perform a test run of the raffle to verify the raffle logic by checking "Perform a test run". 88 | 89 | 90 |
- 91 | 92 | Click "Run Raffle Draw". This could take a few minutes depending how many entries there are. 93 | 94 | 95 |
-
18 |
- 19 | 20 | Navigate to your event website, then click "Housekeeping" from the left-hand sidebar. 21 | 22 | 23 |
- 24 | 25 | Click "Surcharges" from the left-hand sidebar, then click "Create New Surcharge". 26 | 27 | 28 |
- 29 | 30 | Enter an internal name and display name for your surcharge. 31 | 32 | 33 |
-
34 | 35 |48 |Select the type of surcharge you want to create.36 |
-
37 |
- 38 | Surcharge - Fixed Amount - A fixed amount that is added to the line item price of the product. 39 | 40 |
- 41 | Surcharge - Percentage - A percentage that is calculated from the base line item price of a product. 42 | 43 |
- 44 | Tax Rate - A Government tax rate that is calculated from the base line item price of a product and added to the order total. 45 | 46 |
49 | - 50 | 51 | Enter the amount or percentage rate of the surcharge. 52 | 53 | 54 |
- 55 | 56 | Click "Create Surcharge". 57 | 58 | 59 |
61 | 
62 |
63 |
62 | -
71 |
- 72 | 73 | In Housekeeping, navigate to the product's page. 74 | 75 | 76 |
- 77 | 78 | Click the green plus (add) button next to the "Surcharges" section. 79 | 80 | 81 |
- 82 | 83 | Search for the surcharges you want to add and select them from the dropdown. 84 | 85 | 86 |
- 87 | 88 | Click "Assign Surcharges". 89 | 90 | 91 |
93 | 
94 |
95 |
94 | -
13 |
- 14 | Single Select - A dropdown list of options that the attendee can select from. 15 | 16 |
- 17 | Multi Select - A checkbox list of options that the attendee can select from. 18 | 19 |
- 20 | Freetext Field - An text input field that the attendee can enter their own value, with a customizable minimum and maximum length. 21 | 22 |
- 23 | Number - A number field that the attendee can enter their own value, with a customizable minimum and maximum value. 24 | 25 |
- 26 | Currency - A currency field that allows the attendee to enter their own value, with a customizable minimum and maximum value. The line item price of the product will be increased by the entered amount. 27 | 28 |
-
34 |
- 35 | 36 | Navigate to your event website, then click "Housekeeping" from the left-hand sidebar. 37 | 38 | 39 |
- 40 | 41 | Click "Options" from the left-hand sidebar, then click "Create New Option". 42 | 43 | 44 |
-
45 | 46 |51 |Enter a name for your option, and select the type of option you want to create.47 |48 | Note: The chosen name will be displayed to the attendee when they customize a product with this option. 49 |50 |
52 |
- 53 | 54 | Customize the option based on the type of option you selected. Fields that are optional are marked with a (Optional) label. 55 | 56 | 57 |
- 58 | 59 | Click "Create". 60 | 61 | 62 |
64 | 
65 |
66 |
65 | -
74 |
- 75 | 76 | In Housekeeping, navigate to the product's page. 77 | 78 | 79 |
- 80 | 81 | Click the green plus (add) button next to the "Options" section. 82 | 83 | 84 |
- 85 | 86 | Search for the product options you want to add and select them from the dropdown. 87 | 88 | 89 |
- 90 | 91 | (Optional) If you want to require the attendee to select or fill in a value for this option, check the "Mark Selected Options as Required" checkbox. 92 | 93 | 94 |
- 95 | 96 | Click "Assign Options". 97 | 98 | 99 |
101 |
102 |
103 |
102 | The flags indicating the volunteer's preference or assignment for the department.
29 |
30 | Possible values:
32 | experience, interest, avoid, assignment, request
31 | The type of the option as defined by the event.
72 |
73 | Possible values:
75 | select, multi, text, number.
74 |
9 |
16 | 10 | The badge designer allows you to customize the badge layout and styling, using a layer style positioning of elements, to enable compatibility with a wide array of printing hardware and design needs. 11 |
12 |13 | You can select from a variety of user-generated content, such as real name, badge ID, badge name, and attendance tier. 14 |
15 |
17 | 
18 |
19 |
18 | -
30 |
- 31 | 32 | Navigate to your event website, then click "Housekeeping" from the left-hand sidebar. 33 | 34 | 35 |
- 36 | 37 | Click "Settings" from the left-hand sidebar, then "Badge Designer" from the top menu. 38 | 39 | 40 |
- 41 | 42 | Click the green plus (add) button. 43 | 44 | 45 |
- 46 | 47 | Enter a name for the design in the "Display Name" field. 48 | 49 | 50 |
-
51 | 52 | Under "Details" choose the artboard size for your design, in inches: 53 |62 |
-
54 |
- 55 | X and Y: The margin of the artboard from the left and top (respectively). 56 | 57 |
- 58 | Width and Height: The maximum width and height of the customizable artboard. 59 | 60 |
63 | - 64 | Customize the design by adding additional nodes (layer groups) and text. 65 | 66 |
- 67 | Once you've finished your design, click "Save". 68 | 69 |
81 |
91 | 82 | If you have your badges pre-printed with background art through a third-party service, you can enable this option add an additional artboard behind the design. 83 |
84 |85 | This is useful for checking the positioning of your design elements to avoid overprinting, and quickly previewing the design across different background art. 86 |
87 |88 | Use of this feature requires uploading at least one Badge Art image to the system. 89 |
90 |
92 | 
93 |
94 |
93 |
17 |
42 | Pricing
18 |19 | ConCat offers a feature-packed event management experience for a hard to believe price that 20 | scales as your event grows. 21 |
22 |23 | We offer a fixed price per registered attendee & hotel reservations, and a small percentage for all other transactions, 24 | such as vendor tables and the event store. 25 |
26 |No Module Costs
27 |28 | There's no per-module costs for the additional modules included with ConCat. That means you 29 | get vendor management, volunteer management, hotel management, and our event store at no extra cost! 30 |
31 |No Hidden Costs
32 |33 | You don't like hidden costs and neither do we. That's why the only prices you'll pay are 34 | the ones you see here. We also don't require free badges for our engineers or support staff. 35 |
36 |Payments by Stripe
37 |38 | We integrate with Stripe Connect to securely accept credit cards, Apple Pay, Google Pay, and bank transfers in more 39 | than 135 countries. 40 |
41 |
44 |
49 | $1.00 per attendee*
45 | $1.00 per hotel room
46 | 1% all other transactions*
47 | * Stripe fees not included.
48 | 50 |
-
51 |
-
52 |
53 | Cloud Hosted 54 |
55 | -
56 |
57 | Unlimited Attendees 58 |
59 | -
60 |
61 | Unlimited Products 62 |
63 | -
64 |
65 | Volunteer Management 66 |
67 | -
68 |
69 | Vendor Management 70 |
71 | -
72 |
73 | Basic Support 74 |
75 | -
76 |
77 | Free concat.app Subdomain 78 |
79 | -
80 |
81 | Free Custom Domain 82 |
83 |
85 |
86 |
90 | Contact Sales
91 |
92 |
93 |
81 |
108 | {feature && (
109 | -
82 | {features.map(({
83 | description, icon, id, name,
84 | }) => {
85 | const isActive = activeFeature === id;
86 | const classes = clsx(styles.feature, isActive ? styles['feature-selected'] : undefined);
87 |
88 | return (
89 |
- setActiveFeature(id)}
93 | >
94 | 95 |98 | {isActive && ( 99 |
96 | {name} 97 | 100 | {description} 101 |102 | )} 103 |
104 | );
105 | })}
106 |
110 | 
111 |
112 | )}
113 |
111 |
11 | Roles are a way to group users together. They can be used to grant permissions to a group of users, or to identify a group of users for other purposes, such as identifying staff members or those who have signed an NDA.
12 |
13 |
24 |
32 | The roles that match the search.
33 | <>
34 |
35 | The unique identifier of the role.
36 |
37 |
38 | The unique name of the role.
39 |
40 |
41 |
42 |
43 | A cursor for pagination across multiple pages of results. If this attribute is present, there are more results available. Use this value in the
45 |
46 | Returns all role objects.
25 |Authentication
26 |
27 | Service Integration with
29 |
30 | user:read scope.
28 | Response
31 |nextPage parameter for the next request.
44 |
47 |
48 | {`curl https://reg.cces.dev/api/v0/roles \\
49 | -H "Authorization: Bearer "`}
50 |
51 |
52 | {`{
53 | "data": [
54 | {
55 | "id": "1234",
56 | "name": "staff"
57 | },
58 | ],
59 | "nextPage": null
60 | }`}
61 |
62 |
63 |
69 |
79 | The roles of the user.
80 | <>
81 |
82 | The unique identifier of the role.
83 |
84 |
85 | The name of the role.
86 |
87 |
88 | Whatever the role was given to the user globally, or just for the current convention.
89 |
90 |
91 |
92 |
93 | 70 | List the roles given to the specified user. 71 |
72 |Authentication
73 |
74 | Service Integration with
76 |
77 | user:read scope.
75 | Response
78 |
94 |
95 | {`{
96 | "data": [
97 | {
98 | "id": "1234",
99 | "name": "admin",
100 | "scope": "global",
101 | }
102 | ]
103 | }`}
104 |
105 |
106 |
112 |
122 | Whatever the role will be given to the user for the current convention, or across all conventions in the organization. Values can be "convention" or "global".
123 |
124 |
125 |
126 | 113 | Gives the user the specified role. This request will fail if the user already has the role. 114 |
115 |Authentication
116 |
117 | Service Integration with
119 |
120 | user:roles:update scope.
118 | Request
121 |
127 |
128 | {`{
129 | "scope": "convention"
130 | }`}
131 |
132 |
133 |
140 |
149 | 141 | Removes the user from the specified role. This request will fail if the user is not in the role. 142 |
143 |Authentication
144 |
145 | Service Integration with
147 |
148 | user:roles:update scope.
146 |
150 |
152 |
13 | This object represents event registrations within a convention.
14 |
15 |
25 |
36 | 26 | Gets a single user registration by the giver user id. 27 |
28 |Authentication
29 |
30 | Service Integration with
32 |
33 | registration:read scope.
31 | Request
34 |
37 |
39 | {`{
40 | "createdAt": "2022-02-23T00:30:47.468Z",
41 | "updatedAt": "2022-09-21T01:04:51.456Z",
42 | "badgeName": "Joe",
43 | "status": "paid",
44 | "productName": "Patron",
45 | "productDisplayName": null,
46 | "productId": "172",
47 | "options": [
48 | {
49 | "name": "Species",
50 | "type": "text",
51 | "value": "Mega Bunny"
52 | },
53 | {
54 | "name": "Shirt Size",
55 | "type": "select",
56 | "value": "M"
57 | }
58 | ],
59 | "flags": [
60 | {
61 | "id": "1",
62 | "shortName": "fursuits"
63 | }
64 | ],
65 | "user": {
66 | "id": "1234",
67 | "firstName": "John",
68 | "lastName": "Doe",
69 | "username": "jdoe",
70 | "preferredName": "Johnny",
71 | "phone": "+15555555555",
72 | "email": "johnny.test@concat.systems"
73 | }
74 | }`}
75 |
76 |
77 |
83 |
93 | A cursor for pagination across multiple pages of results. Don't include this attribute on the first call. Use the
95 |
96 | The maximum number of results to return, between 1 and 100. Defaults to 100.
97 |
98 |
99 | Filters to apply to the search.
100 | <>
101 |
102 | The ID of the user to filter by.
103 |
104 |
105 |
106 |
107 |
109 | The registrations that match the search.
110 | <>
111 |
114 |
115 | A cursor for pagination across multiple pages of results. If this attribute is present, there are more results available. Use this value in the
117 |
118 |
84 | Search for registrations. A maximum of 100 results will be returned per request. If additional results are available, they can be retrieved using the nextPage parameter from the previous response.
85 |
Authentication
87 |
88 | Service Integration with
90 |
91 | registration:read scope.
89 | Request
92 |nextPage parameter from the previous response for each subsequent request.
94 | Response
108 |nextPage parameter for the next request.
116 |
119 |
120 | {`{
121 | "nextPage": "eyBsYXN0SWQ6IDEwMDAgfQ==",
122 | "limit": 100,
123 | "filter": {
124 | "userIds": ["1", "2", "3"],
125 | },
126 | }`}
127 |
128 |
129 | {`{
130 | "data": [
131 | {
132 | "createdAt": "2022-02-23T00:30:47.468Z",
133 | "updatedAt": "2022-09-21T01:04:51.456Z",
134 | "badgeName": "Joe",
135 | "status": "paid",
136 | "productName": "Patron",
137 | "productDisplayName": null,
138 | "productId": "172",
139 | "options": [
140 | {
141 | "name": "Species",
142 | "type": "text",
143 | "value": "Mega Bunny"
144 | },
145 | {
146 | "name": "Shirt Size",
147 | "type": "select",
148 | "value": "M"
149 | }
150 | ],
151 | "flags": [
152 | {
153 | "id": "1",
154 | "shortName": "fursuits"
155 | }
156 | ],
157 | "user": {
158 | "id": "1234",
159 | "firstName": "John",
160 | "lastName": "Doe",
161 | "username": "jdoe",
162 | "preferredName": "Johnny",
163 | "phone": "+15555555555",
164 | "email": "johnny.test@concat.systems"
165 | }
166 | },
167 | ],
168 | "nextPage": null
169 | }`}
170 |
171 |
172 |
11 | This object represents an end-user within an event organization. Users can be attendees, vendors, performers, staff, etc.
12 |
13 |
23 |
30 | The ID of the user, represented as a string.
31 |
32 |
33 | The date the user was born, in ISO 8601 format.
34 |
35 |
36 | The user's legal first name, as it appears on their ID.
37 |
38 |
39 | The ID of the user.
40 |
41 |
42 | The user's legal last name, as it appears on their ID.
43 |
44 |
45 | Whether the user has opted in to the newsletter.
46 |
47 |
48 | An optional preferred name for the user. This will be displayed first on the user's profile.
49 |
50 |
51 | The user's username.
52 |
53 |
54 | Returns true if the user has verified their email.
55 |
56 |
57 | Returns true if the user has verified their identity.
58 |
59 |
60 | Returns true if the user is an assigned volunteer.
61 |
62 |
63 | The permissions granted to the user.
64 |
65 |
66 | Publicly accessible URL to the user's profile picture.
67 |
68 |
69 | Returns true if the user is assigned as the lead of a department.
70 |
71 |
101 | Authentication
24 |
25 | On Behalf Of (OBO) with
27 |
28 | pii:basic scope. Other permissions are required to access additional information, such as PII and order history.
26 | Response
29 |
72 |
100 | Scope Restricted Attributes
73 |
74 |
75 | City, town, or village of the user's address.
76 |
77 |
78 | Two-letter ISO 3166-1 alpha-2 country code.
79 |
80 |
81 | First line of the user's address. (e.g. 1234 Main St)
82 |
83 |
84 | Optional second line of the user's address. (e.g. Suite 100, Apt 2B)
85 |
86 |
87 | State or province of the user's address.
88 |
89 |
90 | ZIP or postal code of the user's address.
91 |
92 |
93 | The user's email address.
94 |
95 |
96 | Phone number in international format. (e.g. +15555555555)
97 |
98 |
99 |
102 |
103 | {`curl https://reg.cces.dev/api/users/current \\
104 | -H "Authorization: Bearer "`}
105 |
106 |
107 | {`{
108 | "sub": "1234",
109 | "addressCity": "New York",
110 | "addressCountry": "US",
111 | "addressLine1": "123 Main St",
112 | "addressLine2": "Suite 100",
113 | "addressState": "NY",
114 | "addressZipcode": "10001",
115 | "bornAt": "1990-01-01T00:00:00.000Z",
116 | "email": "aperson@example.com",
117 | "firstName": "John",
118 | "id": 1234,
119 | "lastName": "Doe",
120 | "newsletter": true,
121 | "phone": "+15555555555",
122 | "preferredName": "Jonathan",
123 | "username": "aperson",
124 | "emailVerified": true,
125 | "identityVerified": true,
126 | "isVolunteer": true,
127 | "permissions": [],
128 | "profilePictureUrl": "https://www.gravatar.com/avatar/example",
129 | "isDepartmentLead": false
130 | }`}
131 |
132 |
133 | -
13 |
- 14 | 15 | Navigate to your event website, then click "Housekeeping" from the left-hand sidebar. 16 | 17 | 18 |
- 19 | 20 | Click "Products" from the left-hand sidebar, then click "View Products" next to the category you want to create the product in. 21 | 22 | 23 |
- 24 | Click "Create New Product". 25 | 26 |
-
27 | 28 | Enter basic information for your Product: 29 |50 |
-
30 |
- 31 | Name - This is the name of your Product (like "T-Shirt" or "Bobblehead"). If you'd like to use a different name externally, you can do so in the "Display Name" field. 32 | 33 |
- 34 | Description - A brief description of the product and its functionality. 35 | 36 |
- 37 | Base Price - The price that will be charged for this product, before any add-ons or discounts are applied. 38 | 39 |
- 40 | Stock Control - Whether or not you want to control the number of this product that can be purchased. This is useful for physical products where you have a fixed inventory available. 41 | 42 |
- 43 | Pass Platform Fee to Customer - By default, our platform fees are absorbed into the cost of each product and are paid by the event, but as the organizer, you can choose to pass these fees to your attendees. 44 | 45 |
- 46 | Make Product Publicly Visible - By default, your new product will not be shown in the Event Store, but you can make it visible by checking this box. This can be used for special products you don't want available for direct purchase, such as promotional items for higher tier Attendance Types. 47 | 48 |
51 | -
52 | 53 | (Optional) Customize advanced options: 54 |75 |
-
55 |
- 56 | Available From - The date that this product will be available for purchase. 57 | 58 |
- 59 | Available Until - The date that this product will no longer be available for purchase. 60 | 61 |
- 62 | Minimum Purchase Age - The minimum age that attendees must be to purchase this product. 63 | 64 |
- 65 | Maximum Purchase Age - The maximum age that attendees can be to purchase this product. 66 | 67 |
- 68 | Restrict Product to User Roles - Only users with the specified role(s) can purchase this product. 69 | 70 |
- 71 | Restrict Product to Grants - Only users that have already purchased and have a grant for the specified product(s) can purchase this product. 72 | 73 |
76 | - 77 | Click "Create Product", and your Product will be created! 78 | 79 |
-
80 | 81 | (Optional) Customize your Product: 82 | 83 |101 |
84 | 100 |85 | Adding a product image is a great way to show your attendees how awesome your product looks. 86 | 87 |88 | Addons are other products that are offered alongside as an additional purchase, or are included for free, with the product. 89 | 90 |91 | Discounted pricing can be available for a set period of time, or to a specific user role (such as Staff or Volunteers). 92 | 93 |94 | Product Options enable you to add custom fields (required or optional) for your attendees to fill out when they purchase the product (such as "T-Shirt Size", "Company Name", or "Extra Donation"). 95 | 96 |97 | Surcharges are additional fees that are added to the base price of the product as either a flat fee or a percentage of the base price. 98 | 99 |
102 |
-
113 |
- 114 | Navigate to your event website, then click "Housekeeping" from the left-hand sidebar. 115 | 116 |
- 117 | Click "Products" from the left-hand sidebar, then click "View Products" next to the category that contains the product you want to edit. 118 | 119 |
- 120 | Click on "View / Edit Details" for the Product you'd like to modify. 121 | 122 |
- 123 | 124 | Click the edit (edit) icon in 125 | the Product Information section of the product. 126 | 127 | 128 |
- 129 | Updated the details you'd like to change, and click "Update Product". 130 | 131 |
-
15 |
- 16 | 17 | Navigate to your event website, then click "Housekeeping" from the left-hand sidebar. 18 | 19 | 20 |
- 21 | 22 | Click "Settings" from the left-hand sidebar, then click the "Email Templates" tab. 23 | 24 | 25 |
-
30 |
- 31 | 32 | Default - The email template is not being overridden, and is using the default ConCat provided template. 33 | 34 | 35 |
- 36 | 37 | Overridden - The email template is being overridden by a custom template. 38 | 39 | 40 |
- 41 | 42 | Disabled - The email template is disabled and will not be sent. 43 | 44 | 45 |
-
58 |
- 59 | 60 | Convention overrides are applied solely to this current convention. This will not persist to the next year or any other conventions within your organization. 61 | 62 | 63 |
- 64 | 65 | Organization overrides are applied to the entire organization, and will persist throughout all conventions. 66 | 67 | 68 |
80 |
83 | Let's take a look at an example. At my convention, I want volunteers to join a Telegram group. I created a redirect on my marketing domain for `/volunteertg` to the group, and now I want to make sure that everyone that applied to volunteer gets the link.
81 |When I navigate to my list of templates, I find the one I want to modify. volunteerConfirm seems good to me.
84 | 
89 |
93 | In the overview you're able to view the default template and any overrides. The green "Active" tag will be shown next to whichever will be sent out to users. Right now, that's the default template. I only want this template to apply for this convention, so I'm going to select "Create Override" next to Convention Level Override.
94 | I start with the default template and can modify it as I please. A preview is automatically generated below, and the variables available for you to use are provided on the right.
95 |
96 | 
97 | 
104 | 107 |
108 |
109 | ### Variables
110 |
111 |
112 |
120 |
121 | ### Errors
122 |
123 | While editing, you may see errors come up. These are to ensure you're not including variables that don't exist, and that your template isn't broken. You cannot submit templates that contain errors.
124 |
125 | #### Missing Variables
126 |
113 | The power of Handlebars comes from the variables. We provide a list of the available variables for that particular template and their type.
114 | You access these via bracket statements, with dots to access inner variables. For example, to access the convention's long name from above, I would write
116 | {{convention.name.long}}. Convention and User information is available for all templates, and additional variables are available as necessary.
115 |
117 | 
118 |
119 |
118 | 
129 |
134 | Something went wrong when the server tried to parse your template. Please read the error message and check the offending element. It's likely you left an open bracket (
136 | {{) or something of the sort.
135 | 
137 |
147 |
150 | Convention overrides always take priority, then any set at the organization level, and finally if there are none present the default is chosen.
148 |For clarity, the active configuration is always highlighted as "Current" in the template's overview screen.
149 |
151 |
13 | This object represents a volunteer application within a convention.
14 |
15 |
25 |
33 | A cursor for pagination across multiple pages of results. Don't include this attribute on the first call. Use the
35 |
36 | The maximum number of results to return, between 1 and 100. Defaults to 100.
37 |
38 |
39 |
42 | Paginate through the volunteer list.
26 |Authentication
27 |
28 | Service Integration with
30 |
31 | volunteer:read scope.
29 | Request
32 |nextPage parameter from the previous response for each subsequent request.
34 | Response
40 |
43 |
44 | {`{
45 | "nextPage": "eyBsYXN0SWQ6IDEwMDAgfQ==",
46 | "limit": 100,
47 | }`}
48 |
49 |
50 | {`{
51 | "data": [
52 | {
53 | "createdAt": "2020-01-01T00:00:00Z",
54 | "updatedAt": "2020-01-01T00:00:00Z",
55 | "contactMethods": [
56 | {
57 | "name": "discord",
58 | "isPrimary": true,
59 | "value": "Username#1234"
60 | },
61 | ],
62 | "departments": [
63 | {
64 | "id": "1234",
65 | "states": ["experience", "interest"],
66 | "name": "Registration"
67 | },
68 | ],
69 | "user": {
70 | "id": "1234",
71 | "firstName": "John",
72 | "lastName": "Doe",
73 | "username": "jdoe",
74 | "preferredName": "Johnny",
75 | "phone": "+15555555555",
76 | "email": "johnny.test@concat.systems",
77 | },
78 | "options": [
79 | {
80 | "name": "jump",
81 | "type": "select",
82 | "value": "How high?"
83 | },
84 | ],
85 | },
86 | ],
87 | "nextPage": null,
88 | }`}
89 |
90 |
91 |
96 |
105 | Returns the volunteer object for the specified user.
97 |Authentication
98 |
99 | Service Integration with
101 |
102 | volunteer:read scope.
100 | Response
103 |
106 |
107 | {`curl https://reg.cces.dev/api/v0/users/{id}/volunteer \\
108 | -H "Authorization: Bearer "`}
109 |
110 |
111 | {`{
112 | "createdAt": "2020-01-01T00:00:00Z",
113 | "updatedAt": "2020-01-01T00:00:00Z",
114 | "contactMethods": [
115 | {
116 | "name": "discord",
117 | "isPrimary": true,
118 | "value": "Username#1234"
119 | },
120 | ],
121 | "departments": [
122 | {
123 | "id": "1234",
124 | "states": ["experience", "interest"],
125 | "name": "Registration"
126 | },
127 | {
128 | "id": "5678",
129 | "states": ["avoid"],
130 | "name": "HR"
131 | }
132 | ],
133 | "user": {
134 | "id": "1234",
135 | "firstName": "John",
136 | "lastName": "Doe",
137 | "username": "jdoe",
138 | "preferredName": "Johnny",
139 | "phone": "+15555555555",
140 | "email": "johnny.test@concat.systems",
141 | },
142 | "options": [
143 | {
144 | "name": "jump",
145 | "type": "select",
146 | "value": "How high?"
147 | },
148 | ]
149 | }`}
150 |
151 |
152 |
157 |
165 | The unique identifier of the department record.
166 |
167 |
168 | The date the volunteer record was created.
169 |
170 |
171 | The date the volunteer record was last updated.
172 |
173 |
174 | Department is publicly visible to all users applying for a position.
175 |
176 |
177 | List of users who are assigned as leads for this department
178 | <>
179 |
180 | The unique identifier of the user.
181 |
182 |
183 | The first name of the user.
184 |
185 |
186 | The last name of the user.
187 |
188 |
189 | The username of the user.
190 |
191 |
192 | The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
193 |
194 |
195 | The phone number of the user in E.164 format.
196 |
197 |
198 | The email address of the user.
199 |
200 |
201 |
202 |
203 | Returns the list of volunteer departments.
158 |Authentication
159 |
160 | Service Integration with
162 |
163 | volunteer:read scope.
161 | Response
164 |
204 |
205 | {`curl https://reg.cces.dev/api/v0/volunteers/departments \\
206 | -H "Authorization: Bearer "`}
207 |
208 |
209 | {`[
210 | {
211 | "id": "1",
212 | "email": "support@concat.org",
213 | "name": "Information Technology",
214 | "publiclyVisible": true,
215 | "leads": [
216 | {
217 | "id": "1234",
218 | "firstName": "Bob",
219 | "lastName": "Smith",
220 | "username": "bobsmith",
221 | "preferredName": "Sphere",
222 | "phone": "+11112223333",
223 | "email": "bob@concat.org"
224 | }
225 | ]
226 | }
227 | ]`}
228 |
229 |
230 | DMCA Takedown Policy
16 |
17 | Effective date: July 14, 2022
18 |
19 | 20 | Convention Cat Event Systems, Inc. ("ConCat") respects the intellectual property rights of others 21 | and expects the same from all users of its services. 22 |
23 | 24 |25 | Title II of the Digital Millennium Copyright Act, 17 U.S.C. Section 512(c)(3) provides for the 26 | right of the copyright owner to notify and inform ConCat of alleged copyright infringement by its users, 27 | and outlines the required elements of a valid DMCA notification. 28 |
29 | 30 |Designated Agent
31 |32 | Notification of alleged infringement should be sent to our Designated Agent, using one of the following 33 | methods (in order of expedience): 34 |
35 |-
36 |
- By Email: dmca@concat.systems 37 |
-
38 |
39 | By Mail:
45 |
40 | Attn: DMCA Compliance Agent
41 | Convention Cat Event Systems, Inc.
42 | 270 S 171st
43 | Burien, WA 98148 44 |46 | 47 | 48 | We strongly recommend that DMCA notices sent by mail are sent via Certified Mail, 49 | with Return Receipt Requested. 50 | 51 | 52 |
53 |
54 |
56 | A copy of this Designated Agent Information can be retrieved from the US Copyright Office 57 | DMCA Designated Agent Directory website. 58 |
59 |DMCA Handling Process
60 |-
61 |
-
62 |
ConCat Receives Notice and Removes Content
63 |64 | Assuming ConCat has received a valid DMCA notice, ConCat will acknowledge the notice within 24 hours 65 | and will forward a copy of the notice to the reported user(s). 66 |
67 |68 | ConCat will subsequently disable access to the allegedly infringing content outlined in the DMCA notice. 69 |
70 |71 | If the notice omits any of the required information under the DMCA, ConCat will send a rejection notice 72 | to both parties stating the omitted information and requesting the Copyright Owner submit a new notice. 73 |
74 |
75 | -
76 |
Reported User May Send A Counter Notification
77 |78 | 79 | We strongly recommend users consult with a lawyer about their options before filing a counter 80 | notification. 81 | 82 |
83 |84 | ConCat will review the counter notification and, if it is deemed sufficiently detailed, will forward 85 | it to the Copyright Owner. 86 |
87 |88 | If there is no response from the Copyright Owner within ten (10) business days of the receipt of the 89 | counter notification, ConCat will restore access to the reported content. 90 |
91 |
92 | -
93 |
Copyright Owner May File Legal Action
94 |95 | If upon the receipt of a counter notification, the Copyright Owner wishes to keep the content 96 | disabled, they will need to initiate a legal action seeking a court order to restrain the user 97 | from engaging in infringing activity relating to content on ConCat. 98 |
99 |
100 | -
101 |
No Counter Notification is Received
102 |103 | If a counter notification is not received within ten (10) business days of the receipt of the 104 | original DMCA notice, ConCat will permanently delete the allegedly infringing content. 105 |
106 |
107 | -
108 |
Reported User May Be Suspended
109 |110 | ConCat may, in appropriate circumstances, suspend or terminate a user's access to ConCat services 111 | in the event of repeated infringement of copyright or other intellectual property rights. 112 |
113 |
114 |
DMCA Notice Requirements
116 |117 | As outlined in 17 U.S.C. Section 512(c)(3), in order to be effective a notice of claimed 118 | infringement must include the following: 119 |
120 |-
121 |
- A description or link to the copyrighted work that has allegedly been infringed. 122 |
- A description of the material you claim is infringing and, if possible, a link to that material. 123 |
- Your legal name, title (if acting as an agent), address, telephone number, and email address. 124 |
- 125 | The following statement: 126 | 127 | "I have a good faith belief that use of the copyrighted materials described in this notice as 128 | allegedly infringing is not authorized by the copyright owner, its agent, or the law. I have 129 | taken fair use into consideration." 130 | 131 | 132 |
- 133 | The following statement: 134 | 135 | "I swear, under penalty of perjury, that the information in this notification is accurate and 136 | that I am authorized to act on behalf of the owner of a right that is allegedly infringed" 137 | 138 | 139 |
- 140 | A physical or digital signature of the owner, or a person authorized to act on behalf of the owner, 141 | of the copyright or of an exclusive right that is allegedly infringed. 142 | 143 |
145 | We will review your notice will take the actions outlined above as we deem appropriate under the DMCA. 146 |
147 |DMCA Counter Notification Requirements
148 |150 | ConCat strongly recommends that you consult with a lawyer about your specific case and options before 151 | taking any action that might impact your rights. 152 |
153 |154 | This guide is not legal advice and shouldn't be taken as such. 155 |
156 |158 | If you are unable to come to an agreement with the copyright owner, or believe that your content has 159 | been disabled in error, you can submit a counter notification within ten (10) business days of the 160 | original notice with the following information: 161 |
162 |-
163 |
- Your legal name, title (if acting as an agent), address, telephone number, and email address. 164 |
- A description or link to the content to which access has been disabled and the location where it appeared. 165 |
- 166 | The following statement: 167 | 168 | "I swear, under penalty of perjury, that I have a good faith belief that the content was disabled 169 | as a result of a mistake or misidentification of the content to be disabled." 170 | 171 | 172 |
-
173 | One of the following statements (as appropriate):
174 |
-
175 |
- 176 | If within the United States, 177 | 178 | "I consent to the jurisdiction of the Federal District Court for the judicial district in 179 | which my provided address is located." 180 | 181 | 182 |
- 183 | If outside the United States, 184 | 185 | "I consent to the jurisdiction of the Federal District Court for the District of Delaware 186 | in which Convention Cat Event Systems, Inc. is located." 187 | 188 | 189 |
191 | - 192 | The following statement: 193 | 194 | "I will accept service of process from the person who provided the original notification or 195 | an agent of such person." 196 | 197 | 198 |
- Your physical or digital signature. 199 |
11 | This object represents an end-user within an event organization. Users can be attendees, vendors, performers, staff, etc.
12 |
13 |
23 |
33 | The unique identifier of the user.
34 |
35 |
36 | The email address of the user.
37 |
38 |
39 | The preferred name of the user. If provided, this should be used instead of the first and ast name, except where legally required.
40 |
41 |
42 | The first name of the user.
43 |
44 |
45 | The last name of the user.
46 |
47 |
48 | The username of the user.
49 |
50 |
51 | Whether the user has verified their email address.
52 |
53 |
54 | The phone number of the user in E.164 format.
55 |
56 |
57 | The address of the user. If PII is not required to register, the child attributes will be
60 | The city of the address.
61 |
62 |
63 | The two-letter country code of the address.
64 |
65 |
66 | The first line of the address.
67 |
68 |
69 | The second line of the address, such as an apartment number, if applicable.
70 |
71 |
72 | The state or province of the address.
73 |
74 |
75 | The ZIP or postal code of the address.
76 |
77 |
78 |
79 |
80 |
24 | Search for users using a variety of filters. A maximum of 100 results will be returned per request. If additional results are available, they can be retrieved using the nextPage parameter from the previous response.
25 |
Authentication
27 |
28 | Service Integration with
30 |
31 | user:read scope.
29 | Response
32 |null.
58 | <>
59 |
81 |
82 | {`{
83 | "id": "1234",
84 | "email": "johnny.test@concat.systems",
85 | "preferredName": "JT",
86 | "firstName": "John",
87 | "lastName": "Test",
88 | "username": "jtest",
89 | "verified": true,
90 | "phone": "+15555555555",
91 | "address": {
92 | "addressCity": "San Francisco",
93 | "addressCountry": "US",
94 | "addressLine1": "123 Main St",
95 | "addressLine2": "Apt 1",
96 | "addressState": "CA",
97 | "addressZipcode": "94105"
98 | }
99 | }`}
100 |
101 |
102 |
109 |
119 | A cursor for pagination across multiple pages of results. Don't include this attribute on the first call. Use the
121 |
122 | The maximum number of results to return, between 1 and 100. Defaults to 100.
123 |
124 |
125 | Filters to apply to the search.
126 | <>
127 |
128 | The ID of the role to filter by.
129 |
130 |
131 |
132 |
133 |
135 | The users that match the search.
136 | <>
137 |
138 | The unique identifier of the user.
139 |
140 |
141 | The email address of the user.
142 |
143 |
144 | The preferred name of the user. If provided, this should be used instead of the first and ast name, except where legally required.
145 |
146 |
147 | The first name of the user.
148 |
149 |
150 | The last name of the user.
151 |
152 |
153 | The username of the user.
154 |
155 |
156 | Whether the user has verified their email address.
157 |
158 |
159 | The phone number of the user in E.164 format.
160 |
161 |
162 | The address of the user. If PII is not required to register, the child attributes will be
165 | The city of the address.
166 |
167 |
168 | The two-letter country code of the address.
169 |
170 |
171 | The first line of the address.
172 |
173 |
174 | The second line of the address, such as an apartment number, if applicable.
175 |
176 |
177 | The state or province of the address.
178 |
179 |
180 | The ZIP or postal code of the address.
181 |
182 |
183 |
184 |
185 |
186 |
187 | A cursor for pagination across multiple pages of results. If this attribute is present, there are more results available. Use this value in the
189 |
190 |
110 | Search for users using a variety of filters. A maximum of 100 results will be returned per request. If additional results are available, they can be retrieved using the nextPage parameter from the previous response.
111 |
Authentication
113 |
114 | Service Integration with
116 |
117 | user:read scope.
115 | Request
118 |nextPage parameter from the previous response for each subsequent request.
120 | Response
134 |null.
163 | <>
164 | nextPage parameter for the next request.
188 |
191 |
192 | {`{
193 | "nextPage": "eyBsYXN0SWQ6IDEwMDAgfQ==",
194 | "limit": 100,
195 | "filter": {
196 | "roleId": 12,
197 | },
198 | }`}
199 |
200 |
201 | {`{
202 | "data": [
203 | {
204 | "id": "1234",
205 | "email": "johnny.test@concat.systems",
206 | "preferredName": "JT",
207 | "firstName": "John",
208 | "lastName": "Test",
209 | "username": "jtest",
210 | "verified": true,
211 | "phone": "+15555555555",
212 | "address": {
213 | "addressCity": "San Francisco",
214 | "addressCountry": "US",
215 | "addressLine1": "123 Main St",
216 | "addressLine2": "Apt 1",
217 | "addressState": "CA",
218 | "addressZipcode": "94105"
219 | },
220 | },
221 | ],
222 | "nextPage": null
223 | }`}
224 |
225 |
226 |
24 |
25 | The client ID that identifies your application.
26 |
27 |
28 | The type of response that you want ConCat to return. The only supported value is "code".
29 |
30 |
31 | The URL that ConCat will redirect to after authorization. This must be the same URL that you provided when registering your application, otherwise the user will receive an invalid request error.
32 |
33 |
34 | The scope(s) that you want to request access to. This must be a URL-encoded list of scopes, separated by spaces.
35 |
36 |
37 | An optional string that ConCat will return with the authorization response. This string can be used to verify that the request originated from your application.
38 |
39 |
40 |
41 | An example authorization URL will look something like this:
42 |
43 |
50 |
65 |
66 | :::caution
67 | The user must have access to all of the requested scopes in order to grant access. If the user does not have access to all of the requested scopes, they will receive an invalid request error.
68 | :::
69 |
70 | #### Sensitive Scopes
71 |
72 | Sensitive scopes are scopes that allow access to administrative endpoints or provide access to information of other users. These scopes should be requested with care and limited to only the scopes required to provide the desired functionality.
73 |
74 | When a user is presented with a consent screen, sensitive scopes will be highlighted in red along with the text: `This is an administrative permission`. The `Authorize Application` button will also be highlighted red.
75 |
76 |
51 |
61 | 52 | Once you've generated the authorization URL, you'll need to redirect the user to ConCat. 53 |
54 |
55 | This can be done via a HTTP or JavaScript redirect, by presenting the link to the user as a button or a hyperlink, or in a pop-up window. The authorization page must never be displayed in an iframe.
56 |
58 | ConCat will display a consent screen to the user. This screen will include a description of your application, and a list of requested permissions. The user can then either grant or deny access. At this time, the user cannot partially grant access to certain scopes. 59 |
60 |
62 | 
63 |
64 |
63 | 
77 |
78 |
79 |
80 | :::danger
81 | Abuse or misuse of sensitive scopes will result in your application being suspended. If a bearer or refresh token with a sensitive scope is lost or compromised, contact ConCat Support **immediately** for assistance.
82 | :::
83 |
84 | ### Step 3. Exchanging for Token
85 |
86 | The user will be redirected back to your application's `redirect_uri` with query parameters containing a `code` and optional `state` attribute. You can use this code to exchange it for a bearer token and a refresh token.
87 |
88 |
93 |
124 |
125 | :::caution
126 | If your app no longer requires access to all of the scopes originally requested, you can provide a subset of scopes in the `scope` parameter when refreshing the token. However, no additional scopes can be granted this way, and any scopes removed cannot be re-added later without a new authorization request.
127 | :::
128 |
129 | ### Step 4. Refreshing the Token
130 |
131 |
94 |
101 | 95 | This code can be exchanged for a bearer token and a refresh token. The bearer token will expire after a set amount of time, but the refresh token will never expire until used or the user revokes access. 96 |
97 |98 | The response will return an access token, the length of time until the token expires, the valid scopes, and a refresh token. The refresh token can be used to obtain a new bearer token once the old one expires. 99 |
100 |
102 |
103 | {`curl https://reg.mybigevent.org/api/oauth/token \\
104 | -X POST \\
105 | -H "Content-Type: application/x-www-form-urlencoded" \\
106 | -d "client_id=123" \\
107 | -d "client_secret=abc" \\
108 | -d "code=123" \\
109 | -d "grant_type=authorization_code" \\
110 | -d "redirect_uri=https%3A%2F%2Fexample.com%2Foauth%2Fcallback" \\
111 | -d "scope=pii%3Abasic"`}
112 |
113 |
114 | {`{
115 | "access_token": "...",
116 | "expires_in": 3600,
117 | "scope": "pii:basic",
118 | "refresh_token": "...",
119 | "token_type": "Bearer",
120 | }`}
121 |
122 |
123 |
132 |
165 |
166 | ### Step 5. Authenticating with the Token
167 |
168 | All requests to the ConCat APIs **must** be done through a HTTPS connection, with a minimum TLS protocol of v1.2 or newer. ConCat uses a HTTP Authorization header to authenticate API requests. The Authorization header must be in the following format:
169 |
170 | ```
171 | Authorization: Bearer
133 |
143 | 134 | If the bearer token expires, you can use the refresh token to obtain a new bearer token. A refresh token will not expire until used or the user revokes access. 135 |
136 |
137 | The scope parameter is optional, but if you provide it, you must provide a subset of the scopes originally requested. This can be used to remove scopes that are no longer required by your application for security. If scope is not provided, the scopes valid for the previous bearer token will be used.
138 |
140 | The response will return an access token, the length of time until the token expires, the valid scopes, and a new refresh token. The refresh token can be used to obtain a new bearer token once the old one expires. 141 |
142 |
144 |
145 | {`curl https://reg.mybigevent.org/api/oauth/token \\
146 | -X POST \\
147 | -H "Content-Type: application/x-www-form-urlencoded" \\
148 | -d "client_id=123" \\
149 | -d "client_secret=abc" \\
150 | -d "refresh_token=123" \\
151 | -d "grant_type=refresh_token" \\
152 | -d "redirect_uri=https%3A%2F%2Fexample.com%2Foauth%2Fcallback"`}
153 |
154 |
155 | {`{
156 | "access_token": "...",
157 | "expires_in": 3600,
158 | "scope": "pii:basic",
159 | "refresh_token": "...",
160 | "token_type": "Bearer",
161 | }`}
162 |
163 |
164 |
186 |
193 | Attempting to request OBO-only scopes will result in an error.
194 |
195 |
196 | 187 | To receive an access token, the application can exchange its ID and secret for a limited-time bearer token. The bearer token will expire after a set amount of time and must be re-requested using this flow when it expires. 188 |
189 |190 | The response will return an access token, the length of time until the token expires, and the valid scopes. In order to change the scopes of the token, a new token must be requested with the updated scopes. 191 |
192 |
197 |
198 | {`curl https://reg.mybigevent.org/api/oauth/token \\
199 | -X POST \\
200 | -H "Content-Type: application/x-www-form-urlencoded" \\
201 | -d "client_id=123" \\
202 | -d "client_secret=abc" \\
203 | -d "grant_type=client_credentials" \\
204 | -d "scope=user%3Aread"`}
205 |
206 |
207 | {`{
208 | "access_token": "...",
209 | "expires_in": 3600,
210 | "scope": "user:read",
211 | "token_type": "Bearer",
212 | }`}
213 |
214 |
215 |