Antel Merchandiser App API

<back to all web services

LogAttendanceEventRequest

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

public class dtos
{

    public static class LogAttendanceEventRequest extends ApiServiceRequest
    {
        public AttendanceType Type = null;
        
        public AttendanceType getType() { return Type; }
        public LogAttendanceEventRequest setType(AttendanceType value) { this.Type = 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; }
    }

    @Flags()
    public static enum AttendanceType
    {
        @SerializedName("0") ClockedIn(0),
        @SerializedName("1") ClockedOut(1);

        private final int value;
        AttendanceType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class AttendanceResponse extends ApiServiceResponse
    {
        public Double ClockedInSessionsForDay = null;
        public AttendanceType Type = null;
        public String TypeString = null;
        
        public Double getClockedInSessionsForDay() { return ClockedInSessionsForDay; }
        public AttendanceResponse setClockedInSessionsForDay(Double value) { this.ClockedInSessionsForDay = value; return this; }
        public AttendanceType getType() { return Type; }
        public AttendanceResponse setType(AttendanceType value) { this.Type = value; return this; }
        public String getTypeString() { return TypeString; }
        public AttendanceResponse setTypeString(String value) { this.TypeString = 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; }
    }

}

Java LogAttendanceEventRequest 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 /attendance/log HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Type: 0,
	ApiKey: String,
	Latitude: 0,
	Longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ClockedInSessionsForDay: 0,
	Type: 0,
	TypeString: Clocked In,
	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
		}
	}
}