sfgboxapi

<back to all web services

CompanionsAdd

Requires Authentication
The following routes are available for this service:
POST/companions
import 'package:servicestack/servicestack.dart';

class CompanionsAddResponse implements IConvertible
{
    // @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;

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

    fromMap(Map<String, dynamic> json) {
        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() => {
        'tenantsId': tenantsId,
        'zonesId': zonesId,
        'cropsId': cropsId,
        'companionCropsId': companionCropsId,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

// @DataContract
class CompanionsAdd implements IConvertible
{
    // @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;

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

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

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

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

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

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

POST /companions HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	zonesId: 0,
	cropsId: 0,
	companionCropsId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	}
}