sfgboxapi

<back to all web services

UsersBoxesAdd

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

class UsersBoxesAddResponse implements IConvertible
{
    // @DataMember(Order=2)
    int? appUserId;

    // @DataMember(Order=3)
    int? authAppUserId;

    // @DataMember(Order=4)
    DateTime? deploymentDate;

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

    // @DataMember(Order=6)
    String? recipientType;

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

    // @DataMember(Order=8)
    String? otherDescription;

    // @DataMember(Order=9)
    String? publicAccessGuid;

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

    UsersBoxesAddResponse({this.appUserId,this.authAppUserId,this.deploymentDate,this.numberBoxes,this.recipientType,this.foodGardensId,this.otherDescription,this.publicAccessGuid,this.responseStatus});
    UsersBoxesAddResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        appUserId = json['appUserId'];
        authAppUserId = json['authAppUserId'];
        deploymentDate = JsonConverters.fromJson(json['deploymentDate'],'DateTime',context!);
        numberBoxes = json['numberBoxes'];
        recipientType = json['recipientType'];
        foodGardensId = json['foodGardensId'];
        otherDescription = json['otherDescription'];
        publicAccessGuid = json['publicAccessGuid'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'appUserId': appUserId,
        'authAppUserId': authAppUserId,
        'deploymentDate': JsonConverters.toJson(deploymentDate,'DateTime',context!),
        'numberBoxes': numberBoxes,
        'recipientType': recipientType,
        'foodGardensId': foodGardensId,
        'otherDescription': otherDescription,
        'publicAccessGuid': publicAccessGuid,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

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

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    int? authAppUserId;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    DateTime? deploymentDate;

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

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    String? recipientType;

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

    // @DataMember(Order=8)
    String? otherDescription;

    // @DataMember(Order=9)
    String? publicAccessGuid;

    UsersBoxesAdd({this.appUserId,this.authAppUserId,this.deploymentDate,this.numberBoxes,this.recipientType,this.foodGardensId,this.otherDescription,this.publicAccessGuid});
    UsersBoxesAdd.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        appUserId = json['appUserId'];
        authAppUserId = json['authAppUserId'];
        deploymentDate = JsonConverters.fromJson(json['deploymentDate'],'DateTime',context!);
        numberBoxes = json['numberBoxes'];
        recipientType = json['recipientType'];
        foodGardensId = json['foodGardensId'];
        otherDescription = json['otherDescription'];
        publicAccessGuid = json['publicAccessGuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'appUserId': appUserId,
        'authAppUserId': authAppUserId,
        'deploymentDate': JsonConverters.toJson(deploymentDate,'DateTime',context!),
        'numberBoxes': numberBoxes,
        'recipientType': recipientType,
        'foodGardensId': foodGardensId,
        'otherDescription': otherDescription,
        'publicAccessGuid': publicAccessGuid
    };

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

TypeContext _ctx = TypeContext(library: 'sfgboxapi.dev.scadsoftware.com', types: <String, TypeInfo> {
    'UsersBoxesAddResponse': TypeInfo(TypeOf.Class, create:() => UsersBoxesAddResponse()),
    'UsersBoxesAdd': TypeInfo(TypeOf.Class, create:() => UsersBoxesAdd()),
});

Dart UsersBoxesAdd 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 /users_boxes HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UsersBoxesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <AuthAppUserId>0</AuthAppUserId>
  <DeploymentDate>0001-01-01T00:00:00</DeploymentDate>
  <NumberBoxes>0</NumberBoxes>
  <RecipientType>String</RecipientType>
  <FoodGardensId>0</FoodGardensId>
  <OtherDescription>String</OtherDescription>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
</UsersBoxesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersBoxesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <AuthAppUserId>0</AuthAppUserId>
  <DeploymentDate>0001-01-01T00:00:00</DeploymentDate>
  <FoodGardensId>0</FoodGardensId>
  <NumberBoxes>0</NumberBoxes>
  <OtherDescription>String</OtherDescription>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <RecipientType>String</RecipientType>
  <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>
</UsersBoxesAddResponse>