Update Record
| Scope: | update_record |
| App Type: | Agency |
| Authorization Type: | Access token |
| Url: | v3/records/{id}?lang={lang} |
| HTTP Method: | PUT |
Notes
The
contactRolesub-object is required in thecontactsobject. For the valid values, use Describe Contact Types.The
entityStateis required for any object to be added, modified, or deleted. Valid values (case-sensitive):Added|Modified|Deleted
Request Information
Parameters
application/json
{
"updateRecord": {
"contacts": [
{
"id": "sample string 1",
"personId": "sample string 2",
"familyName": "sample string 3",
"givenName": "sample string 4",
"middleNames": [
"sample string 1"
],
"fullName": "sample string 5",
"tels": [
"sample string 1"
],
"faxs": [
"sample string 1"
],
"emails": [
"sample string 1"
],
"contactRole": {
"id": "sample string 1",
"display": "sample string 2"
},
"businessName": "sample string 6",
"isPrimary": "sample string 7",
"address": {
"display": "sample string 1",
"addressLine1": "sample string 2",
"addressLine2": "sample string 3",
"addressLine3": "sample string 4",
"state": "sample string 5",
"postalCode": "sample string 6",
"city": "sample string 7",
"country": "sample string 8",
"isPrimary": "sample string 9",
"xCoordinate": "sample string 10",
"yCoordinate": "sample string 11"
},
"licenses": [
{
"licenseType": {
"id": "sample string 1",
"display": "sample string 2"
},
"licenseNumber": "sample string 1",
"issuedDate": "sample string 2",
"expirationDate": "sample string 3",
"entityState": "sample string 4"
}
],
"entityState": "sample string 8"
}
],
"addresses": [
{
"id": "sample string 1",
"display": "sample string 2",
"addressFormat": "sample string 3",
"houseNumber": "sample string 4",
"houseNumberFraction": "sample string 5",
"streetDirection": "sample string 6",
"streetName": "sample string 7",
"streetSuffix": "sample string 8",
"streetSuffixDirection": "sample string 9",
"unit": "sample string 10",
"unitEnd": "sample string 11",
"unitType": "sample string 12",
"state": "sample string 13",
"postalCode": "sample string 14",
"city": "sample string 15",
"county": "sample string 16",
"country": "sample string 17",
"isPrimary": "sample string 18",
"xCoordinate": "sample string 19",
"yCoordinate": "sample string 20",
"enabled": true,
"entityState": "sample string 22"
}
],
"owners": [
{
"id": "sample string 1",
"personId": "sample string 2",
"familyName": "sample string 3",
"givenName": "sample string 4",
"middleNames": [
"sample string 1"
],
"fullName": "sample string 5",
"tels": [
"sample string 1"
],
"faxs": [
"sample string 1"
],
"emails": [
"sample string 1"
],
"isPrimary": "sample string 6",
"address": {
"id": "sample string 1",
"display": "sample string 2",
"addressFormat": "sample string 3",
"houseNumber": "sample string 4",
"houseNumberFraction": "sample string 5",
"streetDirection": "sample string 6",
"streetName": "sample string 7",
"streetSuffix": "sample string 8",
"streetSuffixDirection": "sample string 9",
"unit": "sample string 10",
"unitEnd": "sample string 11",
"unitType": "sample string 12",
"state": "sample string 13",
"postalCode": "sample string 14",
"city": "sample string 15",
"county": "sample string 16",
"country": "sample string 17",
"isPrimary": "sample string 18",
"xCoordinate": "sample string 19",
"yCoordinate": "sample string 20",
"enabled": true,
"entityState": "sample string 22"
},
"mailingAddress": {
"id": "sample string 1",
"display": "sample string 2",
"addressFormat": "sample string 3",
"houseNumber": "sample string 4",
"houseNumberFraction": "sample string 5",
"streetDirection": "sample string 6",
"streetName": "sample string 7",
"streetSuffix": "sample string 8",
"streetSuffixDirection": "sample string 9",
"unit": "sample string 10",
"unitEnd": "sample string 11",
"unitType": "sample string 12",
"state": "sample string 13",
"postalCode": "sample string 14",
"city": "sample string 15",
"county": "sample string 16",
"country": "sample string 17",
"isPrimary": "sample string 18",
"xCoordinate": "sample string 19",
"yCoordinate": "sample string 20",
"enabled": true,
"entityState": "sample string 22"
},
"entityState": "sample string 7"
}
],
"asis": [
{
"id": "sample string 1",
"display": "sample string 2",
"description": "sample string 3",
"subGroups": [
{
"id": "sample string 1",
"display": "sample string 2",
"items": [
{
"value": "sample string 1",
"valueId": "sample string 2",
"id": "sample string 3",
"display": "sample string 4",
"name": "sample string 5",
"type": "sample string 6",
"enumerations": [
{
"id": "sample string 1",
"display": "sample string 2"
}
],
"defaultValue": "sample string 7",
"minValue": 8.1,
"maxValue": 9.1,
"inputRequired": true,
"security": "sample string 11",
"readonly": true,
"unitOfMeasurement": "sample string 13",
"isDrillDown": true,
"isDrillDownRoot": true,
"drillDownId": "sample string 16",
"childIds": [
"sample string 1"
],
"entityState": "sample string 17"
}
],
"security": "sample string 3",
"drillDownSeries": [
{
"parent": {
"id": "sample string 1",
"type": "sample string 2",
"enumerations": [
{
"id": "sample string 1",
"display": "sample string 2",
"enumerationType": "sample string 3",
"description": "sample string 4",
"childLinks": [
{
"link": "sample string 1"
}
]
}
]
},
"child": {
"id": "sample string 1",
"type": "sample string 2",
"enumerations": [
{
"id": "sample string 1",
"display": "sample string 2",
"enumerationType": "sample string 3",
"description": "sample string 4",
"link": "sample string 5"
}
]
}
}
],
"entityState": "sample string 4"
}
],
"security": "sample string 4"
}
],
"asits": [
{
"drillDownSeries": [
{
"parent": {
"id": "sample string 1",
"type": "sample string 2",
"enumerations": [
{
"id": "sample string 1",
"display": "sample string 2",
"enumerationType": "sample string 3",
"description": "sample string 4",
"childLinks": [
{
"link": "sample string 1"
}
]
}
]
},
"child": {
"id": "sample string 1",
"type": "sample string 2",
"enumerations": [
{
"id": "sample string 1",
"display": "sample string 2",
"enumerationType": "sample string 3",
"description": "sample string 4",
"link": "sample string 5"
}
]
}
}
],
"id": "sample string 1",
"display": "sample string 3",
"security": "sample string 5",
"subId": "sample string 2",
"subDisplay": "sample string 4",
"subSecurity": "sample string 6",
"description": "sample string 8",
"contextType": "sample string 7",
"columns": [
{
"id": "sample string 1",
"display": "sample string 2",
"name": "sample string 3",
"type": "sample string 4",
"enumerations": [
{
"id": "sample string 1",
"display": "sample string 2"
}
],
"defaultValue": "sample string 5",
"minValue": 6.1,
"maxValue": 7.1,
"inputRequired": true,
"security": "sample string 9",
"readonly": true,
"unitOfMeasurement": "sample string 11",
"isDrillDown": true,
"isDrillDownRoot": true,
"drillDownId": "sample string 14",
"childIds": [
"sample string 1"
],
"entityState": "sample string 15"
}
],
"rows": [
{
"id": "sample string 1",
"display": "sample string 2",
"values": [
{
"id": "sample string 1",
"value": "sample string 2",
"valueId": "sample string 3",
"entityState": "sample string 4"
}
],
"entityState": "sample string 3"
}
]
}
],
"parcels": [
{
"id": "sample string 1",
"display": "sample string 2",
"description": "sample string 3",
"text": "sample string 4",
"legalDescription": "sample string 5",
"status": {
"id": "sample string 1",
"display": "sample string 2"
},
"tract": "sample string 6",
"block": "sample string 7",
"lot": "sample string 8",
"township": "sample string 9",
"range": "sample string 10",
"section": "sample string 11",
"subdivision": "sample string 12",
"entityState": "sample string 13"
}
],
"comments": [
{
"id": "sample string 1",
"userId": "sample string 2",
"display": "sample string 3",
"comments": "sample string 4",
"date": "sample string 5",
"showOnInspection": true,
"entityState": "sample string 6"
}
],
"assets": [
{
"id": "sample string 1",
"display": "sample string 2",
"comments": "sample string 3",
"contextType": "sample string 4",
"currentValue": "sample string 5",
"dateOfService": "sample string 6",
"depreciationAmount": "sample string 7",
"depreciationValue": "sample string 8",
"description": "sample string 9",
"endDate": "sample string 10",
"salvageValue": "sample string 11",
"startDate": "sample string 12",
"startValue": "sample string 13",
"statusDates": "sample string 14",
"usefulLife": "sample string 15",
"classType": "sample string 16",
"assetName": "sample string 17",
"assetType": {
"id": "sample string 1",
"display": "sample string 2",
"group": "sample string 3",
"gisService": "sample string 4",
"gisIDForAssetID": "sample string 5",
"gisLayer": {
"id": "sample string 1",
"display": "sample string 2"
}
},
"assetStatus": {
"id": "sample string 1",
"display": "sample string 2"
},
"gisObjects": [
{
"id": "sample string 1",
"layerId": "sample string 2",
"mapService": "sample string 3",
"featureId": "sample string 4",
"featureIdFieldName": "sample string 5",
"entityState": "sample string 6"
}
],
"assetParent": {
"id": "sample string 1",
"display": "sample string 2"
},
"entityState": "sample string 18"
}
],
"workOrderTasks": [
{
"order": "sample string 1",
"taskCode": "sample string 2",
"estimate": "sample string 3",
"actual": "sample string 4",
"unit": "sample string 5",
"completedDate": "sample string 6",
"totalCost": "sample string 7",
"description": "sample string 8",
"taskDescriptin": "sample string 9",
"workflowTask": "sample string 10",
"completedBy": "sample string 11",
"updatedDate": "sample string 12",
"updatedBy": "sample string 13",
"comments": "sample string 14",
"standardOperatingProcedures": "sample string 15",
"status": "sample string 16",
"complete": "sample string 17",
"workflowTaskStatus": "sample string 18",
"processCode": "sample string 19",
"processID": "sample string 20",
"stepNumber": "sample string 21",
"entityState": "sample string 22"
}
],
"display": "sample string 1",
"module": "sample string 2",
"name": "sample string 3",
"assignToInfo": {
"totalJobCost": "sample string 1",
"completeDate": "sample string 2",
"AssignDate": "sample string 3",
"scheduledDate": "sample string 4",
"assignStaff": "sample string 5",
"assignDepartment": "sample string 6",
"priority": "sample string 7"
},
"user": {
"firstName": "sample string 1",
"lastName": "sample string 2",
"civicId": "a9fe5a8e-165f-4251-be50-12d4426d1fe7",
"email": "sample string 4"
},
"createdDate": "sample string 4",
"id": "sample string 5",
"description": "sample string 6",
"isPrivate": true,
"type": {
"id": "sample string 1",
"display": "sample string 2",
"module": "sample string 3",
"group": "sample string 4",
"subGroup": "sample string 5",
"category": "sample string 6",
"type": "sample string 7",
"security": "sample string 8",
"inspectionGroups": [
"sample string 1"
],
"standardCommentsGroupIds": [
"sample string 1"
]
},
"status": {
"id": "sample string 1",
"display": "sample string 2"
},
"department": {
"id": "sample string 1",
"display": "sample string 2",
"agency": "sample string 3",
"bureau": "sample string 4",
"division": "sample string 5",
"section": "sample string 6",
"group": "sample string 7",
"subGroup": "sample string 8",
"subGroupDescription": "sample string 9"
},
"staffPerson": {
"id": "sample string 1",
"display": "sample string 2",
"agencyCode": "sample string 3",
"auditStatus": "sample string 4",
"bureauCode": "sample string 5",
"divisionCode": "sample string 6",
"firstName": "sample string 7",
"groupCode": "sample string 8",
"lastName": "sample string 9",
"officeCode": "sample string 10",
"sectionCode": "sample string 11",
"serviceProviderCode": "sample string 12",
"userStatus": "sample string 13"
},
"assignDate": "sample string 8",
"scheduleDate": "sample string 9",
"scheduleTime": "sample string 10",
"openDate": "sample string 11",
"priority": "sample string 12",
"shortNotes": "sample string 13",
"templateName": "sample string 14",
"costs": [
{
"unitOfMeasure ": {
"id": "sample string 1",
"display": "sample string 2"
},
"id": "sample string 1",
"display": "sample string 2",
"type": {
"id": "sample string 1",
"display": "sample string 2"
},
"date": "sample string 3",
"quantity": 4.1,
"status": {
"id": "sample string 1",
"display": "sample string 2"
},
"fixedRate": 5.1,
"costFactor": "sample string 6",
"unitRate": 7.1,
"totalCost": 8.1,
"formula": "sample string 9",
"subGroup": "sample string 10",
"costAccount": {
"id": "sample string 1",
"display": "sample string 2"
},
"comments": "sample string 11",
"itemType": {
"id": "sample string 1",
"display": "sample string 2"
},
"unitOfMeasureValue": "sample string 12",
"entityState": "sample string 13",
"startTime": "sample string 14",
"endTime": "sample string 15",
"workOrderTask": "sample string 16",
"workOrderTaskIndex": "sample string 17",
"costQuantities": [
{
"id": "sample string 1",
"display": "sample string 2"
}
]
}
],
"parts": [
{
"transactionId": "sample string 1",
"display": "sample string 2",
"inventory": {
"id": "sample string 1",
"display": "sample string 2"
},
"unitCost": 3.1,
"unitCurrency": {
"id": "sample string 1",
"display": "sample string 2"
},
"id": "sample string 4",
"quantity": 5.1,
"transactionDate": "sample string 6",
"comments": "sample string 7",
"description": {
"id": "sample string 1",
"display": "sample string 2"
},
"brand": {
"id": "sample string 1",
"display": "sample string 2"
},
"taxable": true,
"altId": "sample string 8",
"type": {
"id": "sample string 1",
"display": "sample string 2"
},
"status": {
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 3",
"date": "sample string 4",
"time": "sample string 5"
},
"supplies": [
{
"id": "sample string 1",
"display": "sample string 2",
"locationName": "sample string 3",
"locationSeq": 4
}
],
"bin": "sample string 8",
"workOrderTask": "sample string 9",
"workOrderTaskIndex": "sample string 10",
"budgetAccount": {
"id": "sample string 1",
"display": "sample string 2"
},
"budgetNumber": {
"id": "sample string 1",
"display": "sample string 2"
}
}
]
}
}
Response Information
application/json
{
"record": {
"display": "sample string 1",
"module": "sample string 2",
"name": "sample string 3",
"assignToInfo": {
"totalJobCost": "sample string 1",
"completeDate": "sample string 2",
"AssignDate": "sample string 3",
"scheduledDate": "sample string 4",
"assignStaff": "sample string 5",
"assignDepartment": "sample string 6",
"priority": "sample string 7"
},
"user": {
"firstName": "sample string 1",
"lastName": "sample string 2",
"civicId": "eea8e18a-a349-431a-9710-4801445eac6e",
"email": "sample string 4"
},
"createdDate": "sample string 4",
"id": "sample string 5",
"description": "sample string 6",
"isPrivate": true,
"type": {
"id": "sample string 1",
"display": "sample string 2",
"module": "sample string 3",
"group": "sample string 4",
"subGroup": "sample string 5",
"category": "sample string 6",
"type": "sample string 7",
"security": "sample string 8",
"inspectionGroups": [
"sample string 1"
],
"standardCommentsGroupIds": [
"sample string 1"
]
},
"status": {
"id": "sample string 1",
"display": "sample string 2"
},
"department": {
"id": "sample string 1",
"display": "sample string 2",
"agency": "sample string 3",
"bureau": "sample string 4",
"division": "sample string 5",
"section": "sample string 6",
"group": "sample string 7",
"subGroup": "sample string 8",
"subGroupDescription": "sample string 9"
},
"staffPerson": {
"id": "sample string 1",
"display": "sample string 2",
"agencyCode": "sample string 3",
"auditStatus": "sample string 4",
"bureauCode": "sample string 5",
"divisionCode": "sample string 6",
"firstName": "sample string 7",
"groupCode": "sample string 8",
"lastName": "sample string 9",
"officeCode": "sample string 10",
"sectionCode": "sample string 11",
"serviceProviderCode": "sample string 12",
"userStatus": "sample string 13"
},
"assignDate": "sample string 8",
"scheduleDate": "sample string 9",
"scheduleTime": "sample string 10",
"openDate": "sample string 11",
"priority": "sample string 12",
"shortNotes": "sample string 13",
"templateName": "sample string 14"
}
}