sfgboxapi

<back to all web services

UsersBoxesAdd

The following routes are available for this service:
POST/users_boxes
import java.math.*
import java.util.*
import net.servicestack.client.*


@DataContract
open class UsersBoxesAdd
{
    @DataMember(Order=2)
    @Validate(Validator="NotNull")
    var appUserId:Long? = null

    @DataMember(Order=3)
    @Validate(Validator="NotNull")
    var authAppUserId:Long? = null

    @DataMember(Order=4)
    @Validate(Validator="NotNull")
    var deploymentDate:Date? = null

    @DataMember(Order=5)
    @Validate(Validator="NotNull")
    var numberBoxes:Int? = null

    @DataMember(Order=6)
    @Validate(Validator="NotNull")
    var recipientType:String? = null

    @DataMember(Order=7)
    var foodGardensId:Long? = null

    @DataMember(Order=8)
    var otherDescription:String? = null

    @DataMember(Order=9)
    var publicAccessGuid:UUID? = null
}

open class UsersBoxesAddResponse
{
    @DataMember(Order=2)
    var appUserId:Long? = null

    @DataMember(Order=3)
    var authAppUserId:Long? = null

    @DataMember(Order=4)
    var deploymentDate:Date? = null

    @DataMember(Order=5)
    var numberBoxes:Int? = null

    @DataMember(Order=6)
    var recipientType:String? = null

    @DataMember(Order=7)
    var foodGardensId:Long? = null

    @DataMember(Order=8)
    var otherDescription:String? = null

    @DataMember(Order=9)
    var publicAccessGuid:UUID? = null

    @DataMember(Order=10)
    var responseStatus:ResponseStatus? = null
}

Kotlin UsersBoxesAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

{"appUserId":0,"authAppUserId":0,"deploymentDate":"\/Date(-62135596800000-0000)\/","numberBoxes":0,"recipientType":"String","foodGardensId":0,"otherDescription":"String","publicAccessGuid":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"appUserId":0,"authAppUserId":0,"deploymentDate":"\/Date(-62135596800000-0000)\/","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"}}}