Requirements

URL: http://www.myupcoming.com/api

You will need:



Quick navigation



General information:

Description:

Mobile API interfaces to receive data for events, tickets, etc.

Request:

URL: http://www.myupcoming.com/api

Additional url's can be found here.

Result format:

XML or Json. XML by default.

To receive Json responses add fmt=json or fmt=xml in the request url. xml or json should be in lowercase.

In case of error in fmt value will be used default response type (XML).

Request method:

POST or GET

Success response:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    ....
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    ....
  }
}

Failed response:

XML:

<root>
  <status>
    <code>500</code>
    <message>App not found</message>
  </status>
<result/>
</root>

Json:

{
  "status":{
    "code":500,
    "message":"App not found"
  },
  "result":[
]
}

Token lifetime:

General session value for all website: 12 hours (current value)



Get channel list:

Description:

Get channel list

Request:

http://www.mijnevent.be/api/get-channel-list

Required parameters:

app-id=123

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

List of available channels

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <channel>
      <item>
        <field name="id">1</field>
        <field name="name">MyUpcoming.com</field>
      </item>
      <item>
        <field name="id">5</field>
        <field name="name">MijnEvent.be</field>
      </item>
      ...
    </channel>
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "channel":[
        {"id":"1", "name":"MyUpcoming.com"},
        {"id":"5", "name":"MijnEvent.be"},
      ]
  }
}

Failed response:

  1. App id not specified
  2. App not found

Example request:

http://www.mijnevent.be/api/get-channel-list?app-id=123



Get channel design:

Description:

Get channel design (Channel logo and colors)

Request:

http://www.mijnevent.be/api/get-channel-design

Required parameters:

app-id=123

channelid=channelId. Channel Id from channels list.

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

Channel information plus channel logo & channel colors.

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <channeldesign>
      <item>
        <field name="id">5</field>
        <field name="name">MijnEvent.be</field>
        <field name="logo">logos/mijneventbe.png</field>
        <field name="primarycolor">8ec23f</field>
        <field name="secondarycolor">0d74b1</field>
      </item>
    </channeldesign>
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "channeldesign":[{
      "id":"5",
      "name":"MijnEvent.be",
      "logo":"logos\/mijneventbe.png",
      "primarycolor":"8ec23f",
      "secondarycolor":"0d74b1"
    }]
  }
}

Failed response:

  1. App id not specified
  2. App not found
  3. Channel id not specified
  4. Channel not found

Example request:

http://www.mijnevent.be/api/get-channel-design?app-id=123&channelid=5



Check login function:

Description:

Function allows to check user credential.

Request:

http://www.mijnevent.be/api/login

Required parameters:

app-id=123

email=user_email

password=user_password.

Optional parameters:

channel=channelId. Channel Id from channels list. (If user have multiple account with the same email & password)

fmt=(json,xml) Default - XML

Success response:

Login and password correct and can be used to get data from service.

Notice

User can have several accounts with equal email & password in different channels. In this case you will see result with ok status with the list of available channels for user. In this case you should re-send login data (email & password) and specify what channel you want to use for this session. Only after that you will receive token for future API calls.

Account have several channels

User have account with equal email & password for multiple channels

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <channel>
      <item>
        <field name="id">40</field>
        <field name="name">teleticketeasy.be</field>
      </item>
      ...
    </channel>
  </result>
  <multichannel>1</multichannel>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "channel":[
      {"id":"40", "name":"teleticketeasy.be"},
      ...
    ]
  },
  "multichannel":1
}

Account in single channel

User have single account

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <channel>
      <item>
        <field name="id">5</field>
        <field name="name">MijnEvent.be</field>
      </item>
    </channel>
  </result>
  <token>S593dabaff9e7914976993b48cb7ba9401ab73c9f</token>
</root>

Json:

{
  "status": {
    "code":200,
    "message":"OK"
  },
  "result":{"channel":[{"id":"5", "name":"MijnEvent.be"}]},
  "token":"S593dabaff9e7914976993b48cb7ba9401ab73c9f"
}

Sub-account

