api/infection/maintain/{id}

Method: PATCH

Create or Update Infection records for an existing patient.

Request Information

URI

https://services.anzdata.org.au/webservices/api/infection/maintain/{id}

Parameters

Name	Description	Additional information
id	The ANZDATA Patient ID / Registry Number	Define this parameter in the request URI.
value	Infection 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:

{
  "InfectionCode": "string 1",
  "TestDate": "2024-12-04T00:00:00",
  "ResultCode": "string 2",
  "Comments": "string 3"
}

application/xml, text/xml

Sample:

<Infection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InfectionCode>string 1</InfectionCode>
  <TestDate>2024-12-04T00:00:00</TestDate>
  <ResultCode>string 2</ResultCode>
  <Comments>string 3</Comments>
</Infection>

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
Comments	Comments	String
InfectionCode	Name of Infection code	String	10	Infection Codes	Required.
ResultCode	Test result	String	10	Infection Test Result Codes	Required. Valid codes are dependant on associated field, refer to 'Valid for' column on Codes page.
TestDate	Test date	Date			Required.