Method: PATCH Add or update a RESOLVE Event record for a Participant
Request Information
URI
https://services.anzdata.org.au/webservices/api/resolve/event/{id}
Parameters
Name | Description | Additional information |
---|---|---|
id |
The ANZDATA Patient ID / Registry Number |
Define this parameter in the request URI. |
value |
RESOLVE Event Object |
Define this parameter in the request body. |
Request body formats
** Empty XML node(s) or JSON element(s) should be excluded from posted data.
application/json, text/json
Sample:
{ "FacilityCode": "string 2", "EnrolmentDate": "2024-12-04T00:00:00", "EventDate": "2024-12-04T00:00:00", "EventTypeCode": 1, "TreatmentHospitalCode": "string 3" }
application/xml, text/xml
Sample:
<Event xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <FacilityCode>string 2</FacilityCode> <EnrolmentDate>2024-12-04T00:00:00</EnrolmentDate> <EventDate>2024-12-04T00:00:00</EventDate> <EventTypeCode>1</EventTypeCode> <TreatmentHospitalCode>string 3</TreatmentHospitalCode> </Event>
Response Information
Response body formats
application/json, text/json
Sample:
{ "Code": 1, "Message": "string 1", "SuccessMessages": [ "string 1", "string 2", "string 3" ], "WarningMessages": [ "string 1", "string 2", "string 3" ], "ErrorMessages": [ "string 1", "string 2", "string 3" ] }
application/xml, text/xml
Sample:
<ResponseBody xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Code>Success</Code> <Message>string 1</Message> <SuccessMessages> <SuccessMessage>string 1</SuccessMessage> <SuccessMessage>string 2</SuccessMessage> <SuccessMessage>string 3</SuccessMessage> </SuccessMessages> <WarningMessages> <WarningMessage>string 1</WarningMessage> <WarningMessage>string 2</WarningMessage> <WarningMessage>string 3</WarningMessage> </WarningMessages> <ErrorMessages> <ErrorMessage>string 1</ErrorMessage> <ErrorMessage>string 2</ErrorMessage> <ErrorMessage>string 3</ErrorMessage> </ErrorMessages> </ResponseBody>
Attribute Details
Attribute | Variable Label | Type | Length (Precision, Scale) |
Code | Comments |
---|---|---|---|---|---|
EventDate | Date | Required. |
|||
EventTypeCode | Number | Event Type Codes | Required. |
||
FacilityCode | String | 10 | Facility Codes | Required. Facility Code as at Enrolment Date |
|
TreatmentHospitalCode | String | 10 | Facility Codes | Treatment Hospital for the Acute Event |