sfgboxapi

<back to all web services

CompetitorsEdit

Requires Authentication
The following routes are available for this service:
PUT/competitors/{Id}
import Foundation
import ServiceStack

// @DataContract
public class CompetitorsEdit : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var id:Int

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var tenantsId:Int

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var zonesId:Int

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var cropsId:Int

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public var competitorCropsId:Int

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public var penaltyPercentage:Double

    required public init(){}
}

public class CompetitorsEditResponse : Codable
{
    // @DataMember(Order=1)
    public var id:Int

    // @DataMember(Order=2)
    public var tenantsId:Int

    // @DataMember(Order=3)
    public var zonesId:Int

    // @DataMember(Order=4)
    public var cropsId:Int

    // @DataMember(Order=5)
    public var competitorCropsId:Int

    // @DataMember(Order=6)
    public var penaltyPercentage:Double

    // @DataMember(Order=8)
    public var responseStatus:ResponseStatus

    required public init(){}
}

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

<CompetitorsEdit 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>
  <CompetitorCropsId>0</CompetitorCropsId>
  <PenaltyPercentage>0</PenaltyPercentage>
</CompetitorsEdit>

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

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