sfgboxapi

<back to all web services

UsersBoxesEdit

Requires Authentication
The following routes are available for this service:
PUT/users_boxes/{Id}
import 'package:servicestack/servicestack.dart';

class UsersBoxesEditResponse implements IConvertible
{
    // @DataMember(Order=1)
    int? id;

    // @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=10)
    ResponseStatus? responseStatus;

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

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        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'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

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

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

// @DataContract
class UsersBoxesEdit implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    int? id;

    // @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;

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

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        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'];
        return this;
    }

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

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

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

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

PUT /users_boxes/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UsersBoxesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <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>
</UsersBoxesEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersBoxesEditResponse 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>
  <Id>0</Id>
  <NumberBoxes>0</NumberBoxes>
  <OtherDescription>String</OtherDescription>
  <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>
</UsersBoxesEditResponse>