BazeField Services

<back to all web services

DeviceInfoGetRequest

Configuration API
Requires Authentication
The following routes are available for this service:
GET, POST/configuration/objects/{ObjectIds}/devices
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Bazefield.Configuration.WebService.Request;
using Bazefield.Configuration.WebService.Response;
using Bazefield.Configuration.Entity;

namespace Bazefield.Configuration.Entity
{
    public partial class DeviceInfoEntity
    {
        public virtual int Id { get; set; }
        public virtual string Description { get; set; }
        public virtual string Name { get; set; }
        public virtual int LoadOrder { get; set; }
        public virtual Guid NodeId { get; set; }
        public virtual string NodeName { get; set; }
        public virtual int ProtocolId { get; set; }
        public virtual string ProtocolName { get; set; }
        public virtual string ConnectionString { get; set; }
    }

}

namespace Bazefield.Configuration.WebService.Request
{
    public partial class DeviceInfoGetRequest
    {
        public DeviceInfoGetRequest()
        {
            ObjectIds = new List<string>{};
        }

        public virtual List<string> ObjectIds { get; set; }
    }

}

namespace Bazefield.Configuration.WebService.Response
{
    public partial class DeviceInfoGetResponse
    {
        public DeviceInfoGetResponse()
        {
            Devices = new Dictionary<int, DeviceInfoEntity>{};
        }

        public virtual Dictionary<int, DeviceInfoEntity> Devices { get; set; }
    }

}

C# DeviceInfoGetRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /configuration/objects/{ObjectIds}/devices HTTP/1.1 
Host: monitoring.ox2.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	objectIds: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	devices: 
	{
		0: 
		{
			id: 0,
			description: String,
			name: String,
			loadOrder: 0,
			nodeName: String,
			protocolId: 0,
			protocolName: String,
			connectionString: String
		}
	}
}