Learn how to update an entity including creation/update of child elements
Use the PUT method along with the JSON payload and the API will update that Entity.
PUT {Host Name}/api/v1/base/{EntityType}/{ID of Entity}?properties={property1,property2}
where {Host Name} is derived from GetCompanyWsdkUrlCommand.Url, and
{EntityType} is a class listed in the Entities namespace, and
{ID of Entity} is the integer value of Entity.Id, and
{Request body} which contains both valid Entity and PropertySet as shown in examples below
Contact Example
Contacts are typically updated when contact addresses change, or system access levels change. To update all scalar values for the entity, use wildcard symbol * for Properties. To target your updates with more granularity, include the full expression in the Properties collection.
PUT <<AM Host Name>>/api/v1/base/Contact HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmQxZWYiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJUaHUsIDA5IERlYyAyMDIxIDIzOjA4OjQxIEdNVCIsIi5leHBpcmVzIjoiVGh1LCAwOSBEZWMgMjAyMSAyMzoyODo0MSBHTVQifX19<---->x2webgy_M44saZmOnW3Fi0w5x4kDey-rfqDYYYFCPEWGazKSDg20U41m4l5yWWawJjhWbVXnFtpDpbNUZj_SkojbFMhD4lc3lEqovFtp0ctudverH4kk2A8pX229e4NP9G4Vxi1zWmSr6N6SeliB_uZ0JCzSuoST81LV00m_NzpoIYCNhG7LESrnTpebC5fyRYs1zXrp6_mnaddKZ-eEAdjHOELexpVHvTIJA4CjyhKTyBUn0l-J9DigvUMuxgd4dyQZzlvcJGIcnSI9MWEAC0xnnQhZbOvoVdSgaApB82NR-1A7d4_ac3AgGCpP9xxq_V9ImglM0UCUbahEzAeEIg
Content-Length: 157
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Properties": [
"*"
],
"Entity": {
"Id": 500,
"Comment": "Test 2",
"FirstName": "David1",
"LastName": "Baldi1",
"UserName": "DavBaldi",
"Number": "1",
"CustomerNoteAccessid": "View"
}
}
PUT <<AM Host Name>/api/v1/base/Contact HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmQxZWYiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJUaHUsIDA5IERlYyAyMDIxIDIzOjA4OjQxIEdNVCIsIi5leHBpcmVzIjoiVGh1LCAwOSBEZWMgMjAyMSAyMzoyODo0MSBHTVQifX19<---->x2webgy_M44saZmOnW3Fi0w5x4kDey-rfqDYYYFCPEWGazKSDg20U41m4l5yWWawJjhWbVXnFtpDpbNUZj_SkojbFMhD4lc3lEqovFtp0ctudverH4kk2A8pX229e4NP9G4Vxi1zWmSr6N6SeliB_uZ0JCzSuoST81LV00m_NzpoIYCNhG7LESrnTpebC5fyRYs1zXrp6_mnaddKZ-eEAdjHOELexpVHvTIJA4CjyhKTyBUn0l-J9DigvUMuxgd4dyQZzlvcJGIcnSI9MWEAC0xnnQhZbOvoVdSgaApB82NR-1A7d4_ac3AgGCpP9xxq_V9ImglM0UCUbahEzAeEIg
Content-Length: 157
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Properties": [
"FirstName,LastName,Comment"
],
"Entity": {
"Id": 500,
"Comment": "Test 2",
"FirstName": "David1",
"LastName": "Baldi1",
"UserName": "DavBaldi",
"Number": "1",
"CustomerNoteAccessid": "View"
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 6,
"EntityType": "Contact",
"Id": 5
}
}
WorkOrder Example
WorkOrder updates have a wide variety of uses including updating CustomField2 values, adding Notes, adding Documents, adding Tasks and Procedures.
PUT <<AM Host Name>>/api/v1/base/Employee HTTP/1.1
CompanyName: <<Sample Company>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmNjMTYiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDIwIERlYyAyMDIxIDE0OjA3OjM4IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAyMCBEZWMgMjAyMSAxNDoyNzozOCBHTVQifX19<---->CJbPAw_2Itfz6vnHZrEyuj9c_D4d0rfGgmVCrPb_Z5d9TNU1iQMLEB-27JAF3LtAgxnnblLJMuGd9a6gPVDjg8TmjUqaDOm7aiZSycftPQoNp6bKJt-4fI78cogWj6zQl0ICCpmfPYI3fWfWKZ6PlfaVaWauwVQ7z5-ERzhuAS0VLOOjEfMwJ1eMcg2aJqwif4-QJtJISQKMc0x89E82rrJFWj72IiP3Hk2kRoaq3vQS-IyQwUS8Z1ssXgRWeYRGigX-3OUceenmgzrTzSJBZmThY6SigrL8Q8Kp6XJqNmfuM4-Nu7rL4ALYvVp-bK5i5ZcJYRkqUHGfakGPFggedA
Content-Type: application/json
Content-Length: 1590
{
"Properties": ["Workorder"],
"Entity": {
"ID": 2,
"ContactName": "[email protected]"
},
"Comment": "test",
"ConcurrencyId": 0
}
{
"EntitySpecifier": {
"ConcurrencyId": 44,
"EntityType": "WorkOrder",
"Id": 22635
}
}
Customer Example
Customer updates are typically applied to update Dba, TaxExempt status, and Instructions.
PUT <<AM Host Name>>/api/v1/base/Customer HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LjlhMDciLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDIwIERlYyAyMDIxIDEwOjUyOjE1IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAyMCBEZWMgMjAyMSAxMToxMjoxNSBHTVQifX19<---->zJGJc75mhlYZSZcVpa0z4ygCHm-FMkggqSLhqF-AK_2s3xDGEoO2xEmSg_JpMKeyhHAJ26ckVIRBkece32Tswkac9jPJ21MPlqOV5AOmvWQ2cwuWE42gltNmTl1FihHCHngfGO-BBvLM9j29H2aOWHgAzCrmA6A1QFvs6riZoD3PNDGSr3eTyZu-zOvmI6q_3cO6IJFYMlMhyrEU2L82pw88W0JDZFb5Yp3yHq4WVcWQuDymlLvLtyapckhdDWLNNs_Z7kas-NUJ0jUuJq9EabF3-TkLxWbHpvDsYLa9xnL82g_x41hTmqTl7h2OTxuPAJ8z5hfFE3MJdKOicP7qig
Content-Type: application/json
Content-Length: 2613
{
"Properties": [
"*"
],
"Entity": {
"DisplayAs": "FL - FLOR (Orlando)",
"Name": "FL - FLOR (Orlando)",
"Dba": "FL - FLOR (Orlando)",
"Instructions": "",
"TenantCode": "A0001",
"TaxExempt": false,
"Spaces": [],
"Contacts": [],
"CustomFields": [],
"Notes": [],
"Addresses": [],
"GroupsBridge": [],
"ApprovalScopes": [],
"IsRemoved": false,
"ConcurrencyId": 25,
"Id": 3,
"PerformDeletion": false,
"IsNew": false
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 4,
"EntityType": "Customer",
"Id": 225
}
}
Workzone Example
A Workzone contains critical configuration settings for a specific property, community, or service area. Updates to Workzones typically relate to workflow configuration settings.
PUT <<AM Host Name>>/api/v1/base/Workzone?= HTTP/1.1
CompanyName: <<Sample Company>>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmNjMTYiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDIwIERlYyAyMDIxIDEyOjUyOjA4IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAyMCBEZWMgMjAyMSAxMzoxMjowOCBHTVQifX19<---->2E0BgxloXhNUSFwsGQPwa430hr6dqmMVyIDz5G7vDE9_eJOfodAXK4DWvhzyhFmhPulPWEPGUp41Or4JzKd9pgRjI9aEqaWK8gbX5Wah3LZPtawTuoCC44-LjRv1LUqfrk5nkHY_I-Z6X0XW0ycp9nwabD0BMIgjTaN3fA_7WVHb0_12LE2UG-T-OV157kOgqMOGtu8F4oBScXYpotLzw-YnkX_8fS-18THxI1e0doe4E1IeNPiSEEqZYYsdPTRHX4EqpSPo6gYJHPFDK7LDvrgIkd9oct5NArU0f3j_LDs93Qep1Kq9-rgTO68v1IDGNIsjA5NfdA8VabcJLN6L6Q
Content-Type: application/json
Content-Length: 2541
{
"Properties": [
"*"
],
"Entity": {
"DisplayAs": "FL - FLOR (Orlando)",
"Asset": {
"Name": "",
"ModelId": 0,
"Orphan": false,
"TypeId": "Unknown",
"ParentId": 0,
"RootId": 0,
"IsTemplate": false,
"Documents": [],
"IsOffline": false,
"IsLocked": false,
"Attributes": [],
"Id": 1153,
"PerformDeletion": false,
"IsNew": false
},
"TimeZone": 35,
"LanguageId": 1033,
"WoNumberPrefix": "ASN001",
"Entity": "Asurion",
"SchedulingWindow": 15,
"NoIncompleteProcedure": false,
"AccessOptionsMask": 8,
"Number": "FLOR",
"AdvanceNotice": 0,
"TaxRegion": {
"Items": [],
"ConcurrencyId": 0,
"Id": 158470,
"PerformDeletion": false,
"IsNew": false
},
"WoNumberDigits": 4,
"RoundApptTimeTo": 60,
"WorkPlanAutoCancel": false,
"WorkPlanChildResolution": false,
"WorkPlanAutoDependency": false,
"CpThemeId": 0,
"DefaultAccess": "NotApplicable",
"AutoAssignEnabled": false,
"BackupRoutingId": "Default",
"NoIncompleteItem": false,
"UiShowProvidersFirst": false,
"CurrencyTypeId": "USD",
"IsOffline": false,
"ContactAddresses": [],
"CustomFields": [],
"Portfolios": [],
"SlaValues": [],
"Teams": [],
"BizHours": [],
"EscalationRules": [],
"SpecDispatchRules": [],
"OnCallRules": [],
"Responsibilities": [],
"UseBizHours": true,
"UseHolidays": true,
"UseOnCall": true,
"UseEscalation": true,
"DefaultBillToLogic": 0,
"TurnKickOffAuto": false,
"TurnKickOffLagDays": 6,
"TurnKickOffOnDays": 62,
"EarliestSlot": 1,
"LatestSlot": 7,
"SlotsCount": 3,
"IsPrecalculatedSchedule": false,
"AllowTimePreference": false,
"TurnTemplateId": 0,
"IsmSpecGroupId": 0,
"IsmUrl": "",
"ExcludeNonCompliantProviders": "InheritGlobalSettings",
"IsNteAuto": true,
"IsRemoved": false,
"ConcurrencyId": 35,
"Id": 1,
"PerformDeletion": false,
"IsNew": false
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 2,
"EntityType": "Workzone",
"Id": 165
}
}
Employee Example
Employee updates typically include changes in scalar elements like LastName and DisplayAs, and also to associate this Employee with a Role, a collection of Portfolios, a collection of Teams and a collection of StockLocations.
PUT <<AM Host Name>>/api/v1/base/Employee HTTP/1.1
CompanyName: <<Sample Company>
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMS4xODY4LmNjMTYiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6InVybjpvYXV0aDpzY29wZSIsIlZhbHVlIjoiIiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifSx7IlR5cGUiOiJBdWQiLCJWYWx1ZSI6IjE4NjgiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9XSwiUHJvcGVydGllcyI6eyJEaWN0aW9uYXJ5Ijp7Ii5pc3N1ZWQiOiJNb24sIDIwIERlYyAyMDIxIDE0OjA3OjM4IEdNVCIsIi5leHBpcmVzIjoiTW9uLCAyMCBEZWMgMjAyMSAxNDoyNzozOCBHTVQifX19<---->CJbPAw_2Itfz6vnHZrEyuj9c_D4d0rfGgmVCrPb_Z5d9TNU1iQMLEB-27JAF3LtAgxnnblLJMuGd9a6gPVDjg8TmjUqaDOm7aiZSycftPQoNp6bKJt-4fI78cogWj6zQl0ICCpmfPYI3fWfWKZ6PlfaVaWauwVQ7z5-ERzhuAS0VLOOjEfMwJ1eMcg2aJqwif4-QJtJISQKMc0x89E82rrJFWj72IiP3Hk2kRoaq3vQS-IyQwUS8Z1ssXgRWeYRGigX-3OUceenmgzrTzSJBZmThY6SigrL8Q8Kp6XJqNmfuM4-Nu7rL4ALYvVp-bK5i5ZcJYRkqUHGfakGPFggedA
Content-Type: application/json
Content-Length: 1590
{
"Properties": [
"*"
],
"Entity": {
"FirstName": "Erik",
"LastName": "Blomberg",
"DisplayAs": "1Blomberg, Erik",
"Role": {
"Id": 1
},
"AccessToAllWorkZones": false,
"LanguageId": 1033,
"ActorTypeId": "Employee",
"Username": "177ce294-8d83-4d23-af03-e7cab6caa33d",
"DtPwdChange": "2016-07-11T00:00:00",
"Instructions": "2",
"WonMemberId": 0,
"WonLocationId": 0,
"WonServiceRadius": 0,
"IsElectronicPayment": false,
"ProviderStatusId": "NA",
"LabelId": 0,
"FreeTextAllowed": true,
"RadiusUnit": "Mile",
"Password": "Password@123",
"Number": "123",
"JobTitle": "test",
"FederalId": "",
"ExternalId": "",
"ForcePasswordReset": false,
"TaxWarnOnly": false,
"PriceLists": [],
"CustomFields": [],
"BillAtZero": false,
"IsSupplier": false,
"ProviderTypeId": "Regular",
"ContactAddresses": [],
"Teams": [],
"WorkZones": [],
"Portfolios": [],
"CustomerGroups": [],
"Specialties": [],
"PayRates": [],
"StockLocations": [],
"Services": [],
"AlertSubscriptions": [],
"TaxExempt": false,
"LimitAssignmentByPortfolioId": 0,
"IsRemoved": true,
"ConcurrencyId": 4,
"Id": 5,
"PerformDeletion": false,
"IsNew": true
}
}
{
"EntitySpecifier": {
"ConcurrencyId": 6,
"EntityType": "Employee",
"Id": 5
}
}
Applying to other EntityTypes
The base PUToperation covers the entire CorrigoService.Entities namespace. Use the reference library to understand the element names and child collections for the EntityType for your PUT operation. Use this understanding to build your properties expression so that your retrieval is optimized for your particular application.
Applying PUT to other EntityTypes