sfgboxapi

CompanionsEdit

The following routes are available for this service:
PUT	/companions/{Id}

"use strict";
export class CompanionsEditResponse {
    /** @param {{id?:number,tenantsId?:number,zonesId?:number,cropsId?:number,companionCropsId?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    zonesId;
    /** @type {number} */
    cropsId;
    /** @type {number} */
    companionCropsId;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class CompanionsEdit {
    /** @param {{id?:number,tenantsId?:number,zonesId?:number,cropsId?:number,companionCropsId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    zonesId;
    /** @type {number} */
    cropsId;
    /** @type {number} */
    companionCropsId;
}

JavaScript 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
		}
	}
}