Field Squared API Services

<back to all web services

UserLocation

Service representing a UserLocation in a workspace.

The following routes are available for this service:
POST/{Workspace}/UserLocation/{ObjectId}
UserLocation Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
ObjectIdpathstringNo
VersionIdbodystringNo
BasedOnbodystringNo
UserStatusbodyUserStatusNo
Location Parameters:
NameParameterData TypeRequiredDescription
yformdoubleNo
xformdoubleNo
UserStatus Enum:
NotStarted
Driving
InProgress
Complete
Blocked

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /{Workspace}/UserLocation/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","UserStatus":"NotStarted","y":0,"x":0}