sfgboxapi

<back to all web services

GrowplansBoxesAdd

Requires Authentication
The following routes are available for this service:
POST/growplans_boxes
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class GrowplansBoxesAdd
    {
        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Long growplansUsersId = null;

        @DataMember(Order=3)
        public String name = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public Integer xAxis = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public Integer yAxis = null;

        @DataMember(Order=6)
        @Validate(Validator="NotNull")
        public Long growplansOutcomesId = null;

        @DataMember(Order=7)
        @Validate(Validator="NotNull")
        public Integer months = null;

        @DataMember(Order=8)
        public Date startDate = null;
        
        public Long getGrowplansUsersId() { return growplansUsersId; }
        public GrowplansBoxesAdd setGrowplansUsersId(Long value) { this.growplansUsersId = value; return this; }
        public String getName() { return name; }
        public GrowplansBoxesAdd setName(String value) { this.name = value; return this; }
        public Integer getXAxis() { return xAxis; }
        public GrowplansBoxesAdd setXAxis(Integer value) { this.xAxis = value; return this; }
        public Integer getYAxis() { return yAxis; }
        public GrowplansBoxesAdd setYAxis(Integer value) { this.yAxis = value; return this; }
        public Long getGrowplansOutcomesId() { return growplansOutcomesId; }
        public GrowplansBoxesAdd setGrowplansOutcomesId(Long value) { this.growplansOutcomesId = value; return this; }
        public Integer getMonths() { return months; }
        public GrowplansBoxesAdd setMonths(Integer value) { this.months = value; return this; }
        public Date getStartDate() { return startDate; }
        public GrowplansBoxesAdd setStartDate(Date value) { this.startDate = value; return this; }
    }

    public static class GrowplansBoxesAddResponse
    {
        @DataMember(Order=2)
        public Long growplansUsersId = null;

        @DataMember(Order=3)
        public String name = null;

        @DataMember(Order=4)
        public Integer xAxis = null;

        @DataMember(Order=5)
        public Integer yAxis = null;

        @DataMember(Order=6)
        public Long growplansOutcomesId = null;

        @DataMember(Order=7)
        public Integer months = null;

        @DataMember(Order=8)
        public Date startDate = null;

        @DataMember(Order=10)
        public ResponseStatus responseStatus = null;
        
        public Long getGrowplansUsersId() { return growplansUsersId; }
        public GrowplansBoxesAddResponse setGrowplansUsersId(Long value) { this.growplansUsersId = value; return this; }
        public String getName() { return name; }
        public GrowplansBoxesAddResponse setName(String value) { this.name = value; return this; }
        public Integer getXAxis() { return xAxis; }
        public GrowplansBoxesAddResponse setXAxis(Integer value) { this.xAxis = value; return this; }
        public Integer getYAxis() { return yAxis; }
        public GrowplansBoxesAddResponse setYAxis(Integer value) { this.yAxis = value; return this; }
        public Long getGrowplansOutcomesId() { return growplansOutcomesId; }
        public GrowplansBoxesAddResponse setGrowplansOutcomesId(Long value) { this.growplansOutcomesId = value; return this; }
        public Integer getMonths() { return months; }
        public GrowplansBoxesAddResponse setMonths(Integer value) { this.months = value; return this; }
        public Date getStartDate() { return startDate; }
        public GrowplansBoxesAddResponse setStartDate(Date value) { this.startDate = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GrowplansBoxesAddResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java 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: api.sfgtec.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>