sfgboxapi

<back to all web services

UsersBoxesEdit

Requires Authentication
The following routes are available for this service:
PUT/users_boxes/{Id}
UsersBoxesEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathlongYes
AppUserIdbodylongYes
AuthAppUserIdbodylongYes
DeploymentDatebodyDateTimeYes
NumberBoxesbodyintYes
RecipientTypebodystringYes
FoodGardensIdbodylong?No
OtherDescriptionbodystringNo
UsersBoxesEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AppUserIdformlongNo
AuthAppUserIdformlongNo
DeploymentDateformDateTimeNo
NumberBoxesformintNo
RecipientTypeformstringNo
FoodGardensIdformlong?No
OtherDescriptionformstringNo
ResponseStatusformResponseStatusNo

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: sfgboxapi.dev.scadsoftware.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"}}}