| GET | /references | Get all valid references | Get all valid references. |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Db
Namespace Global
Namespace BokaMera.API.ServiceModel.Db
Public Partial Class BaseModel
End Class
Public Partial Class ExternalReference
Inherits BaseModel
<Required>
Public Overridable Property CompanyId As Guid
<Required>
Public Overridable Property Id As Guid
<Required>
Public Overridable Property OwnerId As Guid
<Required>
Public Overridable Property ReferenceType As String
Public Overridable Property ExternalData As String
Public Overridable Property CreatedBy As String
<Required>
Public Overridable Property Updated As Date
<Required>
Public Overridable Property Created As Date
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
End Class
End Namespace
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class AccessKeyTypeResponse
Public Overridable Property Id As Integer
Public Overridable Property KeyType As String
Public Overridable Property Description As String
End Class
Public Partial Class ReferenceQuery
Inherits QueryDb(Of ExternalReference, ReferenceQueryResponse)
Implements ICompany
'''<Summary>
'''The company id, if empty will use the company id for the user you are logged in with.
'''</Summary>
<ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''Id of the reference
'''</Summary>
<ApiMember(Description:="Id of the reference")>
Public Overridable Property Id As Nullable(Of Guid)
'''<Summary>
'''Internal Id of the reference. Example could be the Booking Id
'''</Summary>
<ApiMember(Description:="Internal Id of the reference. Example could be the Booking Id")>
Public Overridable Property OwnerId As Nullable(Of Guid)
'''<Summary>
'''The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
'''</Summary>
<ApiMember(Description:="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")>
Public Overridable Property ReferenceType As String
'''<Summary>
'''The external data. Could be a Id or a JSON object or anything
'''</Summary>
<ApiMember(Description:="The external data. Could be a Id or a JSON object or anything")>
Public Overridable Property ExternalData As String
End Class
Public Partial Class ReferenceQueryResponse
'''<Summary>
'''The company id
'''</Summary>
<ApiMember(Description:="The company id")>
Public Overridable Property CompanyId As Guid
'''<Summary>
'''Id of the reference
'''</Summary>
<ApiMember(Description:="Id of the reference")>
Public Overridable Property Id As Guid
'''<Summary>
'''Internal Id of the reference. Example could be the Booking Id
'''</Summary>
<ApiMember(Description:="Internal Id of the reference. Example could be the Booking Id")>
Public Overridable Property OwnerId As Guid
'''<Summary>
'''The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
'''</Summary>
<ApiMember(Description:="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")>
Public Overridable Property ReferenceType As String
'''<Summary>
'''The external data. Could be a Id or a JSON object or anything
'''</Summary>
<ApiMember(Description:="The external data. Could be a Id or a JSON object or anything")>
Public Overridable Property ExternalData As String
'''<Summary>
'''Will show when the reference was updated.
'''</Summary>
<ApiMember(DataType:="datetime", Description:="Will show when the reference was updated.")>
Public Overridable Property Updated As Date
'''<Summary>
'''Will show when the reference was created.
'''</Summary>
<ApiMember(DataType:="datetime", Description:="Will show when the reference was created.")>
Public Overridable Property Created As Date
'''<Summary>
'''Will show who created the reference.
'''</Summary>
<ApiMember(DataType:="datetime", Description:="Will show who created the reference.")>
Public Overridable Property CreatedBy As String
'''<Summary>
'''Will show who update the reference.
'''</Summary>
<ApiMember(DataType:="datetime", Description:="Will show who update the reference.")>
Public Overridable Property UpdatedBy As String
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
Namespace ServiceStack
<DataContract>
Public Partial Class QueryBase
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=1)>
Public Overridable Property Skip As Nullable(Of Integer)
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=2)>
Public Overridable Property Take As Nullable(Of Integer)
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=3)>
Public Overridable Property OrderBy As String
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=4)>
Public Overridable Property OrderByDesc As String
'''<Summary>
'''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>
'''</Summary>
<DataMember(Order:=5)>
Public Overridable Property Include As String
<DataMember(Order:=6)>
Public Overridable Property Fields As String
<DataMember(Order:=7)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
Public Partial Class QueryDb(Of From, Into)
Inherits QueryBase
End Class
<DataContract>
Public Partial Class QueryResponse(Of AccessKeyTypeResponse)
Public Sub New()
Results = New List(Of AccessKeyTypeResponse)
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Offset As Integer
<DataMember(Order:=2)>
Public Overridable Property Total As Integer
<DataMember(Order:=3)>
Public Overridable Property Results As List(Of AccessKeyTypeResponse)
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
<DataMember(Order:=5)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
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 /references 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":[{"ReferenceType":"String","ExternalData":"String","CreatedBy":"String","UpdatedBy":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}