sfgboxapi

<back to all web services

GrowplansBoxesEdit

Requires Authentication
The following routes are available for this service:
PUT/growplans_boxes/{Id}
GrowplansBoxesEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathlongYes
GrowplansUsersIdbodylongYes
NamebodystringNo
XAxisbodyintYes
YAxisbodyintYes
GrowplansOutcomesIdbodylongYes
MonthsbodyintYes
StartDatebodyDateTime?No
GrowplansBoxesEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GrowplansUsersIdformlongNo
NameformstringNo
XAxisformintNo
YAxisformintNo
GrowplansOutcomesIdformlongNo
MonthsformintNo
StartDateformDateTime?No
ResponseStatusformResponseStatusNo

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