sfgboxapi

<back to all web services

UsersBoxesAdd

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

export class UsersBoxesAddResponse
{
    // @DataMember(Order=2)
    public appUserId: number;

    // @DataMember(Order=3)
    public authAppUserId: number;

    // @DataMember(Order=4)
    public deploymentDate: string;

    // @DataMember(Order=5)
    public numberBoxes: number;

    // @DataMember(Order=6)
    public recipientType: string;

    // @DataMember(Order=7)
    public foodGardensId?: number;

    // @DataMember(Order=8)
    public otherDescription: string;

    // @DataMember(Order=9)
    public publicAccessGuid: string;

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

    public constructor(init?: Partial<UsersBoxesAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UsersBoxesAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public appUserId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public authAppUserId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public deploymentDate: string;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public numberBoxes: number;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public recipientType: string;

    // @DataMember(Order=7)
    public foodGardensId?: number;

    // @DataMember(Order=8)
    public otherDescription: string;

    // @DataMember(Order=9)
    public publicAccessGuid: string;

    public constructor(init?: Partial<UsersBoxesAdd>) { (Object as any).assign(this, init); }
}

TypeScript 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: api.sfgtec.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"}}}