Field Squared API Services

<back to all web services

StringData

An object used to capture generic string data and version it

The following routes are available for this service:
GET,POST,PUT,DELETE/{Workspace}/StringData/{Class}/{Type}
GET/{Workspace}/StringData/{Class}
GET/{Workspace}/StringData/VersionHistory/{Class}/{Type}
GET/{Workspace}/CatalogNames
import 'package:servicestack/servicestack.dart';

/**
* An object used to capture generic string data and version it
*/
class StringData implements IConvertible
{
    String? Workspace;
    String? VersionId;
    String? BasedOn;
    String? Class;
    String? Type;
    Map<String,dynamic?>? Data;

    StringData({this.Workspace,this.VersionId,this.BasedOn,this.Class,this.Type,this.Data});
    StringData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        VersionId = json['VersionId'];
        BasedOn = json['BasedOn'];
        Class = json['Class'];
        Type = json['Type'];
        Data = JsonConverters.fromJson(json['Data'],'Map<String,dynamic?>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'VersionId': VersionId,
        'BasedOn': BasedOn,
        'Class': Class,
        'Type': Type,
        'Data': JsonConverters.toJson(Data,'Map<String,dynamic?>',context!)
    };

    getTypeName() => "StringData";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'StringData': TypeInfo(TypeOf.Class, create:() => StringData()),
    'Map<String,dynamic?>': TypeInfo(TypeOf.Class, create:() => Map<String,dynamic?>()),
});

Dart StringData 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}/StringData/{Class}/{Type} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StringData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Data">
  <BasedOn>String</BasedOn>
  <Class>String</Class>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>value</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">String</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
  </Data>
  <Type>String</Type>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
  <_data>String</_data>
</StringData>