Reservation Station API

<back to all web services

UpdateProfile

Requires Authentication
The following routes are available for this service:
POST/user/profile
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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: float = 0.0
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: float = 0.0
    """
    Longitude of the user making this request
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
    description: Optional[str] = None
    heading: Optional[str] = None
    was_successful: bool = False
    model_state: Optional[Object] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserCustomFieldData:
    id: Optional[str] = None
    value: Optional[str] = None
    name: Optional[str] = None
    optional: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VenueCustomField:
    venue_name: Optional[str] = None
    venue_id: int = 0
    fields: Optional[List[UserCustomFieldData]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateProfileResponse(ApiServiceResponse):
    email_address: Optional[str] = None
    mobile_number: Optional[str] = None
    name: Optional[str] = None
    venue_custom_fields: Optional[List[VenueCustomField]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateProfile(ApiServiceRequest):
    email_address: Optional[str] = None
    mobile_number: Optional[str] = None
    name: Optional[str] = None
    venue_custom_fields: Optional[List[VenueCustomField]] = None

Python UpdateProfile 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.

POST /user/profile HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <EmailAddress>String</EmailAddress>
  <MobileNumber>String</MobileNumber>
  <Name>String</Name>
  <VenueCustomFields>
    <VenueCustomField>
      <Fields>
        <UserCustomFieldData>
          <Id>00000000-0000-0000-0000-000000000000</Id>
          <Name>String</Name>
          <Optional>false</Optional>
          <Value>String</Value>
        </UserCustomFieldData>
      </Fields>
      <VenueId>0</VenueId>
      <VenueName>String</VenueName>
    </VenueCustomField>
  </VenueCustomFields>
</UpdateProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <EmailAddress>String</EmailAddress>
  <MobileNumber>String</MobileNumber>
  <Name>String</Name>
  <VenueCustomFields>
    <VenueCustomField>
      <Fields>
        <UserCustomFieldData>
          <Id>00000000-0000-0000-0000-000000000000</Id>
          <Name>String</Name>
          <Optional>false</Optional>
          <Value>String</Value>
        </UserCustomFieldData>
      </Fields>
      <VenueId>0</VenueId>
      <VenueName>String</VenueName>
    </VenueCustomField>
  </VenueCustomFields>
</UpdateProfileResponse>