<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:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | path | string | No | |
| ObjectId | path | string | No | |
| VersionId | body | string | No | |
| BasedOn | body | string | No | |
| UserStatus | body | UserStatus | No | |
Location Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| y | form | double | No | |
| x | form | double | No | |
UserStatus Enum:| NotStarted | |
| Driving | |
| InProgress | |
| Complete | |
| Blocked | |
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}/UserLocation/{ObjectId} HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UserLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Users">
<x xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">0</x>
<y xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">0</y>
<BasedOn>String</BasedOn>
<ObjectId>String</ObjectId>
<UserStatus>NotStarted</UserStatus>
<VersionId>String</VersionId>
<Workspace>String</Workspace>
</UserLocation>