For sub-account API will setup his UserId as default OrganizerId. To change OrganizerId - use set-organizer API call.

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <organizers>
      <item>
        <field name="id">611003</field>
        <field name="firstname">Anton</field>
        <field name="lastname">Krishtopin</field>
      </item>
    </organizers>
    <channel>
      <item>
        <field name="id">5</field>
        <field name="name">MijnEvent.be</field>
      </item>
    </channel>
  </result>
  <subaccount>1</subaccount>
  <token>Sce9917d4ac30262c4ef4af3148bfb6cbd9d87a1c</token>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "organizers":[{"id":"611003", "firstname":"Anton", "lastname":"Krishtopin"}],
    "channel":[{"id":"5", "name":"MijnEvent.be"}]
  },
  "subaccount":1,
  "token":"Sad342c6645ee69c60fa717c8f573c7bd1bd86c40"
}

Failed response:

  1. App id not specified
  2. App not found
  3. Email and password must be supplied
  4. Could not login. Check email and password.
  5. Session write error: Can't write data to session

Example request:

http://www.mijnevent.be/api/login?app-id=123&email=support@oxynade.com&password=superpassword123&channel=5



Set organizer:

Description:

Set organizer for subaccount.

Request:

http://www.mijnevent.be/api/set-organizer

Required parameters:

token - custom system token from success log-in result

organizerId - (int) selected organizerId from sub-account success log-in result

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result/>
</root>

Json:

{
  "status": {
    "code":200,
    "message":"OK"
  },
  "result":[]
}

Failed response:

  1. App id not specified
  2. App not found
  3. Token must be supplied
  4. Organizer must be supplied
  5. Can't open session: Session is expired or invalid token given
  6. Organizer Id is not linked with this user
  7. Session write error: Can't write data to session

Example request:

http://ticketing.dev/api/set-organizer?app-id=123&token=Sce9917d4ac30262c4ef4af3148bfb6cbd9d87a1c&organizerId=611003



Get all events for current account (sub-account):

Description:

Function allows user to receive events

Request:

http://www.mijnevent.be/api/events/organizer-events

Required parameters:

token=S593dabaff9e7914976993b48cb7ba9401ab73c9f

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <events>
      <item>
        <field name="id">59390</field>
        <field name="eventstatusid">2</field>
        <field name="allowdailyvalidation">0</field>
        <field name="title">Execution with candy</field>
        <field name="startdatetime">2014-08-22 20:00:00</field>
        <field name="enddatetime">2014-08-22 20:00:00</field>
        <field name="checktickettypehoursinvalidator">0</field>
        <field name="livebadgingenabled">0</field>
        <field name="created">2014-08-15 12:41:43</field>
        <field name="lastchange">2014-08-15 12:54:21</field>
      </item>
      ...
    </events>
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "events":[{
      "id":"59390",
      "eventstatusid":"2",
      "allowdailyvalidation":"0",
      "title":"Execution with candy",
      "startdatetime":"2014-08-22 20:00:00",
      "enddatetime":"2014-08-22 20:00:00",
      "checktickettypehoursinvalidator":"0",
      "livebadgingenabled":"0",
      "created":"2014-08-15 12:41:43",
      "lastchange":"2014-08-15 12:54:21"
    },
    ...
    ]
  }
}

Failed response:

  1. Unsupported api call (in case of wrong request url)
  2. Token must be supplied
  3. Can't open session: Session is expired or invalid token given
  4. Session write error: Can't write data to session

No events found:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result/>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{}
}

Example request:

http://www.mijnevent.be/api/events/organizer-events?token=S593dabaff9e7914976993b48cb7ba9401ab73c9f



Get event information:

Description:

Function allows user to receive event information

Request:

http://www.mijnevent.be/api/events/event

Required parameters:

token=S593dabaff9e7914976993b48cb7ba9401ab73c9f

eventid - (int) event id to display

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <event>
      <item>
        <field name="id">59390</field>
        <field name="currencyid">1</field>
        <field name="eventstatusid">2</field>
        <field name="issaleopen">1</field>
        <field name="totalnumberoftickets"/>
        <field name="title">Execution with candy</field>
        <field name="description">cool</field>
        <field name="location">Antwerp</field>
        <field name="state">Antwerpen</field>
        <field name="country">Belgium</field>
        <field name="startdatetime">2014-08-22 20:00:00</field>
        <field name="enddatetime">2014-08-22 20:00:00</field>
      </item>
    </event>
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "event":[{
      "id":"59390",
      "currencyid":"1",
      "eventstatusid":"2",
      "issaleopen":"1",
      "totalnumberoftickets":null,
      "title":"Execution with candy",
      "description":"cool",
      "location":"Antwerp",
      "state":"Antwerpen",
      "country":"Belgium",
      "startdatetime":"2014-08-22 20:00:00",
      "enddatetime":"2014-08-22 20:00:00"}
    ]
  }
}

