| POST | /schedule/getschedule |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.AppApi.Models;
using WebService.AppApi.Models.Base;
namespace WebService.AppApi.Models
{
public partial class GetScheduleRequest
: ApiServiceRequest
{
public virtual DateTime FromDate { get; set; }
public virtual DateTime ToDate { get; set; }
}
public partial class GetScheduleResponse
: ApiServiceResponse
{
public GetScheduleResponse()
{
DateItems = new List<ScheduleDateItem>{};
}
public virtual List<ScheduleDateItem> DateItems { get; set; }
}
public partial class ScheduleDateItem
{
public ScheduleDateItem()
{
ScheduleItems = new List<ScheduleItems>{};
}
public virtual DateTime Date { get; set; }
public virtual string FormattedDateString { get; set; }
public virtual List<ScheduleItems> ScheduleItems { get; set; }
}
public partial class ScheduleItems
{
public virtual string OutletName { get; set; }
public virtual string PrincipalName { get; set; }
public virtual string ReferenceNumber { get; set; }
public virtual bool IsSubmitted { get; set; }
}
}
namespace WebService.AppApi.Models.Base
{
public partial class ApiServiceRequest
: IServiceRequest, IHasApiKey, IHasDeviceInfo
{
///<summary>
///The API Key required for authentication
///</summary>
[ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
public virtual string ApiKey { get; set; }
///<summary>
///Latitude of the user making this request
///</summary>
[ApiMember(DataType="double", Description="Latitude of the user making this request")]
public virtual double Latitude { get; set; }
///<summary>
///Longitude of the user making this request
///</summary>
[ApiMember(DataType="double", Description="Longitude of the user making this request")]
public virtual double Longitude { get; set; }
}
public partial class ApiServiceResponse
: IServiceResponse
{
///<summary>
///Information about the response.
///</summary>
[ApiMember(Description="Information about the response.", IsRequired=true)]
public virtual string Description { get; set; }
///<summary>
///Heading or summary of the response.
///</summary>
[ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
public virtual string Heading { get; set; }
///<summary>
///Did the intended operation for this response complete successfully?
///</summary>
[ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)]
public virtual bool WasSuccessful { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /schedule/getschedule HTTP/1.1
Host: returnit-api-dev.happen.zone
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FromDate: 0001-01-01,
ToDate: 0001-01-01,
ApiKey: String,
Latitude: 0,
Longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
DateItems:
[
{
}
],
Description: String,
Heading: String,
WasSuccessful: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}