Antel Merchandiser App API

<back to all web services

GetScheduleRequest

Requires Authentication
The following routes are available for this service:
POST/schedule/getschedule
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetScheduleRequest extends ApiServiceRequest
    {
        public Date FromDate = null;
        public Date ToDate = null;
        
        public Date getFromDate() { return FromDate; }
        public GetScheduleRequest setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public GetScheduleRequest setToDate(Date value) { this.ToDate = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String ApiKey = null;

        /**
        * Latitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Latitude of the user making this request")
        public Double Latitude = null;

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double Longitude = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Double getLatitude() { return Latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.Latitude = value; return this; }
        public Double getLongitude() { return Longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.Longitude = value; return this; }
    }

    public static class GetScheduleResponse extends ApiServiceResponse
    {
        public ArrayList<ScheduleDateItem> DateItems = null;
        
        public ArrayList<ScheduleDateItem> getDateItems() { return DateItems; }
        public GetScheduleResponse setDateItems(ArrayList<ScheduleDateItem> value) { this.DateItems = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        /**
        * Information about the response.
        */
        @ApiMember(Description="Information about the response.", IsRequired=true)
        public String Description = null;

        /**
        * Heading or summary of the response.
        */
        @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
        public String Heading = null;

        /**
        * Did the intended operation for this response complete successfully?
        */
        @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
        public Boolean WasSuccessful = null;

        public ResponseStatus ResponseStatus = null;
        
        public String getDescription() { return Description; }
        public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
        public String getHeading() { return Heading; }
        public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
        public Boolean isWasSuccessful() { return WasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ScheduleDateItem
    {
        public Date Date = null;
        public String FormattedDateString = null;
        public ArrayList<ScheduleItems> ScheduleItems = null;
        
        public Date getDate() { return Date; }
        public ScheduleDateItem setDate(Date value) { this.Date = value; return this; }
        public String getFormattedDateString() { return FormattedDateString; }
        public ScheduleDateItem setFormattedDateString(String value) { this.FormattedDateString = value; return this; }
        public ArrayList<ScheduleItems> getScheduleItems() { return ScheduleItems; }
        public ScheduleDateItem setScheduleItems(ArrayList<ScheduleItems> value) { this.ScheduleItems = value; return this; }
    }

    public static class ScheduleItems
    {
        public String OutletName = null;
        public String PrincipalName = null;
        public String ReferenceNumber = null;
        public Boolean IsSubmitted = null;
        
        public String getOutletName() { return OutletName; }
        public ScheduleItems setOutletName(String value) { this.OutletName = value; return this; }
        public String getPrincipalName() { return PrincipalName; }
        public ScheduleItems setPrincipalName(String value) { this.PrincipalName = value; return this; }
        public String getReferenceNumber() { return ReferenceNumber; }
        public ScheduleItems setReferenceNumber(String value) { this.ReferenceNumber = value; return this; }
        public Boolean getIsSubmitted() { return IsSubmitted; }
        public ScheduleItems setIsSubmitted(Boolean value) { this.IsSubmitted = value; return this; }
    }

}

Java GetScheduleRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}