Failed response:

  1. Unsupported api call (in case of wrong request url)
  2. Token must be supplied
  3. Event id must be set
  4. Can't open session: Session is expired or invalid token given
  5. Session write error: Can't write data to session
  6. This event does not exist
  7. You don't have access to this event

Example request:

http://www.mijnevent.be/api/events/event?token=S593dabaff9e7914976993b48cb7ba9401ab73c9f&eventid=59390



Get ticket types for event:

Description:

Function allows user to receive ticket types list for events

Request:

http://www.mijnevent.be/api/events/event-ticket-types

Required parameters:

token=S593dabaff9e7914976993b48cb7ba9401ab73c9f

eventid - (int) event id to display

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <tickettypes>
      <item>
        <field name="id">94486</field>
        <field name="currencyid">1</field>
        <field name="ticketfamilyid">1</field>
        <field name="published">1</field>
        <field name="fixednumber">A</field>
        <field name="name">Standard</field>
        <field name="totalnumber">75</field>
        <field name="numberavailable">75</field>
        <field name="priceperticket">50.000</field>
        <field name="created">2014-08-15 12:46:59</field>
      </item>
      ...
    </tickettypes>
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "tickettypes":[{
      "id":"94486",
      "currencyid":"1",
      "ticketfamilyid":"1",
      "published":"1",
      "fixednumber":"A",
      "name":"Standard",
      "totalnumber":"75",
      "numberavailable":"75",
      "priceperticket":"50.000",
      "created":"2014-08-15 12:46:59"
    },
    ...
    ]
  }
}

Failed response:

  1. Unsupported api call (in case of wrong request url)
  2. Token must be supplied
  3. Event id must be set
  4. Can't open session: Session is expired or invalid token given
  5. Session write error: Can't write data to session
  6. This event does not exist
  7. You don't have access to this event

Example request:

http://www.mijnevent.be/api/events/event-ticket-types?token=S593dabaff9e7914976993b48cb7ba9401ab73c9f&eventid=59390



Get all issued tickets or the selected ticket type:

Description:

Function allows user to receive all issued tickets or issued ticket for selected ticket type

Request:

http://www.mijnevent.be/api/events/event-tickets

Required parameters:

token=S593dabaff9e7914976993b48cb7ba9401ab73c9f

One of the parameters below should be specified

eventid - (int) event id to display

tickettypeid - (int) ticket type id

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <tickets>
      <item>
        <field name="id">3617894</field>
        <field name="tickettypeid">94490</field>
        <field name="purchaseid">1804356</field>
        <field name="seatid"/>
        <field name="firstname">Anton</field>
        <field name="lastname">Krishtopin</field>
        <field name="email">support@oxynade.com</field>
        <field name="issued">1</field>
        <field name="barcode">21</field>
        <field name="created">2014-08-22 16:26:22</field>
      </item>
      ...
    </tickets>
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "tickets":[{
      "id":"3617894",
      "tickettypeid":"94490",
      "purchaseid":"1804356",
      "seatid":null,
      "firstname":"Anton",
      "lastname":"Krishtopin",
      "email":"support@oxynade.com",
      "issued":"1",
      "barcode":"21",
      "created":"2014-08-22 16:26:22"
    },
    ...
    ]
  }
}

Failed response:

  1. Unsupported api call (in case of wrong request url)
  2. Token must be supplied
  3. Event id or TicketType id must be set.
  4. Can't open session: Session is expired or invalid token given
  5. Session write error: Can't write data to session
  6. This event does not exist
  7. You don't have access to this event

Example request:

http://www.mijnevent.be/api/events/event-tickets?token=S593dabaff9e7914976993b48cb7ba9401ab73c9f&eventid=59390&tickettypeid=94490



Get ticket information from a barcode:

Description:

Function allows user to receive ticket information from barcode number

Request:

http://www.mijnevent.be/api/events/search-ticket

Required parameters:

token=S593dabaff9e7914976993b48cb7ba9401ab73c9f

