sfgboxapi

GrowplansBoxesEdit

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

"use strict";
export class GrowplansBoxesEditResponse {
    /** @param {{id?:number,growplansUsersId?:number,name?:string,xAxis?:number,yAxis?:number,growplansOutcomesId?:number,months?:number,startDate?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    growplansUsersId;
    /** @type {string} */
    name;
    /** @type {number} */
    xAxis;
    /** @type {number} */
    yAxis;
    /** @type {number} */
    growplansOutcomesId;
    /** @type {number} */
    months;
    /** @type {?string} */
    startDate;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GrowplansBoxesEdit {
    /** @param {{id?:number,growplansUsersId?:number,name?:string,xAxis?:number,yAxis?:number,growplansOutcomesId?:number,months?:number,startDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    growplansUsersId;
    /** @type {string} */
    name;
    /** @type {number} */
    xAxis;
    /** @type {number} */
    yAxis;
    /** @type {number} */
    growplansOutcomesId;
    /** @type {number} */
    months;
    /** @type {?string} */
    startDate;
}

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

{
	id: 0,
	growplansUsersId: 0,
	name: String,
	xAxis: 0,
	yAxis: 0,
	growplansOutcomesId: 0,
	months: 0,
	startDate: 0001-01-01
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	growplansUsersId: 0,
	name: String,
	xAxis: 0,
	yAxis: 0,
	growplansOutcomesId: 0,
	months: 0,
	startDate: 0001-01-01,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}