ConsumerApi

<back to all web services

ProfileUpdateHomeLocationRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
PUT/profile/update-home
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module ConsumerApi


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAddress:
    street_name: Optional[str] = None
    street_number: Optional[str] = None
    postal_code: Optional[str] = None
    region: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HomeLocation:
    address: Optional[UserAddress] = None
    latitude: float = 0.0
    longitude: float = 0.0


Python ProfileUpdateHomeLocationRequest 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 /profile/update-home HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProfileUpdateHomeLocationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <Home xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:Address>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:StreetName>String</d2p1:StreetName>
      <d2p1:StreetNumber>String</d2p1:StreetNumber>
    </d2p1:Address>
    <d2p1:Latitude>0</d2p1:Latitude>
    <d2p1:Longitude>0</d2p1:Longitude>
  </Home>
</ProfileUpdateHomeLocationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProfileUpdateHomeLocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <HomeLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:Address>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:StreetName>String</d2p1:StreetName>
      <d2p1:StreetNumber>String</d2p1:StreetNumber>
    </d2p1:Address>
    <d2p1:Latitude>0</d2p1:Latitude>
    <d2p1:Longitude>0</d2p1:Longitude>
  </HomeLocation>
</ProfileUpdateHomeLocationResponse>