sfgboxapi

<back to all web services

CompetitorsEdit

Requires Authentication
The following routes are available for this service:
PUT/competitors/{Id}
"use strict";
export class CompetitorsEditResponse {
    /** @param {{id?:number,tenantsId?:number,zonesId?:number,cropsId?:number,competitorCropsId?:number,penaltyPercentage?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    zonesId;
    /** @type {number} */
    cropsId;
    /** @type {number} */
    competitorCropsId;
    /** @type {number} */
    penaltyPercentage;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class CompetitorsEdit {
    /** @param {{id?:number,tenantsId?:number,zonesId?:number,cropsId?:number,competitorCropsId?:number,penaltyPercentage?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    zonesId;
    /** @type {number} */
    cropsId;
    /** @type {number} */
    competitorCropsId;
    /** @type {number} */
    penaltyPercentage;
}

JavaScript CompetitorsEdit DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /competitors/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"tenantsId":0,"zonesId":0,"cropsId":0,"competitorCropsId":0,"penaltyPercentage":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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