sfgboxapi

<back to all web services

GrowplansBoxesAdd

Requires Authentication
The following routes are available for this service:
POST/growplans_boxes
"use strict";
export class GrowplansBoxesAddResponse {
    /** @param {{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} */
    growplansUsersId;
    /** @type {string} */
    name;
    /** @type {number} */
    xAxis;
    /** @type {number} */
    yAxis;
    /** @type {number} */
    growplansOutcomesId;
    /** @type {number} */
    months;
    /** @type {?string} */
    startDate;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GrowplansBoxesAdd {
    /** @param {{growplansUsersId?:number,name?:string,xAxis?:number,yAxis?:number,growplansOutcomesId?:number,months?:number,startDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    growplansUsersId;
    /** @type {string} */
    name;
    /** @type {number} */
    xAxis;
    /** @type {number} */
    yAxis;
    /** @type {number} */
    growplansOutcomesId;
    /** @type {number} */
    months;
    /** @type {?string} */
    startDate;
}

JavaScript GrowplansBoxesAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: api.sfgtec.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"growplansUsersId":0,"name":"String","xAxis":0,"yAxis":0,"growplansOutcomesId":0,"months":0,"startDate":"\/Date(-62135596800000-0000)\/"}

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

{"growplansUsersId":0,"name":"String","xAxis":0,"yAxis":0,"growplansOutcomesId":0,"months":0,"startDate":"\/Date(-62135596800000-0000)\/","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}