sfgboxapi

<back to all web services

CompanionsEdit

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

// @DataContract
public class CompanionsEdit : 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 companionCropsId:Int

    required public init(){}
}

public class CompanionsEditResponse : 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 companionCropsId:Int

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

    required public init(){}
}


Swift CompanionsEdit DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"id":0,"tenantsId":0,"zonesId":0,"cropsId":0,"companionCropsId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":0,"tenantsId":0,"zonesId":0,"cropsId":0,"companionCropsId":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}