sfgboxapi

<back to all web services

UsersIntendedEdit

The following routes are available for this service:
PUT/users_intended/{Id}
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 UsersIntendedEditResponse:
    id: int = 0
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    identification_number: Optional[str] = None
    phone_number: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0
    # @References(typeof(UsersDetails))
    users_details_id: Optional[int] = None

    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UsersIntendedEdit:
    # @Validate(Validator="NotNull")
    id: int = 0

    first_name: Optional[str] = None
    last_name: Optional[str] = None
    identification_number: Optional[str] = None
    phone_number: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0
    # @References(typeof(UsersDetails))
    users_details_id: Optional[int] = None

Python UsersIntendedEdit 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 /users_intended/{Id} HTTP/1.1 
Host: api.sfgtec.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UsersIntendedEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <IdentificationNumber>String</IdentificationNumber>
  <PhoneNumber>String</PhoneNumber>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <UsersDetailsId>0</UsersDetailsId>
</UsersIntendedEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersIntendedEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <FirstName>String</FirstName>
  <Id>0</Id>
  <IdentificationNumber>String</IdentificationNumber>
  <LastName>String</LastName>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <PhoneNumber>String</PhoneNumber>
  <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>
  <UsersDetailsId>0</UsersDetailsId>
</UsersIntendedEditResponse>