Requires the role: | manager |
GET | /cars/models |
---|
export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
public embed?: string;
public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
public distinct?: string;
public limit?: number;
public offset?: number;
public sort?: string;
public filter?: string;
public search?: string;
public constructor(init?: Partial<SearchOperationUnTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}
export enum SortDirection
{
Ascending = 'Ascending',
Descending = 'Descending',
}
export class Sorting
{
public by?: string;
public direction: SortDirection;
public constructor(init?: Partial<Sorting>) { (Object as any).assign(this, init); }
}
export class Filtering
{
public fields?: string[];
public search?: string;
public constructor(init?: Partial<Filtering>) { (Object as any).assign(this, init); }
}
export class SearchMetadata
{
public total: number;
public limit: number;
public offset: number;
public sort?: Sorting;
public filter?: Filtering;
public constructor(init?: Partial<SearchMetadata>) { (Object as any).assign(this, init); }
}
export class SearchOperationResponse
{
public metadata?: SearchMetadata;
public constructor(init?: Partial<SearchOperationResponse>) { (Object as any).assign(this, init); }
}
export class CarModel
{
public make?: string;
public model?: string;
public constructor(init?: Partial<CarModel>) { (Object as any).assign(this, init); }
}
export class SearchAllModelsResponse extends SearchOperationResponse
{
public responseStatus?: ResponseStatus;
public models?: CarModel[];
public constructor(init?: Partial<SearchAllModelsResponse>) { super(init); (Object as any).assign(this, init); }
}
export class SearchAllModelsRequest extends SearchOperationUnTenanted<SearchAllModelsResponse>
{
public make?: string;
public constructor(init?: Partial<SearchAllModelsRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript SearchAllModelsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /cars/models HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SearchAllModelsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Cars"> <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations"> <d2p1:Filter> <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </d2p1:Fields> <d2p1:Search>String</d2p1:Search> </d2p1:Filter> <d2p1:Limit>0</d2p1:Limit> <d2p1:Offset>0</d2p1:Offset> <d2p1:Sort> <d2p1:By>String</d2p1:By> <d2p1:Direction>Ascending</d2p1:Direction> </d2p1:Sort> <d2p1:Total>0</d2p1:Total> </Metadata> <Models xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources"> <d2p1:CarModel> <d2p1:Make>String</d2p1:Make> <d2p1:Model>String</d2p1:Model> </d2p1:CarModel> </Models> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> </SearchAllModelsResponse>