| POST | /schedule/getschedule |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetScheduleRequest : ApiServiceRequest()
{
var FromDate:Date? = null
var ToDate:Date? = null
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var ApiKey:String? = null
/**
* Latitude of the user making this request
*/
@ApiMember(DataType="double", Description="Latitude of the user making this request")
var Latitude:Double? = null
/**
* Longitude of the user making this request
*/
@ApiMember(DataType="double", Description="Longitude of the user making this request")
var Longitude:Double? = null
}
open class GetScheduleResponse : ApiServiceResponse()
{
var DateItems:ArrayList<ScheduleDateItem> = ArrayList<ScheduleDateItem>()
}
open class ApiServiceResponse : IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
var Description:String? = null
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
var Heading:String? = 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)
var WasSuccessful:Boolean? = null
var ResponseStatus:ResponseStatus? = null
}
open class ScheduleDateItem
{
var Date:Date? = null
var FormattedDateString:String? = null
var ScheduleItems:ArrayList<ScheduleItems> = ArrayList<ScheduleItems>()
}
open class ScheduleItems
{
var OutletName:String? = null
var PrincipalName:String? = null
var ReferenceNumber:String? = null
var IsSubmitted:Boolean? = null
}
Kotlin GetScheduleRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
Content-Length: length
{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}