Billiecart API

<back to all web services

SetPostalAddressRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT/employers/{Id}/postal-address
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BusinessDetails() = 
        member val TradingName:String = null with get,set
        member val AustralianBusinessNumber:String = null with get,set
        member val AustralianCompanyNumber:String = null with get,set

    [<AllowNullLiteral>]
    type Contact() = 
        member val ContactName:String = null with get,set
        member val Email:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val PreferredContactMethod:String = null with get,set

    [<AllowNullLiteral>]
    type Address() = 
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val Suburb:String = null with get,set
        member val StateTerritory:String = null with get,set
        member val Postcode:String = null with get,set

    [<AllowNullLiteral>]
    type Employer() = 
        member val Name:String = null with get,set
        member val BusinessDetails:BusinessDetails = null with get,set
        member val Contact:Contact = null with get,set
        member val PostalAddress:Address = null with get,set
        member val PhysicalAddress:Address = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type SetPostalAddressResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Employer:Employer = null with get,set

    [<AllowNullLiteral>]
    type SetPostalAddressRequest() = 
        inherit GetOperationTenanted<SetPostalAddressResponse>()
        member val Id:String = null with get,set
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val Suburb:String = null with get,set
        member val StateTerritory:String = null with get,set
        member val Postcode:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationTenanted<'TResponse>() = 
        inherit GetOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

F# SetPostalAddressRequest 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

HTTP + JSON

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

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

{"id":"String","addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String","organisationId":"String","embed":"String"}

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"}},"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"}}