Requires the role: | manager |
GET | /customers |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Customers
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources
Imports Application.Interfaces
Namespace Global
Namespace Application.Interfaces
Public Partial Class Filtering
Public Sub New()
Fields = New List(Of String)
End Sub
Public Overridable Property Fields As List(Of String)
Public Overridable Property Search As String
End Class
Public Partial Class SearchMetadata
Public Overridable Property Total As Integer
Public Overridable Property Limit As Integer
Public Overridable Property Offset As Integer
Public Overridable Property Sort As Sorting
Public Overridable Property Filter As Filtering
End Class
Public Enum SortDirection
Ascending
Descending
End Enum
Public Partial Class Sorting
Public Overridable Property By As String
Public Overridable Property Direction As SortDirection
End Class
End Namespace
Namespace Application.Interfaces.Resources
Public Partial Class BankAccount
Public Overridable Property BsbNumber As String
Public Overridable Property AccountNumber As String
End Class
Public Partial Class Customer
Implements IIdentifiableResource
Public Overridable Property Id As String
Public Overridable Property FirstName As String
Public Overridable Property LastName As String
Public Overridable Property DateOfBirth As Date
Public Overridable Property DriversLicenceNo As String
Public Overridable Property Email As String
Public Overridable Property Phone As String
Public Overridable Property PreferredContactMethod As String
Public Overridable Property AddressLine1 As String
Public Overridable Property AddressLine2 As String
Public Overridable Property Suburb As String
Public Overridable Property StateTerritory As String
Public Overridable Property Postcode As String
Public Overridable Property BankAccount As BankAccount
Public Overridable Property UserAccountId As String
End Class
End Namespace
Namespace Infrastructure.Api.Interfaces.ServiceOperations
Public Partial Class GetOperationUnTenanted(Of TResponse)
Implements IHasGetOptions
Implements IGet
Public Overridable Property Embed As String
End Class
Public Partial Class SearchOperationTenanted(Of TResponse)
Inherits SearchOperationUnTenanted(Of TResponse)
Implements ITenantedRequest
Public Overridable Property OrganisationId As String
End Class
Public Partial Class SearchOperationUnTenanted(Of TResponse)
Inherits GetOperationUnTenanted(Of TResponse)
Implements IHasSearchOptions
Public Overridable Property Distinct As String
Public Overridable Property Limit As Nullable(Of Integer)
Public Overridable Property Offset As Nullable(Of Integer)
Public Overridable Property Sort As String
Public Overridable Property Filter As String
Public Overridable Property Search As String
End Class
End Namespace
Namespace Infrastructure.Api.Interfaces.ServiceOperations.Customers
Public Partial Class SearchAllCustomersRequest
Inherits SearchOperationTenanted(Of SearchAllCustomersResponse)
End Class
Public Partial Class SearchAllCustomersResponse
Public Sub New()
Customers = New List(Of Customer)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property Customers As List(Of Customer)
Public Overridable Property Metadata As SearchMetadata
End Class
End Namespace
End Namespace
VB.NET SearchAllCustomersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers HTTP/1.1 Host: staging-api.billiecart.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"customers":[{"id":"String","firstName":"String","lastName":"String","driversLicenceNo":"String","email":"String","phone":"String","preferredContactMethod":"String","addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String","bankAccount":{"bsbNumber":"String","accountNumber":"String"},"userAccountId":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}