| GET | /{Workspace}/API/Contact/Schema | ||
|---|---|---|---|
| GET, PUT, POST, DELETE | /{Workspace}/API/Contact/{Id} | ||
| GET, PUT, POST, DELETE | /{Workspace}/API/Contact |
namespace Field2Office.API.Model
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type Location() =
member val y:Double = new Double() with get,set
member val x:Double = new Double() with get,set
[<AllowNullLiteral>]
type Address() =
member val Street:String = null with get,set
member val Unit:String = null with get,set
member val City:String = null with get,set
member val State:String = null with get,set
member val Zip:String = null with get,set
member val ContactTitle:String = null with get,set
member val ContactName:String = null with get,set
member val ContactPhone:String = null with get,set
member val ContactEmail:String = null with get,set
member val Location:Location = null with get,set
member val SiteName:String = null with get,set
member val GeocodeFailed:Boolean = new Boolean() with get,set
member val Country:String = null with get,set
[<AllowNullLiteral>]
type DomainItem() =
member val Workspace:String = null with get,set
member val ObjectId:String = null with get,set
member val VersionId:String = null with get,set
member val LastUpdated:String = null with get,set
[<AllowNullLiteral>]
type ClassedItem() =
member val ObjectId:String = null with get,set
member val Class:String = null with get,set
member val VersionId:String = null with get,set
member val Ancestors:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Type:String = null with get,set
[<AllowNullLiteral>]
type EventItem() =
member val ObjectId:String = null with get,set
member val Date:String = null with get,set
member val Location:Location = null with get,set
member val Barcode:String = null with get,set
member val Details:String = null with get,set
member val Type:String = null with get,set
member val IsScan:Boolean = new Boolean() with get,set
member val User:String = null with get,set
member val SelectedBy:String = null with get,set
member val Status:String = null with get,set
member val StatusType:String = null with get,set
member val DateCreated:String = null with get,set
member val Automatic:Boolean = new Boolean() with get,set
///<summary>
///Represents a DTO for a contact in a workspace. Calls without an ObjectId will retrieve an array of all active contact objects for the workspace.A call to /{Workspace}/ContactTasks/{ObjectId} will return a List<DomainItem> for the list of tasks associated to the contact.A core or custom sort field can be specified by using sort=fieldname&sortorder=ascending/descending. To filter for contacts based on full text search, use fulltext Custom contact field 'contains' filters can also be specified by using the binding/key as the query parameter. i.e. Comments=Quick Brown Fox. To filter and return all contacts modified since a date and time, use the query parameter modifiedsince = X where X = YYYY-MM-DDTHH:MM:SSZ To filter and return all contacts deleted since a date and time, use the query parameter deletedsince = X where X = YYYY-MM-DDTHH:MM:SSZ. Note only Object ID, Workspace and Version is populated. Spatial extents can be passed in using: bottomleft=Lat,Lon&topright=Lat,Lon. To filter on tasks inside a boundary, use boundary=Lat,Lon,Lat,Lon etc. Pagination - /{0}/ContactList?recstart=0&reccount=1 /{Workspace}/ContactList/Count returns a count, not the actual object list
///</summary>
[<AllowNullLiteral>]
type Contact() =
member val Workspace:String = null with get,set
member val ObjectId:String = null with get,set
member val TimeZone:String = null with get,set
member val VersionId:String = null with get,set
member val BasedOn:String = null with get,set
member val ExternalId:String = null with get,set
member val ContactName:String = null with get,set
member val Company:String = null with get,set
member val MobilePhone:String = null with get,set
member val WorkPhone:String = null with get,set
member val HomePhone:String = null with get,set
member val Email:String = null with get,set
member val SMS:Boolean = new Boolean() with get,set
member val Address:Address = null with get,set
member val Enabled:Boolean = new Boolean() with get,set
member val POI:Boolean = new Boolean() with get,set
member val EmailSiteDriving:Boolean = new Boolean() with get,set
member val ServiceAddresses:ResizeArray<Address> = new ResizeArray<Address>() with get,set
member val Documents:ResizeArray<DomainItem> = new ResizeArray<DomainItem>() with get,set
member val Data:Dictionary<String, String> = new Dictionary<String, String>() with get,set
member val Owner:ClassedItem = null with get,set
member val Tasks:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Assets:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Contacts:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Events:ResizeArray<EventItem> = new ResizeArray<EventItem>() with get,set
member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Created:String = null with get,set
member val LastUpdated:String = null with get,set
member val CreatedBy:String = null with get,set
member val ActiveLaborTypes:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type PublicContact() =
[<DataMember>]
member val Id:String = null with get,set
[<DataMember>]
member val Workspace:String = null with get,set
[<DataMember>]
member val Contact:Contact = null with get,set
[<DataMember>]
member val Contacts:ResizeArray<Contact> = new ResizeArray<Contact>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /{Workspace}/API/Contact/{Id} HTTP/1.1
Host: dev.fieldsquared.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Id":"String","Workspace":"String","Contact":{"ExternalId":"String","ContactName":"String","Company":"String","MobilePhone":"String","WorkPhone":"String","HomePhone":"String","Email":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Team":"String","Tasks":["String"],"Enabled":false,"LastUpdated":"String","Created":"String","Data":{"String":{}}},"Contacts":[{"ExternalId":"String","ContactName":"String","Company":"String","MobilePhone":"String","WorkPhone":"String","HomePhone":"String","Email":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","Team":"String","Tasks":["String"],"Enabled":false,"LastUpdated":"String","Created":"String","Data":{"String":{}}}]}