Billiecart API

SetPhysicalAddressRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/employers/{Id}/physical-address

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 GetOperationTenanted(Of TResponse)
            Inherits GetOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Employers

        Public Partial Class SetPhysicalAddressRequest
            Inherits GetOperationTenanted(Of SetPhysicalAddressResponse)
            Public Overridable Property Id 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
        End Class

        Public Partial Class SetPhysicalAddressResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Employer As Employer
        End Class
    End Namespace
End Namespace

VB.NET SetPhysicalAddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /employers/{Id}/physical-address HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SetPhysicalAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
  <Embed xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</Embed>
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <AddressLine1>String</AddressLine1>
  <AddressLine2>String</AddressLine2>
  <Id>String</Id>
  <Postcode>String</Postcode>
  <StateTerritory>String</StateTerritory>
  <Suburb>String</Suburb>
</SetPhysicalAddressRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SetPhysicalAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
  <Employer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:BusinessDetails>
      <d2p1:AustralianBusinessNumber>String</d2p1:AustralianBusinessNumber>
      <d2p1:AustralianCompanyNumber>String</d2p1:AustralianCompanyNumber>
      <d2p1:TradingName>String</d2p1:TradingName>
    </d2p1:BusinessDetails>
    <d2p1:Contact>
      <d2p1:ContactName>String</d2p1:ContactName>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod>
    </d2p1:Contact>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:PhysicalAddress>
      <d2p1:AddressLine1>String</d2p1:AddressLine1>
      <d2p1:AddressLine2>String</d2p1:AddressLine2>
      <d2p1:Postcode>String</d2p1:Postcode>
      <d2p1:StateTerritory>String</d2p1:StateTerritory>
      <d2p1:Suburb>String</d2p1:Suburb>
    </d2p1:PhysicalAddress>
    <d2p1:PostalAddress>
      <d2p1:AddressLine1>String</d2p1:AddressLine1>
      <d2p1:AddressLine2>String</d2p1:AddressLine2>
      <d2p1:Postcode>String</d2p1:Postcode>
      <d2p1:StateTerritory>String</d2p1:StateTerritory>
      <d2p1:Suburb>String</d2p1:Suburb>
    </d2p1:PostalAddress>
  </Employer>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SetPhysicalAddressResponse>