Please enable JavaScript to view this site.

EventPro Software User Manual

Breadcrumb Trail: EventPro API

Show Selected Fields ("Select" Parameter)

Scroll Prev Top Next More

The "select" parameter can be used to show values for only certain fields in the results.  

 

Note, however, that the Oid value will always be present in the results, regardless of whether you include the Oid field in the select parameter.

Depending on the endpoint used, certain fields will always appear in the results. However, the data values for those fields will not be displayed in the results unless the fields are included in the "select" parameter list. If the field is not included in the "select" parameter list, its value in the results will be blank.

 

Let's look at examples of the "select" parameter used in the List Events endpoint.

For formatting, it does not matter whether you leave spaces after the commas or not.

Select only the Booking Numbers from the Events:

ohttps://connect.eventpro.net/API/DataService.svc/events?select=BookNo

Select only the Booking Numbers and Dates from the Events:

ohttps://connect.eventpro.net/API/DataService.svc/events?select=BookNo, DateFrom, DateTo

Select only the Booking Numbers, Locations, and Location Booked From Times from the Events:

ohttps://connect.eventpro.net/API/DataService.svc/events?select=BookNo,Locations,BookedFrom

 

 

As noted above, some fields will appear in the results, regardless of whether you included those fields in the "select" parameter.

For example, with the List Events endpoint, the Locations field will always be included in the results.

As you see in our first sample URL, the "select" parameter list does not include the Locations field:

ohttps://connect.eventpro.net/API/DataService.svc/events?select=BookNo

The Locations field will still be present in the retrieved results, but it will not contain any data values. Again, this is because it was not included in the "select" parameter list.

Figure 392: Locations Field not Selected

Figure 392: Locations Field not Selected

 

Now, let's say we have included the Locations field in the "select" parameter list:

ohttps://connect.eventpro.net/API/DataService.svc/events?select=BookNo,Locations

The Locations field is present in the retrieved results, and it now contains data values.

Figure 393: Locations Field Selected 

Figure 393: Locations Field Selected 

 

© 2023 EventPro Software, a wholly owned subsidiary of Profit Systems Inc. All Rights Reserved.