List 

GET /v2/b2b/event/template

List all event templates.

Input

  • startTime: Optional, ISO8601 string, Only returns templates that were running after this time period.  Event Templates could have started before this time but ended after the start time.
  • endTime: Optional, ISO8601 string, Only returns template that that were running before this time period.  Event Templates could have ended after this time but started before this time.
    • If you provide a start time of March 10th and an end Time of March 20th then the resulting list will include any templates that were active during that period of time.  
      • Including
        • A template that started March 3rd and ended March 10th.
        • A template that started March 20th and ended March 31st.
        • A template that started March 3rd and ended March 31st.
      • Not Including
        • A template that started March 3rd and ended March 9th:  Because it ended before the start time.
        • A template that started March 21st and ended March 31st:  Because it started before the end time.
  • type: Optional, one of (standard, private or all)  If left off or not present then private templates will not be returned.

Returns

an array of Event Template Objects

Example

curl https://sandx-api.acmeticketing.com/v2/b2b/event/template -H "x-acme-api-key:[API-KEY]"


Get 

GET /v2/b2b/event/templates/{id}

Get the specified event template.

Input

id:  The id of the event template you want to retrieve.

Returns

the Event Template Object associated with id.

Example

curl https://sandx-api.acmeticketing.com/v2/b2b/event/template/{eventTemplateId} -H "x-acme-api-key:[API-KEY]"


Create 

POST /v2/b2b/event/template

Create a new event template.

Body

An Event Template Object

Returns

The id of the newly created Event Template.

Example

curl "https://sandx-api.acmeticketing.com/v2/b2b/event/template" -d@create.json -H "x-acme-api-key:[API-KEY]" -H "Content-Type:Application/JSON"


create.json
{
    "name": "Artwork of the Tang Dynasty Tour",
    "description": "Paintings, sculptures, calligraphy and literature from China's Golden Age of Literature and Art",
    "duration":  {
        "hour" : 1,
        "minutes" : 15
    },
    "capacity" : 25
}


Update 

PUT /v2/b2b/event/template/{id}

Update the specified event template

Body

An Event Template Object

Input

id:  The id of the template to update.

Returns

The resulting Event Template Object after the update is complete.

Example

curl --upload-file update.json "https://sandx-api.acmeticketing.com/v2/b2b/event/template/{eventTemplateId}" -H "x-acme-api-key:[API-KEY]" -H "Content-Type:Application/JSON"


Where update.json is the code block below.

NOTE:  You must pass the id in the body

update.json
 {
    "id" : "[EventTemplateId]",
    "name": "Artwork of the Tang Dynasty Tour",
    "description": "Paintings, sculptures, calligraphy and literature from China's Golden Age of Literature and Art",
    "shortDescription": "Artwork from China's Golden Age of Literature and Art",
    "duration":  {
        "hour" : 1,
        "minutes" : 15
    },
    "capacity" : 25,
    "schedules": [
        {
            "description": "Scheduled  every day   once  at 10:00 AM",
            "effectiveStartTime": "2014-12-01T15:19:00-08:00",
            "hours": [
                {
                    "hour": 10,
                    "minutes": 0,
                    "quantity": 1
                }
            ],
            "id": "59c923d1-41ff-4398-a97b-b2def195e556",
            "name": "10AM Schedule",
            "salesChannels": [
                {
                    "channel": "online",
                    "enabled": true,
                    "name": "Web"
                },
                {
                    "channel": "customerRep",
                    "enabled": true,
                    "name": "Customer Rep"
                },
                {
                    "channel": "pointOfSale",
                    "enabled": true,
                    "name": "Point of Sale"
                },
                {
                    "channel": "manualEntry",
                    "enabled": true,
                    "name": "Manual Entry"
                },
                {
                    "channel": "reseller",
                    "enabled": false,
                    "name": "Reseller"
                }
            ],
            "weekdays": [
                "M",
                "Tu",
                "W",
                "Th",
                "F",
                "Sa",
                "Su"
            ]
        },
        {
            "description": "Scheduled  every day   once  at 11:00 AM",
            "effectiveStartTime": "2014-12-01T15:19:00-08:00",
            "hours": [
                {
                    "hour": 11,
                    "minutes": 0,
                    "quantity": 1
                }
            ],
            "id": "cc9174a2-44d7-45f5-9ad9-122c4bd67859",
            "name": "11 AM",
            "salesChannels": [
                {
                    "channel": "online",
                    "enabled": true,
                    "name": "Web"
                },
                {
                    "channel": "customerRep",
                    "enabled": true,
                    "name": "Customer Rep"
                },
                {
                    "channel": "pointOfSale",
                    "enabled": true,
                    "name": "Point of Sale"
                },
                {
                    "channel": "manualEntry",
                    "enabled": false,
                    "name": "Manual Entry"
                },
                {
                    "channel": "reseller",
                    "enabled": false,
                    "name": "Reseller"
                }
            ],
            "weekdays": [
                "M",
                "Tu",
                "W",
                "Th",
                "F",
                "Sa",
                "Su"
            ]
        }
    ]
}


