worklog¶

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference¶

/rest/contact/workLog

POST

This API creates a new Work Log and, optionally, creates a new Location and Contact.

acceptable request representations:

application/json

{  "clientId":"34",  "locationRef":"abc123",  "salutation":"Mr",  "forename":"Albert",  "surname":"Preistley",  "contact1":"01234 5678788",  "contact1Type":"1",  "preferredContact":"1",  "address1":"18 Yardley Ave",  "address2":"Yeavinbridge",  "address3":"Nr Downley",  "address4":"Upshire",  "postCode":"DO8 7YH",  "contactNotes":"some notes",  "contactConsiderations":"some notes",  "contactIsPreferred":"1",  "contactStartDate":"12/12/2011",  "contactEndDate":"12/12/2030",  "locationGroupId":"34",  "usageTypeId":"87",  "regionId":"8",  "locationTypeId":"19",  "locationName":"18 Yardley Ave",  "locationStatusId":"2",  "area":"area 1",  "siteConsiderations":"some notes"
}

available response representations:

200 - application/json

{
"result" : "success or fail",
"result_msg" : "error message"
}

Field specification details:

Rest API Field Specification - WorkLog

Open Rest API Field Specification - WorkLog

See the Contact API matrix for the full list of endpoints in this category.