sfgboxapi

<back to all web services

GrowplansBoxesAdd

Requires Authentication
The following routes are available for this service:
POST/growplans_boxes
import 'package:servicestack/servicestack.dart';

class GrowplansBoxesAddResponse implements IConvertible
{
    // @DataMember(Order=2)
    int? growplansUsersId;

    // @DataMember(Order=3)
    String? name;

    // @DataMember(Order=4)
    int? xAxis;

    // @DataMember(Order=5)
    int? yAxis;

    // @DataMember(Order=6)
    int? growplansOutcomesId;

    // @DataMember(Order=7)
    int? months;

    // @DataMember(Order=8)
    DateTime? startDate;

    // @DataMember(Order=10)
    ResponseStatus? responseStatus;

    GrowplansBoxesAddResponse({this.growplansUsersId,this.name,this.xAxis,this.yAxis,this.growplansOutcomesId,this.months,this.startDate,this.responseStatus});
    GrowplansBoxesAddResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        growplansUsersId = json['growplansUsersId'];
        name = json['name'];
        xAxis = json['xAxis'];
        yAxis = json['yAxis'];
        growplansOutcomesId = json['growplansOutcomesId'];
        months = json['months'];
        startDate = JsonConverters.fromJson(json['startDate'],'DateTime',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'growplansUsersId': growplansUsersId,
        'name': name,
        'xAxis': xAxis,
        'yAxis': yAxis,
        'growplansOutcomesId': growplansOutcomesId,
        'months': months,
        'startDate': JsonConverters.toJson(startDate,'DateTime',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GrowplansBoxesAddResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class GrowplansBoxesAdd implements IConvertible
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    int? growplansUsersId;

    // @DataMember(Order=3)
    String? name;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    int? xAxis;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    int? yAxis;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    int? growplansOutcomesId;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    int? months;

    // @DataMember(Order=8)
    DateTime? startDate;

    GrowplansBoxesAdd({this.growplansUsersId,this.name,this.xAxis,this.yAxis,this.growplansOutcomesId,this.months,this.startDate});
    GrowplansBoxesAdd.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        growplansUsersId = json['growplansUsersId'];
        name = json['name'];
        xAxis = json['xAxis'];
        yAxis = json['yAxis'];
        growplansOutcomesId = json['growplansOutcomesId'];
        months = json['months'];
        startDate = JsonConverters.fromJson(json['startDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'growplansUsersId': growplansUsersId,
        'name': name,
        'xAxis': xAxis,
        'yAxis': yAxis,
        'growplansOutcomesId': growplansOutcomesId,
        'months': months,
        'startDate': JsonConverters.toJson(startDate,'DateTime',context!)
    };

    getTypeName() => "GrowplansBoxesAdd";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.sfgtec.com', types: <String, TypeInfo> {
    'GrowplansBoxesAddResponse': TypeInfo(TypeOf.Class, create:() => GrowplansBoxesAddResponse()),
    'GrowplansBoxesAdd': TypeInfo(TypeOf.Class, create:() => GrowplansBoxesAdd()),
});

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