| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /messages/log | Search the message log for any messages | Search the message log for any messages. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class MessageLogQuery : QueryDb<MessageLog, MessageLogQueryResponse>(), ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", ParameterType="path")
var CompanyId:UUID? = null
/**
* If you want to search on sent messages
*/
@ApiMember(DataType="boolean", Description="If you want to search on sent messages", ParameterType="query")
var Sent:Boolean? = null
/**
* Message Id
*/
@ApiMember(DataType="int", Description="Message Id", ParameterType="query")
var Id:Int? = null
/**
* If you want to search on a messages for a specific booking
*/
@ApiMember(DataType="int", Description="If you want to search on a messages for a specific booking", ParameterType="query")
var BookingId:Int? = null
/**
* If you want to search on a messages for a specific receiver
*/
@ApiMember(DataType="string", Description="If you want to search on a messages for a specific receiver", ParameterType="query")
var Receiver:String? = null
/**
* If you want to search on a messages created a specific date
*/
@ApiMember(DataType="datetime", Description="If you want to search on a messages created a specific date", ParameterType="query")
var Created:Date? = null
/**
* If you want to search on a messages sent a specific date
*/
@ApiMember(DataType="datetime", Description="If you want to search on a messages sent a specific date", ParameterType="query")
var SentDate:Date? = null
var ResponseStatus:ResponseStatus? = null
}
open class QueryDb<From, Into> : QueryBase()
{
}
@DataContract
open class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
@DataMember(Order=1)
var Skip:Int? = null
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
@DataMember(Order=2)
var Take:Int? = null
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
@DataMember(Order=3)
var OrderBy:String? = null
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
@DataMember(Order=4)
var OrderByDesc:String? = null
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
@DataMember(Order=5)
var Include:String? = null
@DataMember(Order=6)
var Fields:String? = null
@DataMember(Order=7)
var Meta:HashMap<String,String> = HashMap<String,String>()
}
open class MessageLog : BaseModel(), IMessageLog
{
var BookingId:Int? = null
@Required()
var PublicMessage:Boolean? = null
@Required()
var MessageType:Int? = null
@Required()
var iCalAttachment:Boolean? = null
@Required()
var SenderName:String? = null
var ModifiedDate:Date? = null
var CorrelationId:UUID? = null
@Required()
var CompanyId:UUID? = null
var Id:Int? = null
@Required()
var Receiver:String? = null
@Required()
var Sender:String? = null
var MessageTitle:String? = null
@Required()
var MessageBody:String? = null
var CreatedBy:String? = null
@Required()
var Created:Date? = null
@Required()
var Sent:Boolean? = null
@Required()
var ToSendDate:Date? = null
var SentDate:Date? = null
@Required()
var SendMethodId:Int? = null
var MessageCount:Int? = null
var SMSStatus:Int? = null
@Required()
var MessageRetries:Int? = null
var StorageUrl:String? = null
var Language:String? = null
}
open class BaseModel
{
}
open class MessageLogQueryResponse
{
/**
* The message log id
*/
@ApiMember(Description="The message log id")
var Id:Int? = null
/**
* The booking id for the message (if connected to a booking).
*/
@ApiMember(Description="The booking id for the message (if connected to a booking).")
var BookingId:Int? = null
/**
* The message receiver. Either a email or a mobile phone number.
*/
@ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
var Receiver:String? = null
/**
* Message Title.
*/
@ApiMember(Description="Message Title.")
var MessageTitle:String? = null
/**
* Message Storage Url.
*/
@ApiMember(Description="Message Storage Url.")
var StorageUrl:String? = null
/**
* Message Body.
*/
@ApiMember(Description="Message Body.")
var MessageBody:String? = null
/**
* When message was created.
*/
@ApiMember(Description="When message was created.")
var Created:Date? = null
/**
* When the message will be sent.
*/
@ApiMember(Description="When the message will be sent.")
var ToSendDate:Date? = null
/**
* When the message was sent.
*/
@ApiMember(Description="When the message was sent.")
var SentDate:Date? = null
/**
* If Message is sent
*/
@ApiMember(Description="If Message is sent")
var Sent:Boolean? = null
/**
* Number of retries to send the message
*/
@ApiMember(Description="Number of retries to send the message")
var MessageRetries:Int? = null
/**
* Send Method. 1 = Email, 2 = SMS
*/
@ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
var SendMethodId:Int? = null
}
@DataContract
open class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
var Offset:Int? = null
@DataMember(Order=2)
var Total:Int? = null
@DataMember(Order=3)
var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()
@DataMember(Order=4)
var Meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
var Id:Int? = null
var KeyType:String? = null
var Description:String? = null
}
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.
GET /messages/log HTTP/1.1 Host: api.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"BookingId":0,"Receiver":"String","MessageTitle":"String","StorageUrl":"String","MessageBody":"String","SentDate":"0001-01-01T00:00:00","Sent":false,"MessageRetries":0,"SendMethodId":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}