Requires the role: | manager |
PUT | /employers/{Id} |
---|
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
Namespace Global
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 PutOperationTenanted(Of TResponse)
Inherits PutOperationUnTenanted(Of TResponse)
Implements ITenantedRequest
Public Overridable Property OrganisationId As String
End Class
Public Partial Class PutOperationUnTenanted(Of TResponse)
Implements IPut
End Class
End Namespace
Namespace Infrastructure.Api.Interfaces.ServiceOperations.Employers
Public Partial Class UpdateEmployerRequest
Inherits PutOperationTenanted(Of UpdateEmployerResponse)
Public Overridable Property Id As String
Public Overridable Property Name As String
End Class
Public Partial Class UpdateEmployerResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property Employer As Employer
End Class
End Namespace
End Namespace
VB.NET UpdateEmployerRequest 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.
PUT /employers/{Id} HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","name":"String","organisationId":"String"}
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"}},"employer":{"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"}}