barcode - (int) barcode number to display

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <ticketinfo>
      <item>
        <field name="id">3617894</field>
        <field name="tickettypeid">94490</field>
        <field name="purchaseid">1804356</field>
        <field name="pricingschemeid">61</field>
        <field name="currencyid">1</field>
        <field name="ticketstatusid">3</field>
        <field name="firstname">Anton</field>
        <field name="lastname">Krishtopin</field>
        <field name="email">support@oxynade.com</field>
        <field name="address">abracadabra</field>
        <field name="price">55.900</field>
        <field name="handlingfee">0.900</field>
        <field name="issued">1</field>
        <field name="validated">1</field>
        <field name="ticketdownloadlinkclicked">0</field>
        <field name="ticketdownloaded">0</field>
        <field name="issuedatetime">2014-08-22 16:26:47</field>
      </item>
    </ticketinfo>
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "ticketinfo":[{
      "id":"3617894",
      "tickettypeid":"94490",
      "purchaseid":"1804356",
      "pricingschemeid":"61",
      "currencyid":"1",
      "ticketstatusid":"3",
      "firstname":"Anton",
      "lastname":"Krishtopin",
      "email":"support@oxynade.com",
      "address":"abracadabra",
      "price":"55.900",
      "handlingfee":"0.900",
      "issued":"1",
      "validated":"1",
      "ticketdownloadlinkclicked":"0",
      "ticketdownloaded":"0",
      "issuedatetime":"2014-08-22 16:26:47"
    }]
  }
}

Failed response:

  1. Unsupported api call (in case of wrong request url)
  2. Token must be supplied
  3. A barcode must be sent for the API to fetch the corresponding ticket
  4. Can't open session: Session is expired or invalid token given
  5. Session write error: Can't write data to session
  6. Ticket not found in database.
  7. You don't have access to this event

Example request:

http://www.mijnevent.be/api/events/search-ticket?token=S593dabaff9e7914976993b48cb7ba9401ab73c9f&barcode=21



Validating a ticket using it's barcode:

Description:

Function allows user to validate ticket using it's barcode number

Request:

http://www.mijnevent.be/api/events/validate-ticket

Required parameters:

token=S593dabaff9e7914976993b48cb7ba9401ab73c9f

barcode - (int) barcode number

Optional parameters:

fmt=(json,xml) Default - XML

Success response:

XML:

<root>
  <status>
    <code>200</code>
    <message>OK</message>
  </status>
  <result>
    <ticketinfo>
      <item>
        <field name="id">3617894</field>
        <field name="tickettypeid">94490</field>
        <field name="purchaseid">1804356</field>
        <field name="pricingschemeid">61</field>
        <field name="currencyid">1</field>
        <field name="ticketstatusid">3</field>
        <field name="firstname">Anton</field>
        <field name="lastname">Krishtopin</field>
        <field name="email">support@oxynade.com</field>
        <field name="address">abracadabra</field>
        <field name="price">55.900</field>
        <field name="handlingfee">0.900</field>
        <field name="issued">1</field>
        <field name="validated">1</field>
        <field name="ticketdownloadlinkclicked">0</field>
        <field name="ticketdownloaded">0</field>
        <field name="issuedatetime">2014-08-22 16:26:47</field>
      </item>
    </ticketinfo>
  </result>
</root>

Json:

{
  "status":{
    "code":200,
    "message":"OK"
  },
  "result":{
    "ticketinfo":[{
      "id":"3617894",
      "tickettypeid":"94490",
      "purchaseid":"1804356",
      "pricingschemeid":"61",
      "currencyid":"1",
      "ticketstatusid":"3",
      "firstname":"Anton",
      "lastname":"Krishtopin",
      "email":"support@oxynade.com",
      "address":"abracadabra",
      "price":"55.900",
      "handlingfee":"0.900",
      "issued":"1",
      "validated":"1",
      "ticketdownloadlinkclicked":"0",
      "ticketdownloaded":"0",
      "issuedatetime":"2014-08-22 16:26:47"
    }]
  }
}

Failed response:

  1. Unsupported api call (in case of wrong request url)
  2. Token must be supplied
  3. A barcode must be sent for the API to fetch the corresponding ticket
  4. Can't open session: Session is expired or invalid token given
  5. Session write error: Can't write data to session
  6. Ticket not found in database.
  7. You don't have access to this event
  8. Ticket has already been validated!

Example request:

http://www.mijnevent.be/api/events/validate-ticket?token=S593dabaff9e7914976993b48cb7ba9401ab73c9f&barcode=21