Requires the role: | manager |
PUT | /employers/{Id}/physical-address |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Employers;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;
namespace Application.Interfaces.Resources
{
public partial class Address
{
public virtual string AddressLine1 { get; set; }
public virtual string AddressLine2 { get; set; }
public virtual string Suburb { get; set; }
public virtual string StateTerritory { get; set; }
public virtual string Postcode { get; set; }
}
public partial class BusinessDetails
{
public virtual string TradingName { get; set; }
public virtual string AustralianBusinessNumber { get; set; }
public virtual string AustralianCompanyNumber { get; set; }
}
public partial class Contact
{
public virtual string ContactName { get; set; }
public virtual string Email { get; set; }
public virtual string PhoneNumber { get; set; }
public virtual string PreferredContactMethod { get; set; }
}
public partial class Employer
: IIdentifiableResource
{
public virtual string Name { get; set; }
public virtual BusinessDetails BusinessDetails { get; set; }
public virtual Contact Contact { get; set; }
public virtual Address PostalAddress { get; set; }
public virtual Address PhysicalAddress { get; set; }
public virtual string Id { get; set; }
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations
{
public partial class GetOperationTenanted<TResponse>
: GetOperationUnTenanted<TResponse>, ITenantedRequest
{
public virtual string OrganisationId { get; set; }
}
public partial class GetOperationUnTenanted<TResponse>
: IHasGetOptions, IGet
{
public virtual string Embed { get; set; }
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations.Employers
{
public partial class SetPhysicalAddressRequest
: GetOperationTenanted<SetPhysicalAddressResponse>
{
public virtual string Id { get; set; }
public virtual string AddressLine1 { get; set; }
public virtual string AddressLine2 { get; set; }
public virtual string Suburb { get; set; }
public virtual string StateTerritory { get; set; }
public virtual string Postcode { get; set; }
}
public partial class SetPhysicalAddressResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual Employer Employer { get; set; }
}
}
C# SetPhysicalAddressRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>