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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GrowplansBoxesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <GrowplansUsersId>0</GrowplansUsersId>
  <Name>String</Name>
  <XAxis>0</XAxis>
  <YAxis>0</YAxis>
  <GrowplansOutcomesId>0</GrowplansOutcomesId>
  <Months>0</Months>
  <StartDate>0001-01-01T00:00:00</StartDate>
</GrowplansBoxesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GrowplansBoxesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <GrowplansOutcomesId>0</GrowplansOutcomesId>
  <GrowplansUsersId>0</GrowplansUsersId>
  <Months>0</Months>
  <Name>String</Name>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <XAxis>0</XAxis>
  <YAxis>0</YAxis>
</GrowplansBoxesAddResponse>