Delete

DELETE /v2/b2b/event/template/{id}

Delete the specified event template.

Input

id:  The id of the template to update.

Returns

The id of the event template that was deleted.

Example

curl https://sandx-api.acmeticketing.com/v2/b2b/event/template/{eventTemplateId}] -X DELETE -H "x-acme-api-key:[API-KEY]"


Summaries 

GET /v2/b2b/event/template

List your event template summaries.

Parameters

  • startTime: Optional, ISO8601 string, Only returns templates that were running after this time period.  Event Templates could have started before this time but ended after the start time.
  • endTime: Optional, ISO8601 string, Only returns template that that were running before this time period.  Event Templates could have ended after this time but started before this time.
    • If you provide a start time of March 10th and an end Time of March 20th then the resulting list will include any templates that were active during that period of time.  
      • Including
        • A template that started March 3rd and ended March 10th.
        • A template that started March 20th and ended March 31st.
        • A template that started March 3rd and ended March 31st.
      • Not Including
        • A template that started March 3rd and ended March 9th:  Because it ended before the start time.
        • A template that started March 21st and ended March 31st:  Because it started before the end time.
  • type: Optional, one of (standard, private or all)  If left off or not present then private templates will not be returned.

Returns

an array of Event Template Summaries

Example


List Resources 

GET /v2/b2b/event/template/{id}/resources

List the resources on the specified event template.

Returns

the list of resources for the event template with the specified id.


Update Resources

PUT /v2/b2b/event/template/{id}/resources

Update the resources on the specified event template

updates the resources for the event template with the specified id.

Body

A list of Event Resource JSON Objects

Input

id: The id of the event template.

Returns

None


Add A Resource 

POST /v2/b2b/event/template/{id}/resources

Adds a resource to the specified template.

Body

An Event Resource JSON Object

Input

id: The id of the event template.

Returns

None


Get Published Event Template

GET /v2/b2b/event/template/{id}/published

Gets the published event Template.

Input

id: The id of the published event template

Returns

the Event Template Object associated with id.

Schedules


List Schedules

GET /v2/b2b/event/template/{id}/schedules

List the schedules for the specified event template.

Input

id: The id of the event template you want the schedules for.

Returns

The list of Event Schedules for the event template with the specified id.

Example

 curl https://sandx-api.acmeticketing.com/v2/b2b/event/template/{eventTemplateId}/schedules -H "x-acme-api-key:[API-KEY]"


Add a Schedule

POST /v2/b2b/event/template/{id}/schedules

Add a schedule to the specified event template.

Body

An  Event Schedule.

Input

id: The id of the event template

Returns

None


Update multiple Schedule

PUT /v2/b2b/event/template/{id}/schedules

Update a schedule to the specified event template.

Body

A list of Event Schedules for the event template with the specified id.

Input

id: The id of the event template

Returns

None

Prerequisites

 "prerequisites" : {
       "operation" : "allOf",
       "requires" : [
         {
           "eventTemplateId" : "123-456-789",
           "min" : {
              "minutes" : 1
           },
           "max" : {
              "minutes" : 2
           }
         }
       ]
    }

List Prerequisites 

GET /v2/b2b/event/template/{id}/prerequisites

Get the prerequisites for the specified event template.

Input

id: The id of the event template

Returns

A Prerequisites Object


Add a Prerequisite

POST /v2/b2b/event/template/{id}/prerequisites

Add the prerequisites to the specified event template.

Body

A Prerequisites Object.

Input

id: The id of the event template

Returns

The resulting Prerequisites Object


Update Prerequisites    

PUT /v2/b2b/event/template/{id}/prerequisites

Update the prerequisites for the specified event template.

Body

A Prerequisites Object.

Input

id: The id of the event template

Returns

        The resulting Prerequisites Object


Delete all Prerequisites

DELETE /v2/b2b/event/template/{id}/prerequisites

