Field Squared API Services

<back to all web services

PublicDocument

The following routes are available for this service:
GET/{Workspace}/API/Document/Schema
GET, PUT, POST, DELETE/{Workspace}/API/Document/{Id}
GET, PUT, POST, DELETE/{Workspace}/API/Document
GET/{Workspace}/API/Document/Schema/{DocumentType}
System.NotSupportedException: Unknown language 'mjs', Supported languages: csharp, typescript, dart, java, kotlin, python, swift, vbnet, fsharp
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(MetadataTypes metadataTypes, MetadataTypesConfig typesConfig, String lang, IRequest req, Action`1 configure) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/ILangGenerator.cs:line 53
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(List`1 metadataTypes, String lang, IRequest req, Action`1 configure) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/ILangGenerator.cs:line 26
   at ServiceStack.Metadata.BaseMetadataHandler.d__12.MoveNext() in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/Metadata/BaseMetadataHandler.cs:line 207

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/API/Document/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Workspace: String,
	DocumentType: String,
	Document: 
	{
		Name: String,
		ExternalId: String,
		Type: String,
		OwnerId: String,
		OwnerClass: String,
		Lat: 0,
		Lon: 0,
		LastUpdated: String,
		Created: String,
		Date: String,
		PercentComplete: 0,
		PercentTotal: 0,
		PercentDone: 0,
		Data: 
		{
			String: {}
		}
	},
	Documents: 
	[
		{
			Name: String,
			ExternalId: String,
			Type: String,
			OwnerId: String,
			OwnerClass: String,
			Lat: 0,
			Lon: 0,
			LastUpdated: String,
			Created: String,
			Date: String,
			PercentComplete: 0,
			PercentTotal: 0,
			PercentDone: 0,
			Data: 
			{
				String: {}
			}
		}
	]
}