GET | /cars |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Cars;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces;
using Application.Interfaces.Resources;
namespace Application.Interfaces
{
public partial class Filtering
{
public Filtering()
{
Fields = new List<string>{};
}
public virtual List<string> Fields { get; set; }
public virtual string Search { get; set; }
}
public partial class SearchMetadata
{
public virtual int Total { get; set; }
public virtual int Limit { get; set; }
public virtual int Offset { get; set; }
public virtual Sorting Sort { get; set; }
public virtual Filtering Filter { get; set; }
}
public enum SortDirection
{
Ascending,
Descending,
}
public partial class Sorting
{
public virtual string By { get; set; }
public virtual SortDirection Direction { get; set; }
}
}
namespace Application.Interfaces.Resources
{
public partial class Car
: IIdentifiableResource
{
public Car()
{
Managers = new List<CarManager>{};
}
public virtual CarManufacturer Manufacturer { get; set; }
public virtual CarLicensePlate Plate { get; set; }
public virtual CarOwner Owner { get; set; }
public virtual List<CarManager> Managers { get; set; }
public virtual string Status { get; set; }
public virtual bool? Altered { get; set; }
public virtual string Id { get; set; }
}
public partial class CarLicensePlate
{
public virtual string Jurisdiction { get; set; }
public virtual string Number { get; set; }
}
public partial class CarManager
{
public virtual string Id { get; set; }
}
public partial class CarManufacturer
{
public virtual int Year { get; set; }
public virtual string Make { get; set; }
public virtual string Model { get; set; }
}
public partial class CarOwner
{
public virtual string Id { get; set; }
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations
{
public partial class GetOperationUnTenanted<TResponse>
: IHasGetOptions, IGet
{
public virtual string Embed { get; set; }
}
public partial class SearchOperationResponse
{
public virtual SearchMetadata Metadata { get; set; }
}
public partial class SearchOperationTenanted<TResponse>
: SearchOperationUnTenanted<TResponse>, ITenantedRequest
{
public virtual string OrganisationId { get; set; }
}
public partial class SearchOperationUnTenanted<TResponse>
: GetOperationUnTenanted<TResponse>, IHasSearchOptions
{
public virtual string Distinct { get; set; }
public virtual int? Limit { get; set; }
public virtual int? Offset { get; set; }
public virtual string Sort { get; set; }
public virtual string Filter { get; set; }
public virtual string Search { get; set; }
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations.Cars
{
public partial class SearchAllCarsRequest
: SearchOperationTenanted<SearchAllCarsResponse>
{
}
public partial class SearchAllCarsResponse
: SearchOperationResponse
{
public SearchAllCarsResponse()
{
Cars = new List<Car>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<Car> Cars { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /cars HTTP/1.1 Host: staging-api.billiecart.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"cars":[{"manufacturer":{"year":0,"make":"String","model":"String"},"plate":{"jurisdiction":"String","number":"String"},"owner":{"id":"String"},"managers":[{"id":"String"}],"status":"String","altered":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}