sfgboxapi

<back to all web services

CompanionsEdit

Requires Authentication
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: 'api.sfgtec.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 .jsv suffix or ?format=jsv

HTTP + JSV

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: api.sfgtec.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	zonesId: 0,
	cropsId: 0,
	companionCropsId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}