API | GET and UPDATE TouchPoint Responses

Australia and New Zealand users: API is not currently available in your region. Visit the Ideas Portal to submit or upvote a request. Your votes help the product team prioritize what's built next.

1. Authenticate your session in the API

2. GET /API/Touchpoint.svc/GetTouchPointResponse with the required fields below:

   • EnterpriseGuid

   • SecurityToken

   • TouchPointResponseID

   • TouchPointID

3. The returned value will look something like this: (See full text here)

4. Copy the response to a Notepad or HTML/Text editing platform

5. Move to the "POST/API/Touchpoint.svc/TouchPointResponseUpdate/"
​

6. See the model of the call on the right-hand side under 'Body'. 
​

Note: The GET you have saved in a Notepad will need some mild adjustments to fit the POST requirements in this area.

The post body is an object that represents a TouchPoint response and its properties. The base of a TouchPoint response should be modeled using the reference below. Fill in values accordingly:

{
“TouchPointResponse”: {
“GetChildResponses”: true,
“ParentFormID”: 0,
“ParentFormResponseID”: 0,
“TouchPointResponseID”: 0,
“TouchPointID”: 0,
“SubjectID”: 0,
“SubjectTypeID”: 0,
“TouchPointIdentifier”: “string”,
“TouchPointIdentifierRequired”: true,
“DataEnteredByID”: 0,
“ResponseCreatedDate”: “\/Date(1571411927090)\/”,
“ResponseCreatedDateAsString”: “string”,
“ProgramID”: 0,
“DraftSavedOn”: “\/Date(1571411927090)\/”,
“ResponseElements”: [Represents an array of the question/answer pairs within the response. See Step 7.],
“ErrorMessage”: [
“string”
],
“CollectionTypeID”: 0,
“CollectionID”: 0,
“FamilyID”: 0,
“ResponseSetID”: 0,
“AuditStaffID”: 0,
“AuditDate”: “\/Date(1571411927090)\/”,
“AuditDateAsString”: “string”,
“ProgramName”: “string”,
“SiteName”: “string”,
“CollectionName”: “string”,
“StaffName”: “string”,
“SiteID”: 0,
“FormName”: “string”
}
}

7. Make any changes to the Response Elements in the TouchPoint you are attempting to update. The general style for each element will reflect this model. (See more information under Element Types)

{
"ElementID": 0,
"Value": {},
"ElementType": 0,
"ResponseElementChoices": [
{
"ResponseChoiceTableID": 0,
"TouchPointResponseChoiceID": 0,
"TouchPointElementChoiceID": 0,
"AuditStaffID": 0
}
],
"AttachmentDetailType": 0,
"ResponseStartAndEndTime": {
"StartTime": "string",
"EndTime": "string"
},
"DateOfNextContactDetailType": 0,
"ResponseAddressField": {
"Name": "string",
"Company": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"City": "string",
"State": "string",
"County": "string",
"PostalCode": "string",
"Country": "string"
},
"ResponseDateOfNextContact": {
"AlertDate": "\/Date(1571411927090)\/",
"TargetTouchPointID": 0,
"AlertNotes": "string",
"ProgramID": 0,
"StaffAccountID": 0
},
"ResponseFileAttachment": {
"FileContent": [
"string"
],
"FileName": "string",
"Caption": "string",
"ContentType": "string"
},
"ResponseFileAttachments": [
{
"FileContent": [
"string"
],
"FileName": "string",
"Caption": "string",
"ContentType": "string"
}
],
"ResponseCheckInField": {
"CheckInDateTime": "\/Date(1571411927090)\/",
"CheckOutDateTime": "\/Date(1571411927090)\/"
}
}

8. Post the response with the changes you made!

​Status Code 400 = Bad request
​Status Code 500 = Internal error, Error trying to update TouchPoint Response
​Status Code 502 = Server Connection Error (This can sometimes be a due to incorrectly formatted JSON. Please consider running the JSON through a validator before reaching out to Support.)
​Status Code 200 = Request was received and understood. See response header for details.
​

API Main Page