sfgboxapi

CompanionsEdit

The following routes are available for this service:
PUT	/companions/{Id}

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

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

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

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

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public Long cropsId = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public Long companionCropsId = null;
        
        public Long getId() { return id; }
        public CompanionsEdit setId(Long value) { this.id = value; return this; }
        public Long getTenantsId() { return tenantsId; }
        public CompanionsEdit setTenantsId(Long value) { this.tenantsId = value; return this; }
        public Long getZonesId() { return zonesId; }
        public CompanionsEdit setZonesId(Long value) { this.zonesId = value; return this; }
        public Long getCropsId() { return cropsId; }
        public CompanionsEdit setCropsId(Long value) { this.cropsId = value; return this; }
        public Long getCompanionCropsId() { return companionCropsId; }
        public CompanionsEdit setCompanionCropsId(Long value) { this.companionCropsId = value; return this; }
    }

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

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

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

        @DataMember(Order=4)
        public Long cropsId = null;

        @DataMember(Order=5)
        public Long companionCropsId = null;

        @DataMember(Order=7)
        public ResponseStatus responseStatus = null;
        
        public Long getId() { return id; }
        public CompanionsEditResponse setId(Long value) { this.id = value; return this; }
        public Long getTenantsId() { return tenantsId; }
        public CompanionsEditResponse setTenantsId(Long value) { this.tenantsId = value; return this; }
        public Long getZonesId() { return zonesId; }
        public CompanionsEditResponse setZonesId(Long value) { this.zonesId = value; return this; }
        public Long getCropsId() { return cropsId; }
        public CompanionsEditResponse setCropsId(Long value) { this.cropsId = value; return this; }
        public Long getCompanionCropsId() { return companionCropsId; }
        public CompanionsEditResponse setCompanionCropsId(Long value) { this.companionCropsId = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CompanionsEditResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java CompanionsEdit 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 /companions/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CompanionsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <ZonesId>0</ZonesId>
  <CropsId>0</CropsId>
  <CompanionCropsId>0</CompanionCropsId>
</CompanionsEdit>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanionsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <CompanionCropsId>0</CompanionCropsId>
  <CropsId>0</CropsId>
  <Id>0</Id>
  <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>
  <TenantsId>0</TenantsId>
  <ZonesId>0</ZonesId>
</CompanionsEditResponse>