sfgboxapi

<back to all web services

GrowplansBoxesAdd

Requires Authentication
The following routes are available for this service:
POST/growplans_boxes

export class GrowplansBoxesAddResponse
{
    // @DataMember(Order=2)
    public growplansUsersId: number;

    // @DataMember(Order=3)
    public name: string;

    // @DataMember(Order=4)
    public xAxis: number;

    // @DataMember(Order=5)
    public yAxis: number;

    // @DataMember(Order=6)
    public growplansOutcomesId: number;

    // @DataMember(Order=7)
    public months: number;

    // @DataMember(Order=8)
    public startDate?: string;

    // @DataMember(Order=10)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GrowplansBoxesAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GrowplansBoxesAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public growplansUsersId: number;

    // @DataMember(Order=3)
    public name: string;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public xAxis: number;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public yAxis: number;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public growplansOutcomesId: number;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public months: number;

    // @DataMember(Order=8)
    public startDate?: string;

    public constructor(init?: Partial<GrowplansBoxesAdd>) { (Object as any).assign(this, init); }
}

TypeScript GrowplansBoxesAdd 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.

POST /growplans_boxes HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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

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