sfgboxapi

<back to all web services

ZonesEdit

Requires Authentication
The following routes are available for this service:
PUT/zones/{Id}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using sfgboxapi.ServiceModel;

namespace sfgboxapi.ServiceModel
{
    [DataContract]
    public partial class ZonesEdit
    {
        [DataMember(Order=1)]
        [Validate("NotNull")]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        [Validate("NotNull")]
        public virtual long TenantsId { get; set; }

        [DataMember(Order=3)]
        [Validate("NotNull")]
        public virtual string Name { get; set; }

        [DataMember(Order=4)]
        [Validate("NotNull")]
        public virtual bool IsMain { get; set; }

        [DataMember(Order=5)]
        [Validate("NotNull")]
        public virtual bool IsDefault { get; set; }
    }

    public partial class ZonesEditResponse
    {
        [DataMember(Order=1)]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        public virtual long TenantsId { get; set; }

        [DataMember(Order=3)]
        public virtual string Name { get; set; }

        [DataMember(Order=4)]
        public virtual bool IsMain { get; set; }

        [DataMember(Order=5)]
        public virtual bool IsDefault { get; set; }

        [DataMember(Order=7)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# ZonesEdit 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.

PUT /zones/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	name: String,
	isMain: False,
	isDefault: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	name: String,
	isMain: False,
	isDefault: False,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}