Field Squared API Services

<back to all web services

UserRequest

Request to get a single Task from the system

The following routes are available for this service:
GET,POST/{Workspace}/v2/User/{ObjectId}
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 UserRequest:
    """
    Request to get a single Task from the system
    """

    workspace: Optional[str] = None
    object_id: Optional[str] = None
    change_date: Optional[str] = None
    sync_date: Optional[str] = None
    edits: Optional[Dict[str, Object]] = None

Python UserRequest 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 /{Workspace}/v2/User/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.V2.Model.User">
  <ChangeDate>String</ChangeDate>
  <Edits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Edits>
  <ObjectId>String</ObjectId>
  <SyncDate>String</SyncDate>
  <Workspace>String</Workspace>
</UserRequest>