sfgboxapi

<back to all web services

UsersBoxesAdd

The following routes are available for this service:
POST/users_boxes
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using sfgboxapi.ServiceModel;

namespace sfgboxapi.ServiceModel
{
    [DataContract]
    public partial class UsersBoxesAdd
    {
        [DataMember(Order=2)]
        [Validate("NotNull")]
        public virtual long AppUserId { get; set; }

        [DataMember(Order=3)]
        [Validate("NotNull")]
        public virtual long AuthAppUserId { get; set; }

        [DataMember(Order=4)]
        [Validate("NotNull")]
        public virtual DateTime DeploymentDate { get; set; }

        [DataMember(Order=5)]
        [Validate("NotNull")]
        public virtual int NumberBoxes { get; set; }

        [DataMember(Order=6)]
        [Validate("NotNull")]
        public virtual string RecipientType { get; set; }

        [DataMember(Order=7)]
        public virtual long? FoodGardensId { get; set; }

        [DataMember(Order=8)]
        public virtual string OtherDescription { get; set; }

        [DataMember(Order=9)]
        public virtual Guid PublicAccessGuid { get; set; }
    }

    public partial class UsersBoxesAddResponse
    {
        [DataMember(Order=2)]
        public virtual long AppUserId { get; set; }

        [DataMember(Order=3)]
        public virtual long AuthAppUserId { get; set; }

        [DataMember(Order=4)]
        public virtual DateTime DeploymentDate { get; set; }

        [DataMember(Order=5)]
        public virtual int NumberBoxes { get; set; }

        [DataMember(Order=6)]
        public virtual string RecipientType { get; set; }

        [DataMember(Order=7)]
        public virtual long? FoodGardensId { get; set; }

        [DataMember(Order=8)]
        public virtual string OtherDescription { get; set; }

        [DataMember(Order=9)]
        public virtual Guid PublicAccessGuid { get; set; }

        [DataMember(Order=10)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}