sfgboxapi

<back to all web services

CompetitorsEdit

Requires Authentication
The following routes are available for this service:
PUT/competitors/{Id}

export class CompetitorsEditResponse
{
    // @DataMember(Order=1)
    public id: number;

    // @DataMember(Order=2)
    public tenantsId: number;

    // @DataMember(Order=3)
    public zonesId: number;

    // @DataMember(Order=4)
    public cropsId: number;

    // @DataMember(Order=5)
    public competitorCropsId: number;

    // @DataMember(Order=6)
    public penaltyPercentage: number;

    // @DataMember(Order=8)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<CompetitorsEditResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CompetitorsEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public id: number;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public tenantsId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public zonesId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public cropsId: number;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public competitorCropsId: number;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public penaltyPercentage: number;

    public constructor(init?: Partial<CompetitorsEdit>) { (Object as any).assign(this, init); }
}

TypeScript CompetitorsEdit 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.

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

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

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