Follow

API Method - Customer Get Streaming

This method will return details about the streaming item if the customer has purchased it.
Parameters
appKey
 
string
A key identifying the application making the call
userKey
 
string
A key identifying the user making the call
corpOrgID
 
int
The corp organization ID
customerID
 
long
The customer ID
eventID
 
long
The event ID
Return Values
A streaming delivery structure with the following fields
ID
 
long
The item ID
Name
 
string
The item name
VenueName
 
string
The name of the venue
StartDateTime
 
datetime
The date streaming of the event will start
EndDateTime
 
datetime
The date streaming of the event will end
CorpOrgID
 
int
The event level folder/organization ID
OrderID
 
long
The order ID where the item was purchased
PurchaseDate
 
datetime
The date the customer purchased this item
ParentID
 
long
The ID of the parent show
Barcode
 
string
A barcode for the item if available
StreamingType
 
string
The type of video streaming source. (Vimeo, VimeoLive, VimeoShowcase, CineSend, CineSendVoucher, ExternalURL, EmbedURL, PurchaseURL, ZoomMeeting, Brightcove, AgileLINK, AgileLINKVoucher)
StreamingWindowType
 
string
The type of availability for streaming. (FirstWatch, PurchaseDate, StartDate, EndDate, OpenToMembers, OpenToAll)
StreamingID
 
string
The streaming asset ID
StreamingHours
 
int
The number of hours streaming is available
StreamURL
 
string
The URL for streaming
StreamWatchURLOverride
 
string
he URL for overriding where to send the customer for viewing the streaming title.
StreamPrompt
 
string
The “Watch Now” prompt to show the customer to start the stream
FirstWatchDate
 
datetime
The date the customer first started watching the title
AccessStatus
 
string
The current status of the streaming title availability for the customer. (AccessValid, BeforeEvent, AfterEvent, AccessExpired)
Errors
ApplicationKeyMissing
 
1000
Required parameter appkey is missing or invalid
UserCredentialsMissing
 
1001
Required user credentials are missing or invalid
SecurityInsufficient
 
1002
User security does not permit access to the requested function
RequiredParameter
 
1028
Required parameter is missing
CustomerNotFound
 
1021
Customer Not Found
RequestedItemNotFound
 
1044
Requested item not found
Example Request
https://prod1.agileticketing.net/api/sales.svc/json/CustomerGetStreaming?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&customerid={CUSTOMERID}&eventid={EVENTID}&
Example JSON Response
[{
	"ID":9223372036854775807,
	"Name":"String content",
	"VenueName":"String content",
	"StartDateTime":"\/Date(928167600000-0500)\/",
	"EndDateTime":"\/Date(928167600000-0500)\/",
	"CorpOrgID":9223372036854775807,
	"OrderID":9223372036854775807,
	"PurchaseDate":"\/Date(928167600000-0500)\/",
	"ParentID":9223372036854775807,
	"Barcode":"String content",
	"StreamingType":"String content",
	"StreamingWindowType":"String content",
	"StreamingID":"String content",
	"StreamingHours":2147483647,
	"StreamURL":"String content",
	"StreamWatchURLOverride":"String content",
	"StreamPrompt":"String content",
	"FirstWatchDate":"\/Date(928167600000-0500)\/",
	"AccessStatus":"String content"
}]
Example XML Response
<ArrayOfStreamDelivery xmlns="http://www.agiletix.com/api">
  <StreamDelivery>
    <ID>9223372036854775807</ID>
    <Name>String content</Name>
    <VenueName>String content</VenueName>
    <StartDateTime>1999-05-31T11:20:00</StartDateTime>
    <EndDateTime>1999-05-31T11:20:00</EndDateTime>
    <CorpOrgID>9223372036854775807</CorpOrgID>
    <OrderID>9223372036854775807</OrderID>
    <PurchaseDate>1999-05-31T11:20:00</PurchaseDate>
    <ParentID>9223372036854775807</ParentID>
    <Barcode>String content</Barcode>
    <StreamingType>String content</StreamingType>
    <StreamingWindowType>String content</StreamingWindowType>
    <StreamingID>String content</StreamingID>
    <StreamingHours>2147483647</StreamingHours>
    <StreamURL>String content</StreamURL>
    <StreamWatchURLOverride>String content</StreamWatchURLOverride>
    <StreamPrompt>String content</StreamPrompt>
    <FirstWatchDate>1999-05-31T11:20:00</FirstWatchDate>
    <AccessStatus>String content</AccessStatus>
  </StreamDelivery>
  <StreamDelivery>
    <ID>9223372036854775807</ID>
    <Name>String content</Name>
    <VenueName>String content</VenueName>
    <StartDateTime>1999-05-31T11:20:00</StartDateTime>
    <EndDateTime>1999-05-31T11:20:00</EndDateTime>
    <CorpOrgID>9223372036854775807</CorpOrgID>
    <OrderID>9223372036854775807</OrderID>
    <PurchaseDate>1999-05-31T11:20:00</PurchaseDate>
    <ParentID>9223372036854775807</ParentID>
    <Barcode>String content</Barcode>
    <StreamingType>String content</StreamingType>
    <StreamingWindowType>String content</StreamingWindowType>
    <StreamingID>String content</StreamingID>
    <StreamingHours>2147483647</StreamingHours>
    <StreamURL>String content</StreamURL>
    <StreamWatchURLOverride>String content</StreamWatchURLOverride>
    <StreamPrompt>String content</StreamPrompt>
    <FirstWatchDate>1999-05-31T11:20:00</FirstWatchDate>
    <AccessStatus>String content</AccessStatus>
  </StreamDelivery>
</ArrayOfStreamDelivery>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments