sfgboxapi

<back to all web services

UsersBoxesEdit

Requires Authentication
The following routes are available for this service:
PUT/users_boxes/{Id}

export class UsersBoxesEditResponse
{
    // @DataMember(Order=1)
    public id: number;

    // @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=10)
    public responseStatus: ResponseStatus;

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

// @DataContract
export class UsersBoxesEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public id: number;

    // @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;

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

TypeScript UsersBoxesEdit 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.

PUT /users_boxes/{Id} HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"appUserId":0,"authAppUserId":0,"deploymentDate":"\/Date(-62135596800000-0000)\/","numberBoxes":0,"recipientType":"String","foodGardensId":0,"otherDescription":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":0,"appUserId":0,"authAppUserId":0,"deploymentDate":"\/Date(-62135596800000-0000)\/","numberBoxes":0,"recipientType":"String","foodGardensId":0,"otherDescription":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}