GET v1/admin/company/{id}/Events/{productId}

Retrieves the details for a single item in the admin events catalog.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

productId

integer

Required

Body Parameters

None.

Response Information

Resource Description

SingleAdminEvent
NameDescriptionTypeAdditional information
id

product id of an event.

integer

None.

name

product name of an event.

string

None.

webDescription

A short rich text description of event with html encoding.

string

None.

webLongDescription

A long rich text description of event with html encoding.

string

None.

startDate

Startdate of an event.

date

None.

venue

The name of the location where this event is taking place'.

string

None.

addressLine1

The address where this event is taking place'.

string

None.

addressLine2

The address where this event is taking place'.

string

None.

addressCity

The city where this event is taking place'.

string

None.

addressStateProvince

The state where this event is taking place'.

string

None.

addressPostalCode

The postal code where this event is taking place'.

string

None.

addressCountry

The country where this event is taking place'.

string

None.

retailPrice

decimal number

None.

CurrencySymbol

string

None.

hasSessions

boolean

None.

webImage

Image url for an event

string

None.

endDate

EndDate of an event.

date

None.

hasComplexPricing

If true, this indicates you must add the product to the cart in order to get an accurate price.

boolean

None.

defaultPrice

decimal number

None.

defaultMemberPrice

decimal number

None.

nonMemberPrice

decimal number

None.

requireAvailableSpace

boolean

None.

availableSpace

integer

None.

maxSpace

integer

None.

statusID

integer

None.

status

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "webDescription": "sample string 3",
  "webLongDescription": "sample string 4",
  "startDate": "2024-10-09T18:52:30.1610796+00:00",
  "venue": "sample string 6",
  "addressLine1": "sample string 7",
  "addressLine2": "sample string 8",
  "addressCity": "sample string 9",
  "addressStateProvince": "sample string 10",
  "addressPostalCode": "sample string 11",
  "addressCountry": "sample string 12",
  "retailPrice": 13.0,
  "CurrencySymbol": "sample string 14",
  "hasSessions": true,
  "webImage": "sample string 16",
  "endDate": "2024-10-09T18:52:30.1610796+00:00",
  "hasComplexPricing": true,
  "defaultPrice": 19.0,
  "defaultMemberPrice": 20.0,
  "nonMemberPrice": 21.0,
  "requireAvailableSpace": true,
  "availableSpace": 23,
  "maxSpace": 24,
  "statusID": 25,
  "status": "sample string 26"
}

text/html

Sample:
{"id":1,"name":"sample string 2","webDescription":"sample string 3","webLongDescription":"sample string 4","startDate":"2024-10-09T18:52:30.1610796+00:00","venue":"sample string 6","addressLine1":"sample string 7","addressLine2":"sample string 8","addressCity":"sample string 9","addressStateProvince":"sample string 10","addressPostalCode":"sample string 11","addressCountry":"sample string 12","retailPrice":13.0,"CurrencySymbol":"sample string 14","hasSessions":true,"webImage":"sample string 16","endDate":"2024-10-09T18:52:30.1610796+00:00","hasComplexPricing":true,"defaultPrice":19.0,"defaultMemberPrice":20.0,"nonMemberPrice":21.0,"requireAvailableSpace":true,"availableSpace":23,"maxSpace":24,"statusID":25,"status":"sample string 26"}

application/xml, text/xml

Sample:
<v1_Admin_CompanyEndpointController.SingleAdminEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_CompanyEndpoint">
  <CurrencySymbol>sample string 14</CurrencySymbol>
  <addressCity>sample string 9</addressCity>
  <addressCountry>sample string 12</addressCountry>
  <addressLine1>sample string 7</addressLine1>
  <addressLine2>sample string 8</addressLine2>
  <addressPostalCode>sample string 11</addressPostalCode>
  <addressStateProvince>sample string 10</addressStateProvince>
  <availableSpace>23</availableSpace>
  <defaultMemberPrice>20</defaultMemberPrice>
  <defaultPrice>19</defaultPrice>
  <endDate>2024-10-09T18:52:30.1610796+00:00</endDate>
  <hasComplexPricing>true</hasComplexPricing>
  <hasSessions>true</hasSessions>
  <id>1</id>
  <maxSpace>24</maxSpace>
  <name>sample string 2</name>
  <nonMemberPrice>21</nonMemberPrice>
  <requireAvailableSpace>true</requireAvailableSpace>
  <retailPrice>13</retailPrice>
  <startDate>2024-10-09T18:52:30.1610796+00:00</startDate>
  <status>sample string 26</status>
  <statusID>25</statusID>
  <venue>sample string 6</venue>
  <webDescription>sample string 3</webDescription>
  <webImage>sample string 16</webImage>
  <webLongDescription>sample string 4</webLongDescription>
</v1_Admin_CompanyEndpointController.SingleAdminEvent>