sfgboxapi

<back to all web services

UsersBoxesEdit

Requires Authentication
The following routes are available for this service:
PUT/users_boxes/{Id}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class UsersBoxesEdit
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long id = null;

        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Long appUserId = null;

        @DataMember(Order=3)
        @Validate(Validator="NotNull")
        public Long authAppUserId = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public Date deploymentDate = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public Integer numberBoxes = null;

        @DataMember(Order=6)
        @Validate(Validator="NotNull")
        public String recipientType = null;

        @DataMember(Order=7)
        public Long foodGardensId = null;

        @DataMember(Order=8)
        public String otherDescription = null;
        
        public Long getId() { return id; }
        public UsersBoxesEdit setId(Long value) { this.id = value; return this; }
        public Long getAppUserId() { return appUserId; }
        public UsersBoxesEdit setAppUserId(Long value) { this.appUserId = value; return this; }
        public Long getAuthAppUserId() { return authAppUserId; }
        public UsersBoxesEdit setAuthAppUserId(Long value) { this.authAppUserId = value; return this; }
        public Date getDeploymentDate() { return deploymentDate; }
        public UsersBoxesEdit setDeploymentDate(Date value) { this.deploymentDate = value; return this; }
        public Integer getNumberBoxes() { return numberBoxes; }
        public UsersBoxesEdit setNumberBoxes(Integer value) { this.numberBoxes = value; return this; }
        public String getRecipientType() { return recipientType; }
        public UsersBoxesEdit setRecipientType(String value) { this.recipientType = value; return this; }
        public Long getFoodGardensId() { return foodGardensId; }
        public UsersBoxesEdit setFoodGardensId(Long value) { this.foodGardensId = value; return this; }
        public String getOtherDescription() { return otherDescription; }
        public UsersBoxesEdit setOtherDescription(String value) { this.otherDescription = value; return this; }
    }

    public static class UsersBoxesEditResponse
    {
        @DataMember(Order=1)
        public Long id = null;

        @DataMember(Order=2)
        public Long appUserId = null;

        @DataMember(Order=3)
        public Long authAppUserId = null;

        @DataMember(Order=4)
        public Date deploymentDate = null;

        @DataMember(Order=5)
        public Integer numberBoxes = null;

        @DataMember(Order=6)
        public String recipientType = null;

        @DataMember(Order=7)
        public Long foodGardensId = null;

        @DataMember(Order=8)
        public String otherDescription = null;

        @DataMember(Order=10)
        public ResponseStatus responseStatus = null;
        
        public Long getId() { return id; }
        public UsersBoxesEditResponse setId(Long value) { this.id = value; return this; }
        public Long getAppUserId() { return appUserId; }
        public UsersBoxesEditResponse setAppUserId(Long value) { this.appUserId = value; return this; }
        public Long getAuthAppUserId() { return authAppUserId; }
        public UsersBoxesEditResponse setAuthAppUserId(Long value) { this.authAppUserId = value; return this; }
        public Date getDeploymentDate() { return deploymentDate; }
        public UsersBoxesEditResponse setDeploymentDate(Date value) { this.deploymentDate = value; return this; }
        public Integer getNumberBoxes() { return numberBoxes; }
        public UsersBoxesEditResponse setNumberBoxes(Integer value) { this.numberBoxes = value; return this; }
        public String getRecipientType() { return recipientType; }
        public UsersBoxesEditResponse setRecipientType(String value) { this.recipientType = value; return this; }
        public Long getFoodGardensId() { return foodGardensId; }
        public UsersBoxesEditResponse setFoodGardensId(Long value) { this.foodGardensId = value; return this; }
        public String getOtherDescription() { return otherDescription; }
        public UsersBoxesEditResponse setOtherDescription(String value) { this.otherDescription = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public UsersBoxesEditResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java UsersBoxesEdit DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<UsersBoxesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <AppUserId>0</AppUserId>
  <AuthAppUserId>0</AuthAppUserId>
  <DeploymentDate>0001-01-01T00:00:00</DeploymentDate>
  <NumberBoxes>0</NumberBoxes>
  <RecipientType>String</RecipientType>
  <FoodGardensId>0</FoodGardensId>
  <OtherDescription>String</OtherDescription>
</UsersBoxesEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersBoxesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId>0</AppUserId>
  <AuthAppUserId>0</AuthAppUserId>
  <DeploymentDate>0001-01-01T00:00:00</DeploymentDate>
  <FoodGardensId>0</FoodGardensId>
  <Id>0</Id>
  <NumberBoxes>0</NumberBoxes>
  <OtherDescription>String</OtherDescription>
  <RecipientType>String</RecipientType>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UsersBoxesEditResponse>