sfgboxapi

<back to all web services

UsersBoxesAdd

The following routes are available for this service:
POST/users_boxes
import Foundation
import ServiceStack

// @DataContract
public class UsersBoxesAdd : Codable
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var appUserId:Int

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var authAppUserId:Int

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var deploymentDate:Date

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public var numberBoxes:Int

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public var recipientType:String

    // @DataMember(Order=7)
    public var foodGardensId:Int?

    // @DataMember(Order=8)
    public var otherDescription:String

    // @DataMember(Order=9)
    public var publicAccessGuid:String

    required public init(){}
}

public class UsersBoxesAddResponse : Codable
{
    // @DataMember(Order=2)
    public var appUserId:Int

    // @DataMember(Order=3)
    public var authAppUserId:Int

    // @DataMember(Order=4)
    public var deploymentDate:Date

    // @DataMember(Order=5)
    public var numberBoxes:Int

    // @DataMember(Order=6)
    public var recipientType:String

    // @DataMember(Order=7)
    public var foodGardensId:Int?

    // @DataMember(Order=8)
    public var otherDescription:String

    // @DataMember(Order=9)
    public var publicAccessGuid:String

    // @DataMember(Order=10)
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift UsersBoxesAdd DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"}}}