Pecuario.Backend

<back to all web services

GetFarms

Requires Authentication
The following routes are available for this service:
GET/api/v1/farms

export class Status
{
    public message: string;
    public statusCode: number;

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

export class BaseResponse
{
    public status: Status;

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

export class Farm
{
    public id: number;
    // @References("typeof(Pecuario.Backend.Domain.Entities.AppUser)")
    public userId: number;

    // @Required()
    // @StringLength(100)
    public name: string;

    // @References("typeof(Pecuario.Backend.Domain.Entities.Region)")
    public regionId?: number;

    // @References("typeof(Pecuario.Backend.Domain.Entities.MeasurementUnit)")
    public measurementUnitId?: number;

    public area?: number;

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

export class GetFarmsResponse extends BaseResponse
{
    public farms: Farm[];

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

export class GetFarms implements IGet
{

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

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

GET /api/v1/farms HTTP/1.1 
Host: pecuario-backend.develsystems.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"farms":[{"id":0,"userId":0,"name":"String","regionId":0,"measurementUnitId":0,"area":0}]}