| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /billing/company/creditcard | Get saved credit card information for the company. | Get saved credit card information for the company. |
|---|
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 CreditCard
Inherits BaseModel
<Ignore>
Public Overridable Property IsValid As Boolean
<Required>
Public Overridable Property CompanyId As Guid
Public Overridable Property Id As Integer
<Required>
Public Overridable Property Name As String
<Required>
Public Overridable Property Active As Boolean
<Required>
Public Overridable Property Type As String
<Required>
Public Overridable Property ExpYear As String
<Required>
Public Overridable Property ExpMonth As String
<Required>
Public Overridable Property TicketId As String
Public Overridable Property Updated As Nullable(Of Date)
Public Overridable Property Created As Nullable(Of 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
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class CompanyCreditCardInformation
Inherits QueryDb(Of CreditCard, CompanyCreditCardQueryResponse)
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>
'''If you want to include only active credit cards
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include only active credit cards", ParameterType:="query")>
Public Overridable Property Active As Boolean
'''<Summary>
'''If you want to include only valid credit cards (not expired and valid)
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include only valid credit cards (not expired and valid)", ParameterType:="query")>
Public Overridable Property IsValid As Boolean
End Class
Public Partial Class CompanyCreditCardQueryResponse
'''<Summary>
'''The credit card id
'''</Summary>
<ApiMember(Description:="The credit card id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The credit card name
'''</Summary>
<ApiMember(Description:="The credit card name")>
Public Overridable Property Name As String
'''<Summary>
'''If the credit card is active
'''</Summary>
<ApiMember(Description:="If the credit card is active")>
Public Overridable Property Active As Boolean
'''<Summary>
'''If the credit card is valid (active and not expired)
'''</Summary>
<ApiMember(Description:="If the credit card is valid (active and not expired)")>
Public Overridable Property IsValid As Boolean
'''<Summary>
'''The credit card type
'''</Summary>
<ApiMember(Description:="The credit card type")>
Public Overridable Property Type As String
'''<Summary>
'''The credit card expiration Year
'''</Summary>
<ApiMember(Description:="The credit card expiration Year")>
Public Overridable Property ExpYear As String
'''<Summary>
'''The credit card expiration month
'''</Summary>
<ApiMember(Description:="The credit card expiration month")>
Public Overridable Property ExpMonth As String
'''<Summary>
'''The credit card ticket name. This is secret information and won't be displayed
'''</Summary>
<ApiMember(Description:="The credit card ticket name. This is secret information and won't be displayed")>
Public Overridable Property TicketId As String
'''<Summary>
'''The date when the credit card was saved.
'''</Summary>
<ApiMember(Description:="The date when the credit card was saved.")>
Public Overridable Property Created As Nullable(Of Date)
'''<Summary>
'''The date when the credit card was updated.
'''</Summary>
<ApiMember(Description:="The date when the credit card was updated.")>
Public Overridable Property Updated As Nullable(Of Date)
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
VB.NET CompanyCreditCardInformation 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.
GET /billing/company/creditcard 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,"Name":"String","Active":false,"IsValid":false,"Type":"String","ExpYear":"String","ExpMonth":"String","TicketId":"String","Created":"0001-01-01T00:00:00","Updated":"0001-01-01T00:00:00"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}