Requires the role: | manager |
GET | /employers |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Employers
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 Address
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
End Class
Public Partial Class BusinessDetails
Public Overridable Property TradingName As String
Public Overridable Property AustralianBusinessNumber As String
Public Overridable Property AustralianCompanyNumber As String
End Class
Public Partial Class Contact
Public Overridable Property ContactName As String
Public Overridable Property Email As String
Public Overridable Property PhoneNumber As String
Public Overridable Property PreferredContactMethod As String
End Class
Public Partial Class Employer
Implements IIdentifiableResource
Public Overridable Property Name As String
Public Overridable Property BusinessDetails As BusinessDetails
Public Overridable Property Contact As Contact
Public Overridable Property PostalAddress As Address
Public Overridable Property PhysicalAddress As Address
Public Overridable Property Id 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.Employers
Public Partial Class SearchAllEmployersRequest
Inherits SearchOperationTenanted(Of SearchAllEmployersResponse)
End Class
Public Partial Class SearchAllEmployersResponse
Public Sub New()
Employers = New List(Of Employer)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property Employers As List(Of Employer)
Public Overridable Property Metadata As SearchMetadata
End Class
End Namespace
End Namespace
VB.NET SearchAllEmployersRequest 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 /employers HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"employers":[{"name":"String","businessDetails":{"tradingName":"String","australianBusinessNumber":"String","australianCompanyNumber":"String"},"contact":{"contactName":"String","email":"String","phoneNumber":"String","preferredContactMethod":"String"},"postalAddress":{"addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String"},"physicalAddress":{"addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String"},"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}