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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	authAppUserId: 0,
	deploymentDate: 0001-01-01,
	numberBoxes: 0,
	recipientType: String,
	foodGardensId: 0,
	otherDescription: String,
	publicAccessGuid: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	authAppUserId: 0,
	deploymentDate: 0001-01-01,
	numberBoxes: 0,
	recipientType: String,
	foodGardensId: 0,
	otherDescription: String,
	publicAccessGuid: 00000000000000000000000000000000,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}