removes all prerequisites for the specified event template.

Input

id: The id of the event template

Returns

None

Recommendations

{
    "recommendations" : [
      {
 
        "eventTemplateId" : "123-456-789",
 
        "min" : {
           "minutes" : 1
        },
        "max" : {
           "minutes" : 2
        }
      }
    ],
    "tags" : [
      "child friendly",
      "Egyptian"
    ]
}

Get a Recommendation

GET /v2/b2b/event/template/{id}/recommendations

Gets the recommendations for the specified event template.

Input

id: The id of the event template

Returns

An Event Recommendations Object.


Add a Recommendation

POST /v2/b2b/event/template/{id}/recommendations

Add a recommendation to the specified event template.

Body

An Event Recommendations Object

Input

id: The id of the event template

Returns

The resulting Event Recommendations Object.


Update a Recommendation

PUT /v2/b2b/event/template/{id}/recommendations

Updates the specified event template to have the provided recommendations

Body

An Event Recommendations Object

Input

id: The id of the event template

Returns

The resulting Event Recommendations Object.


Delete a Recommendation

DELETE /v2/b2b/event/template/{id}/recommendations

removes all recommendations from the specified event template

Input

id: The id of the event template

Returns

The id of the recommendation removed.

Dependents


{
  "dependents" : [
    {
      "eventTemplateId" : "123-456-789",
      "min" : {
        "minutes" : 1
      },
      "max" : {
        "minutes" : 2
      }
    }
  ]
 
}

List Dependents

GET /v2/b2b/event/template/{id}/dependents

Gets the dependents that require the specified template

Input

id: The id of the event template

Returns

An Event Dependents JSON Object.


Add a Dependent

POST /v2/b2b/event/template/{id}/dependents

Add the event template specified by id as a requirement for all events in the Event Dependents JSON Object.

Body

An Event Dependents JSON Object.

Input

id: The id of the event template that you want required for all event templates in the Event Dependents JSON Object.

Returns

The resulting Event Dependents JSON Object.


Update the Dependents

PUT /v2/b2b/event/template/{id}/dependents

Update the the dependents for the specified template.  Any dependents not included in the update will have their dependency removed.

Body

An Event Dependents JSON Object.

Input

id: The id of the event template

Returns

The resulting Event Dependents JSON Object.


Remove all dependents

DELETE /v2/b2b/event/template/{id}/dependents

remove all dependencies for the specified template.  

Input

id: The id of the event template

Returns

The id of the template. 


AddOns

{
  "addOns" : {
    "inventoryAddOns" : [
    ],
    "inventoryIds" : [
    ]
  }
}

List Add-ons

GET /v2/b2b/event/template/{id}/addons

Gets the addOns available for the specified event template.  Will have all addOns filled in.

Input

id: The id of the event template

Returns

The AddOn List Object corresponding to the event template specified by id. 


Add a list of Add-ons

POST /v2/b2b/event/template/{id}

Adds the AddOn List Object to the add ons available for this event template.

 Body

An AddOn List Object with the add ons we want added to this event template.

Input

id: The id of the event template

Returns

The resulting AddOn List Object with all add ons available for this template.


Add an Add-on

POST /v2/b2b/event/template/{id}/addons/{addOnId}

Adds the specified addOn to the addOns available for this event template.

Input

id: The id of the event template

addOnId: The id of the addOn to be added to the add ons available for this event template.

Returns

The resulting AddOn List Object with all add ons available for this template.


Update the list of add-ons

PUT /v2/b2b/event/template/{id}/addons

Update the the addOns for the specified template.  Any addOns not included in the update will be removed from the template.

Body

An AddOn List Object with all of the add ons we want available for this event template.

Input

id: The id of the event template

addOnId: The id of the addOn to be added to the add ons available for this event template.

Returns

The resulting AddOn List JSON Object with all add ons available for this template.


Remove all add-ons

DELETE /v2/b2b/event/template/{id}/addons

remove all addons for the specified template.  

Input

id: The id of the event template

Returns

The resulting AddOn List Object with all add ons available for this template.


Remove the specified add-on

DELETE /v2/b2b/event/template/{id}/addons/{addOnId}

remove the specified addOn from the specified template.  

Input

id: The id of the event template you want the add-on removed from.

addOnId: The id of the addOn to be removed from the list of available add ons for this event template.

Returns

The resulting AddOn List Object with all add ons available for this template.


Membership

Event Template Membership allows you to provide members discounts when they purchase events of this template or to limit purchases of this event to specific membership types.  

