sfgboxapi

<back to all web services

CompanionsAdd

Requires Authentication
The following routes are available for this service:
POST/companions
"use strict";
export class CompanionsAddResponse {
    /** @param {{tenantsId?:number,zonesId?:number,cropsId?:number,companionCropsId?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    zonesId;
    /** @type {number} */
    cropsId;
    /** @type {number} */
    companionCropsId;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class CompanionsAdd {
    /** @param {{tenantsId?:number,zonesId?:number,cropsId?:number,companionCropsId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    zonesId;
    /** @type {number} */
    cropsId;
    /** @type {number} */
    companionCropsId;
}

JavaScript CompanionsAdd DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"tenantsId":0,"zonesId":0,"cropsId":0,"companionCropsId":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}