sfgboxapi

<back to all web services

CompanionsEdit

Requires Authentication
The following routes are available for this service:
PUT/companions/{Id}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class CompanionsEdit
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long id = null;

        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Long tenantsId = null;

        @DataMember(Order=3)
        @Validate(Validator="NotNull")
        public Long zonesId = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public Long cropsId = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public Long companionCropsId = null;
        
        public Long getId() { return id; }
        public CompanionsEdit setId(Long value) { this.id = value; return this; }
        public Long getTenantsId() { return tenantsId; }
        public CompanionsEdit setTenantsId(Long value) { this.tenantsId = value; return this; }
        public Long getZonesId() { return zonesId; }
        public CompanionsEdit setZonesId(Long value) { this.zonesId = value; return this; }
        public Long getCropsId() { return cropsId; }
        public CompanionsEdit setCropsId(Long value) { this.cropsId = value; return this; }
        public Long getCompanionCropsId() { return companionCropsId; }
        public CompanionsEdit setCompanionCropsId(Long value) { this.companionCropsId = value; return this; }
    }

    public static class CompanionsEditResponse
    {
        @DataMember(Order=1)
        public Long id = null;

        @DataMember(Order=2)
        public Long tenantsId = null;

        @DataMember(Order=3)
        public Long zonesId = null;

        @DataMember(Order=4)
        public Long cropsId = null;

        @DataMember(Order=5)
        public Long companionCropsId = null;

        @DataMember(Order=7)
        public ResponseStatus responseStatus = null;
        
        public Long getId() { return id; }
        public CompanionsEditResponse setId(Long value) { this.id = value; return this; }
        public Long getTenantsId() { return tenantsId; }
        public CompanionsEditResponse setTenantsId(Long value) { this.tenantsId = value; return this; }
        public Long getZonesId() { return zonesId; }
        public CompanionsEditResponse setZonesId(Long value) { this.zonesId = value; return this; }
        public Long getCropsId() { return cropsId; }
        public CompanionsEditResponse setCropsId(Long value) { this.cropsId = value; return this; }
        public Long getCompanionCropsId() { return companionCropsId; }
        public CompanionsEditResponse setCompanionCropsId(Long value) { this.companionCropsId = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CompanionsEditResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java CompanionsEdit 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 /companions/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	zonesId: 0,
	cropsId: 0,
	companionCropsId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	zonesId: 0,
	cropsId: 0,
	companionCropsId: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}