For example if you have a three tier membership system Platinum, Gold and Silver.  You can specify that you want only Platinum and Gold members to be able to buy this event.  Or you can specify that anybody can buy this event and Platinum members can buy tickets at 50% off, Gold at 25% off and Silver at  10% off.


Get the membership elements of an event template

GET /v2/b2b/event/template/{id}/memberships

Input

id: The id of the event template you want the membership elements of.

Returns

The Event Membership Object associated with this event template.


Update the membership elements for the specified event template

PUT /v2/b2b/event/template/{id}/memberships

Input

id: The id of the event template you want to update the membership elements for.

Body

An Event Membership Object that you want to assign to the specified event template.

Returns

The resulting Event Membership Object associated with this event template.


Add a membership category to those that can buy events of this template.

POST /v2/b2b/event/template/{id}/memberships/restrictions/{membershipCategoryId}

Input

id: The id of the event template you want to add the membership category to the list of those eligible to buy events of this template.

membershipCategoryId: The id of the membership category you want to allow to buy events of this template.

Returns

The resulting Event Membership Object associated with this event template.


Remove a membership category from those that can buy events of this template.

DELETE /v2/b2b/event/template/{id}/memberships/restrictions/{membershipCategoryId}

Input

id: The id of the event template you want to remove the membership category from the list of those eligible to buy events of this template.

membershipCategoryId: The id of the membership category you want to deny access to events of this template.

Returns

The resulting Event Membership Object associated with this event template.


Get Discounts List.

GET /v2/b2b/event/template/{id}/memberships/discounts

Input

id: The id of the event template you want the discount list for.

Returns

A list of Event Membership Discount Objects associated with the specified event template.


Get the discount for the specified membership category.

GET /v2/b2b/event/template/{id}/memberships/discounts/{membershipCategoryId}

Input

id: The id of the event template you want the discount for.

membershipCategoryId: The id of the membership category you want to discount for.

Returns

An  Event Membership Discount Objects associated with the specified event template, membership category combination.


Add a discount for a membership category.

POST /v2/b2b/event/template/{id}/memberships/discounts

Body

An Event Membership Add Discount Object you want to add to the list.  If the membership category id specified in the Membership Discount Object already exists in the list of discounts available for this event template then this call will update the existing value, otherwise this discount will be added to those available.

Input

id: The id of the event template you want to add a discount to

Returns

The resulting Event Membership Object associated with this event template.


Remove a discount for a membership category.

DELETE /v2/b2b/event/template/{id}/memberships/discounts/{membershipCategoryId}

Input

id: The id of the event template you want to remove the membership category from the list of those eligible for discounts when they buy events of this template.

membershipCategoryId: The id of the membership category you want to not receive a  when buying events of this template.

Returns

The resulting Event Membership Object associated with this event template.



Event Template Summaries JSON

Field
Description
Notes
idthe id of the event templateRead Only
namethe name of the event templateRead Only
descriptionA description of this user templateRead Only
shortDescriptionA summary description of this template.Read Only
primaryImage The primary image for the event template.Read Only
startTimeThe start time for the event template. Read Only
endTimeThe end time for the event template.Read Only
reviewStatedraft or published.  Default is draft, if is saved in draft mode then will not create event instances.  If saved in published mode then can not go back to draft mode.Read Only
soldQuantitythe number of tickets sold to any event for this template.Read Only



Event Membership Object

Field
Description
Notes
restrictionsA list of membership categories that are eligible for this event template. Gives the ability to create events that require specific levels of membership before you can attend.
discountsA list of discounts associated with membership types. A list of Event Membership Discount Objects below.


Event Membership Discount Object

Field
Description
Notes
categoryThe membership category that this discount is for. Only provide the id when updating or creating the entire object will be returned. See Membership Categories API
discountThe discount object you want to assign to the membership category for this event template. Only provide the id when updating or creating, the entire object will be returned. Leave blank if you are not giving a discount but limiting the maximum number of tickets this membership can buy. See Discount for more information.
maxTicketsThe maximum number of tickets this membership can buy at this discounted price. Leave blank if unlimited.

 

Event Membership Add Discount Object

 


Field
Description
Notes
categoryIdThe id of the Membership Category this discount is associated with.
discountIdThe id of the discount you want this membership category to receive. Leave blank if you are not giving a discount but limiting the maximum number of tickets this membership can buy. See Discount for more information.
maxTicketsThe maximum number of tickets this membership can buy at this discounted price. Leave blank if unlimited.