sfgboxapi

CompanionsEdit

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

import 'package:servicestack/servicestack.dart';

class CompanionsEditResponse implements IConvertible
{
    // @DataMember(Order=1)
    int? id;

    // @DataMember(Order=2)
    int? tenantsId;

    // @DataMember(Order=3)
    int? zonesId;

    // @DataMember(Order=4)
    int? cropsId;

    // @DataMember(Order=5)
    int? companionCropsId;

    // @DataMember(Order=7)
    ResponseStatus? responseStatus;

    CompanionsEditResponse({this.id,this.tenantsId,this.zonesId,this.cropsId,this.companionCropsId,this.responseStatus});
    CompanionsEditResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        tenantsId = json['tenantsId'];
        zonesId = json['zonesId'];
        cropsId = json['cropsId'];
        companionCropsId = json['companionCropsId'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'tenantsId': tenantsId,
        'zonesId': zonesId,
        'cropsId': cropsId,
        'companionCropsId': companionCropsId,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "CompanionsEditResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class CompanionsEdit implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    int? id;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    int? tenantsId;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    int? zonesId;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    int? cropsId;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    int? companionCropsId;

    CompanionsEdit({this.id,this.tenantsId,this.zonesId,this.cropsId,this.companionCropsId});
    CompanionsEdit.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        tenantsId = json['tenantsId'];
        zonesId = json['zonesId'];
        cropsId = json['cropsId'];
        companionCropsId = json['companionCropsId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'tenantsId': tenantsId,
        'zonesId': zonesId,
        'cropsId': cropsId,
        'companionCropsId': companionCropsId
    };

    getTypeName() => "CompanionsEdit";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'sfgboxapi.dev.scadsoftware.com', types: <String, TypeInfo> {
    'CompanionsEditResponse': TypeInfo(TypeOf.Class, create:() => CompanionsEditResponse()),
    'CompanionsEdit': TypeInfo(TypeOf.Class, create:() => CompanionsEdit()),
});

Dart 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>