sfgboxapi

<back to all web services

CompanionsAdd

Requires Authentication
The following routes are available for this service:
POST/companions

export class CompanionsAddResponse
{
    // @DataMember(Order=2)
    public tenantsId: number;

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

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

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

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

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

// @DataContract
export class CompanionsAdd
{
    // @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 companionCropsId: number;

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

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

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

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

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