Sponsor

A Sponsor is an Exhibitor who has purchased or been granted a Sponsorship. You must have the exhibitors ConventionPrivilege to manage this. Sponsors are accessed via /api/sponsor.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in SponsorProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

convention

The Convention this sponsor belongs to.

sponsorship

The Sponsorship purchased by this sponsor.

exhibitor

The Exhibitor who is the sponsor.

Relationships

See "Relationships" in Introduction for how to use them.

badges

Badges which were complimentary with the sponsor's Sponsorship.

Services

The services used to fetch and manipulate sponsors.

Search Sponsors

This will search across all conventions. To search on a single convention see "Relationships" in Convention.

 GET /api/sponsor

Optional Params

query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "sponsorship_id" : "xxx",
          "exhibitor_id" : "xxx",
          ...
        },
        ...
    ]
 }

Create Sponsor

 POST /api/sponsor

Required Params

convention_id

name

Returns the same as a normal read.

Read Sponsor

 GET /api/sponsor/xxx

Returns:

 {
   "id" : "xxx",
   "sponsorship_id" : "xxx",
   "exhibitor_id" : "xxx",
   ...
 }

Update Sponsor

 PUT /api/sponsor/xxx

Returns the same as a normal read.

Delete Sponsor

 DELETE /api/sponsor/xxx

Optional params

cashdrawer_id

You need to specify this to refund if purchased with cash.

Returns:

 {
   "success" : 1
 }

Administratively Create Sponsor

This will create a sponsor that is fully verified. You must have the registration ConventionPrivilege to do this.

 POST /api/sponsor/verified

Required Params

Same as a normal sponsor creation.

Returns the same as a normal read.

Get Complimentary SoldProducts (Merch)

 GET /api/sponsor/:id/soldproducts/complimentary

The list of SoldProducts that were complimentary with the Badges that were complimentary with the sponsor's Sponsorship.

Returns:

 {
   "paging" : {...},
   "items" : [
     {
       "id" : "xxx",
       "productvariant_id" : "xxx",
       "picked_up" : 1,
       ...
     },
     ...
   ]
 }

Convert Sponsor to Free

This refunds a charge for a sponsor without deleting it. Use of this endpoint requires the exhibitors privilege.

 PUT /api/sponsor/xxx/convert/free

Returns the same as a normal read.

Convert Sponsor

Convert a sponsor purchase to a different Sponsorship. This will charge or refund the difference in the costs. This cannot be used for organizer-granted sponsors.

 POST /api/sponsor/xxx/convert/sponsorship/:sponsorship_id

Required Params

sponsorship_id

The ID of the Sponsorship to convert the sponsor to.

Returns a normal read of the sponsor converted to.