sfgboxapi

<back to all web services

UsersBoxesAdd

The following routes are available for this service:
POST/users_boxes
namespace sfgboxapi.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UsersBoxesAddResponse() = 
        [<DataMember(Order=2)>]
        member val AppUserId:Int64 = new Int64() with get,set

        [<DataMember(Order=3)>]
        member val AuthAppUserId:Int64 = new Int64() with get,set

        [<DataMember(Order=4)>]
        member val DeploymentDate:DateTime = new DateTime() with get,set

        [<DataMember(Order=5)>]
        member val NumberBoxes:Int32 = new Int32() with get,set

        [<DataMember(Order=6)>]
        member val RecipientType:String = null with get,set

        [<DataMember(Order=7)>]
        member val FoodGardensId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=8)>]
        member val OtherDescription:String = null with get,set

        [<DataMember(Order=9)>]
        member val PublicAccessGuid:Guid = new Guid() with get,set

        [<DataMember(Order=10)>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type UsersBoxesAdd() = 
        [<DataMember(Order=2)>]
        [<Validate(Validator="NotNull")>]
        member val AppUserId:Int64 = new Int64() with get,set

        [<DataMember(Order=3)>]
        [<Validate(Validator="NotNull")>]
        member val AuthAppUserId:Int64 = new Int64() with get,set

        [<DataMember(Order=4)>]
        [<Validate(Validator="NotNull")>]
        member val DeploymentDate:DateTime = new DateTime() with get,set

        [<DataMember(Order=5)>]
        [<Validate(Validator="NotNull")>]
        member val NumberBoxes:Int32 = new Int32() with get,set

        [<DataMember(Order=6)>]
        [<Validate(Validator="NotNull")>]
        member val RecipientType:String = null with get,set

        [<DataMember(Order=7)>]
        member val FoodGardensId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=8)>]
        member val OtherDescription:String = null with get,set

        [<DataMember(Order=9)>]
        member val PublicAccessGuid:Guid = new Guid() with get,set

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