| 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 java.io.InputStream
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")
override 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")
open var Sent:Boolean? = null
/**
* Message Id
*/
@ApiMember(DataType="int", Description="Message Id", ParameterType="query")
open 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")
open 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")
open 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")
open 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")
open var SentDate:Date? = null
open 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)
open 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)
open 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)
open 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)
open 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)
open var Include:String? = null
@DataMember(Order=6)
open var Fields:String? = null
@DataMember(Order=7)
open var Meta:HashMap<String,String>? = null
}
open class MessageLog : BaseModel()
{
open var BookingId:Int? = null
@Required()
open var PublicMessage:Boolean? = null
@Required()
open var MessageType:Int? = null
@Required()
open var iCalAttachment:Boolean? = null
@Required()
open var SenderName:String? = null
open var ModifiedDate:Date? = null
open var CorrelationId:UUID? = null
@Required()
open var CompanyId:UUID? = null
open var Id:Int? = null
@Required()
open var Receiver:String? = null
@Required()
open var Sender:String? = null
open var MessageTitle:String? = null
@Required()
open var MessageBody:String? = null
open var CreatedBy:String? = null
@Required()
open var Created:Date? = null
@Required()
open var Sent:Boolean? = null
@Required()
open var ToSendDate:Date? = null
open var SentDate:Date? = null
@Required()
open var SendMethodId:Int? = null
open var MessageCount:Int? = null
open var SMSStatus:Int? = null
@Required()
open var MessageRetries:Int? = null
open var StorageUrl:String? = null
open var Language:String? = null
}
open class BaseModel
{
}
open class MessageLogQueryResponse
{
/**
* The message log id
*/
@ApiMember(Description="The message log id")
open 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).")
open 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.")
open var Receiver:String? = null
/**
* Message Title.
*/
@ApiMember(Description="Message Title.")
open var MessageTitle:String? = null
/**
* Message Storage Url.
*/
@ApiMember(Description="Message Storage Url.")
open var StorageUrl:String? = null
/**
* Message Body.
*/
@ApiMember(Description="Message Body.")
open var MessageBody:String? = null
/**
* When message was created.
*/
@ApiMember(Description="When message was created.")
open var Created:Date? = null
/**
* When the message will be sent.
*/
@ApiMember(Description="When the message will be sent.")
open var ToSendDate:Date? = null
/**
* When the message was sent.
*/
@ApiMember(Description="When the message was sent.")
open var SentDate:Date? = null
/**
* If Message is sent
*/
@ApiMember(Description="If Message is sent")
open var Sent:Boolean? = null
/**
* Number of retries to send the message
*/
@ApiMember(Description="Number of retries to send the message")
open var MessageRetries:Int? = null
/**
* Send Method. 1 = Email, 2 = SMS
*/
@ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
open var SendMethodId:Int? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var Offset:Int? = null
@DataMember(Order=2)
open var Total:Int? = null
@DataMember(Order=3)
open var Results:ArrayList<AccessKeyTypeResponse>? = null
@DataMember(Order=4)
open var Meta:HashMap<String,String>? = null
@DataMember(Order=5)
open var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
open var Id:Int? = null
open var KeyType:String? = null
open var Description:String? = null
}
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.
GET /messages/log HTTP/1.1 Host: api.bookmore.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}