...
| Code Block |
|---|
https://[IP address or hostname]:[port]/video/ |
WILL BE DEPRECATED IN NEXT RELEASE, USE /channels
Returns stored video from the camera with the given camera number and options (start time, end time, length, framerate, and/or resolution). Note: Datetime values are formatted according to the ISO 8601 specification: YYYY-MM-DDTHH:MM:SS For example, 2012-12-05T13:40:27. For more information, see this article from the W3C W3.org: Date and Time Formats.
...
For more details, see the source for the BankTeller Java sample.
Sending Request XML
The SOAP Envelope wraps the request, and the <soap:body>contains the details of the request. Here are examples of the XML for Authenticate. In following example we will usually display the XML for the body and omit the header and wrapping XML.
SOAP 1.1 Request Envelope
| Code Block | ||
|---|---|---|
| ||
POST /3vr/IAuthenticateService.asmx HTTP/1.1
Host: 10.100.1.105
Port: 8080
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://3vr.com/Authenticate"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<SoapHeaderInfo xmlns="http://3vr.com">
<Address>string</Address>
<ServiceToken>string</ServiceToken>
</SoapHeaderInfo>
</soap:Header>
<soap:Body>
<Authenticate xmlns="http://3vr.com">
<username>string</username>
<password>string</password>
</Authenticate>
</soap:Body>
</soap:Envelope> |
SOAP 1.1 Response
| Code Block | ||
|---|---|---|
| ||
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AuthenticateResponse xmlns="http://3vr.com">
<AuthenticateResult>
<Token>string</Token>
<Status>string</Status>
</AuthenticateResult>
</AuthenticateResponse>
</soap:Body>
</soap:Envelope> |
SOAP 1.2 Request Envelope
| Code Block | ||
|---|---|---|
| ||
POST /3vr/IAuthenticateService.asmx HTTP/1.1
Host: 10.100.1.105
Port: 8080
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<SoapHeaderInfo xmlns="http://3vr.com">
<Address>string</Address>
<ServiceToken>string</ServiceToken>
</SoapHeaderInfo>
</soap12:Header>
<soap12:Body>
<Authenticate xmlns="http://3vr.com">
<username>string</username>
<password>string</password>
</Authenticate>
</soap12:Body>
</soap12:Envelope> |
SOAP 1.2 Response
| Code Block | ||
|---|---|---|
| ||
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AuthenticateResponse xmlns="http://3vr.com">
<AuthenticateResult>
<Token>string</Token>
<Status>string</Status>
</AuthenticateResult>
</AuthenticateResponse>
</soap12:Body>
</soap12:Envelope> |
Authenticate
As shown in the examples above, the Authenticate operation sends the user name and password and receives a <Token> and <Status> in the response:
| Code Block | ||
|---|---|---|
| ||
<AuthenticateResult>
<Token>string</Token>
<Status>string</Status>
</AuthenticateResult> |
If all goes well the <Status> will contain "Success". The <Token> is used on the following request in the soap:Header<ServiceToken>.
CreateGenericEventDefinition
Generic event definitions control how events are displayed in OpCenter. The name and metadata fields are displayed on the event card, and metadata is displayed in event details. Users can search for events using metadata fields in the Search panel.
The metadata fields define custom data fields for the generic event. The GUID identifies the generic event and metadata fields across different 3VR servers. The GUID is instrumental when identifying the generic event and editing the generic event definition.
Each metadata field has a Name, Description, Type, Display Position, Display Format and GUID elements:
Generic Event Definition Metadata Fields
<Name> Appears in the event details and may appear on the event card, depending on the Display Format.
<Type> Defines the data type. Values include "String", "Number", "DateTime", or "EnumeratedType".
<Description> Describes the field.
<DisplayPosition> Sets the order the Metadata Fields are displayed. Valid display values are 0-100. Values over 100 are not displayed.
<DisplayFormat> Controls the way the data is displayed on large event cards. Allows simple formatting (bolding, joining lines and inserting new lines). See the following code sample for more information.
<EnumeratedData> Lists the valid data values for an EnumeratedType.
| Code Block | ||
|---|---|---|
| ||
<CreateGenericEventDefinition xmlns="http://3vr.com">
<eventDefinition>
<Name>string</Name>
<ShortName>string</ShortName>
<GUID>string</GUID>
<HelpText>string</HelpText>
<MetadataFields>
<MetadataField>
<GUID>string</GUID>
<Name>string</Name>
<Description>string</Description>
<Type>String or Number or DateTime or EnumeratedType</Type>
<DisplayPosition>int</DisplayPosition>
<DisplayFormat>string</DisplayFormat>
<EnumeratedData xsi:nil="true" />
</MetadataField>
<MetadataField>
...
</MetadataField>
</MetadataFields>
</eventDefinition>
</CreateGenericEventDefinition> |