api/TeachPd/Maintain/{id}

Method: PATCH

Enrol or Update a TEACH-PD Trial Participant

Request Information

URI

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

Parameters

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

{
  "StatusDate": "2024-04-26T00:00:00",
  "Status": 1,
  "StatusReason": "string 1",
  "NZStudyNumber": "string 2"
}

application/xml, text/xml

Sample:

<TEACHPD xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StatusDate>2024-04-26T00:00:00</StatusDate>
  <Status>1</Status>
  <StatusReason>string 1</StatusReason>
  <NZStudyNumber>string 2</NZStudyNumber>
</TEACHPD>

Response Information

Response body formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Message": "string 1",
  "AnzdataStudyNumber": 1,
  "TeachPdStudyNumber": 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>
  <AnzdataStudyNumber>1</AnzdataStudyNumber>
  <TeachPdStudyNumber>1</TeachPdStudyNumber>
  <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
NZStudyNumber	NZ Study Number	String	100
Status	Status	Number		Trial Patient Status Codes	Required.
StatusDate	Status Date	Date			Required.
StatusReason	Status Reason Other specify	String	50		Required if Status of "Specify" is provided.