Worklists Bundle

API change history

Access details of worklists in the shared record

Worklist - Data

Gets the worklist data.

Try it

Request

Request URL

Request parameters

  • string

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from CareCentric OAuth2 Server. Supported grant types: Resource owner password.

Request body

{
  "WorklistBehaviourResults": {
    "WorklistId": "string",
    "ColumnDefinition": [
      {
        "ColumnId": "string",
        "Name": "string",
        "DataType": "string",
        "Sortable": true,
        "Filterable": true,
        "IsDefaultSort": true,
        "IsMandatoryColumn": true,
        "SearchCriteria": [
          {
            "IsMandatory": true,
            "CriteriaId": "string",
            "CriteriaContent": "string",
            "AvailableValues": [
              "string"
            ],
            "DefaultValue": "string",
            "AllowAvailableValuesMultiselect": true
          }
        ]
      }
    ]
  },
  "WorklistId": "string",
  "DataRequestCriteria": [
    {
      "CriteriaId": "string",
      "ColumnId": "string",
      "SelectedValue": "string"
    }
  ],
  "Page": 0,
  "ResultsPerPage": 0
}
{
  "type": "object",
  "properties": {
    "WorklistBehaviourResults": {
      "type": "object",
      "properties": {
        "WorklistId": {
          "type": "string"
        },
        "ColumnDefinition": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ColumnId": {
                "type": "string"
              },
              "Name": {
                "type": "string"
              },
              "DataType": {
                "type": "string"
              },
              "Sortable": {
                "type": "boolean"
              },
              "Filterable": {
                "type": "boolean"
              },
              "IsDefaultSort": {
                "type": "boolean"
              },
              "IsMandatoryColumn": {
                "type": "boolean"
              },
              "SearchCriteria": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "IsMandatory": {
                      "type": "boolean"
                    },
                    "CriteriaId": {
                      "type": "string"
                    },
                    "CriteriaContent": {
                      "type": "string"
                    },
                    "AvailableValues": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "DefaultValue": {
                      "type": "string"
                    },
                    "AllowAvailableValuesMultiselect": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "WorklistId": {
      "type": "string"
    },
    "DataRequestCriteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "CriteriaId": {
            "type": "string"
          },
          "ColumnId": {
            "type": "string"
          },
          "SelectedValue": {
            "type": "string"
          }
        }
      }
    },
    "Page": {
      "format": "int32",
      "type": "integer"
    },
    "ResultsPerPage": {
      "format": "int32",
      "type": "integer"
    }
  }
}
{
  "WorklistBehaviourResults": {
    "WorklistId": "string",
    "ColumnDefinition": [
      {
        "ColumnId": "string",
        "Name": "string",
        "DataType": "string",
        "Sortable": true,
        "Filterable": true,
        "IsDefaultSort": true,
        "IsMandatoryColumn": true,
        "SearchCriteria": [
          {
            "IsMandatory": true,
            "CriteriaId": "string",
            "CriteriaContent": "string",
            "AvailableValues": [
              "string"
            ],
            "DefaultValue": "string",
            "AllowAvailableValuesMultiselect": true
          }
        ]
      }
    ]
  },
  "WorklistId": "string",
  "DataRequestCriteria": [
    {
      "CriteriaId": "string",
      "ColumnId": "string",
      "SelectedValue": "string"
    }
  ],
  "Page": 0,
  "ResultsPerPage": 0
}
{
  "type": "object",
  "properties": {
    "WorklistBehaviourResults": {
      "type": "object",
      "properties": {
        "WorklistId": {
          "type": "string"
        },
        "ColumnDefinition": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ColumnId": {
                "type": "string"
              },
              "Name": {
                "type": "string"
              },
              "DataType": {
                "type": "string"
              },
              "Sortable": {
                "type": "boolean"
              },
              "Filterable": {
                "type": "boolean"
              },
              "IsDefaultSort": {
                "type": "boolean"
              },
              "IsMandatoryColumn": {
                "type": "boolean"
              },
              "SearchCriteria": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "IsMandatory": {
                      "type": "boolean"
                    },
                    "CriteriaId": {
                      "type": "string"
                    },
                    "CriteriaContent": {
                      "type": "string"
                    },
                    "AvailableValues": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "DefaultValue": {
                      "type": "string"
                    },
                    "AllowAvailableValuesMultiselect": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "WorklistId": {
      "type": "string"
    },
    "DataRequestCriteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "CriteriaId": {
            "type": "string"
          },
          "ColumnId": {
            "type": "string"
          },
          "SelectedValue": {
            "type": "string"
          }
        }
      }
    },
    "Page": {
      "format": "int32",
      "type": "integer"
    },
    "ResultsPerPage": {
      "format": "int32",
      "type": "integer"
    }
  }
}
<Worklists.Model.WorklistDataRequest>
  <WorklistBehaviourResults>
    <WorklistId>string</WorklistId>
    <ColumnDefinition>
      <ColumnId>string</ColumnId>
      <Name>string</Name>
      <DataType>string</DataType>
      <Sortable>true</Sortable>
      <Filterable>true</Filterable>
      <IsDefaultSort>true</IsDefaultSort>
      <IsMandatoryColumn>true</IsMandatoryColumn>
      <SearchCriteria>
        <IsMandatory>true</IsMandatory>
        <CriteriaId>string</CriteriaId>
        <CriteriaContent>string</CriteriaContent>
        <AvailableValues>string</AvailableValues>
        <DefaultValue>string</DefaultValue>
        <AllowAvailableValuesMultiselect>true</AllowAvailableValuesMultiselect>
      </SearchCriteria>
    </ColumnDefinition>
  </WorklistBehaviourResults>
  <WorklistId>string</WorklistId>
  <DataRequestCriteria>
    <CriteriaId>string</CriteriaId>
    <ColumnId>string</ColumnId>
    <SelectedValue>string</SelectedValue>
  </DataRequestCriteria>
  <Page>0</Page>
  <ResultsPerPage>0</ResultsPerPage>
</Worklists.Model.WorklistDataRequest>
{
  "type": "object",
  "properties": {
    "WorklistBehaviourResults": {
      "type": "object",
      "properties": {
        "WorklistId": {
          "type": "string"
        },
        "ColumnDefinition": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ColumnId": {
                "type": "string"
              },
              "Name": {
                "type": "string"
              },
              "DataType": {
                "type": "string"
              },
              "Sortable": {
                "type": "boolean"
              },
              "Filterable": {
                "type": "boolean"
              },
              "IsDefaultSort": {
                "type": "boolean"
              },
              "IsMandatoryColumn": {
                "type": "boolean"
              },
              "SearchCriteria": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "IsMandatory": {
                      "type": "boolean"
                    },
                    "CriteriaId": {
                      "type": "string"
                    },
                    "CriteriaContent": {
                      "type": "string"
                    },
                    "AvailableValues": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "DefaultValue": {
                      "type": "string"
                    },
                    "AllowAvailableValuesMultiselect": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "WorklistId": {
      "type": "string"
    },
    "DataRequestCriteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "CriteriaId": {
            "type": "string"
          },
          "ColumnId": {
            "type": "string"
          },
          "SelectedValue": {
            "type": "string"
          }
        }
      }
    },
    "Page": {
      "format": "int32",
      "type": "integer"
    },
    "ResultsPerPage": {
      "format": "int32",
      "type": "integer"
    }
  }
}
<Worklists.Model.WorklistDataRequest>
  <WorklistBehaviourResults>
    <WorklistId>string</WorklistId>
    <ColumnDefinition>
      <ColumnId>string</ColumnId>
      <Name>string</Name>
      <DataType>string</DataType>
      <Sortable>true</Sortable>
      <Filterable>true</Filterable>
      <IsDefaultSort>true</IsDefaultSort>
      <IsMandatoryColumn>true</IsMandatoryColumn>
      <SearchCriteria>
        <IsMandatory>true</IsMandatory>
        <CriteriaId>string</CriteriaId>
        <CriteriaContent>string</CriteriaContent>
        <AvailableValues>string</AvailableValues>
        <DefaultValue>string</DefaultValue>
        <AllowAvailableValuesMultiselect>true</AllowAvailableValuesMultiselect>
      </SearchCriteria>
    </ColumnDefinition>
  </WorklistBehaviourResults>
  <WorklistId>string</WorklistId>
  <DataRequestCriteria>
    <CriteriaId>string</CriteriaId>
    <ColumnId>string</ColumnId>
    <SelectedValue>string</SelectedValue>
  </DataRequestCriteria>
  <Page>0</Page>
  <ResultsPerPage>0</ResultsPerPage>
</Worklists.Model.WorklistDataRequest>
{
  "type": "object",
  "properties": {
    "WorklistBehaviourResults": {
      "type": "object",
      "properties": {
        "WorklistId": {
          "type": "string"
        },
        "ColumnDefinition": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ColumnId": {
                "type": "string"
              },
              "Name": {
                "type": "string"
              },
              "DataType": {
                "type": "string"
              },
              "Sortable": {
                "type": "boolean"
              },
              "Filterable": {
                "type": "boolean"
              },
              "IsDefaultSort": {
                "type": "boolean"
              },
              "IsMandatoryColumn": {
                "type": "boolean"
              },
              "SearchCriteria": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "IsMandatory": {
                      "type": "boolean"
                    },
                    "CriteriaId": {
                      "type": "string"
                    },
                    "CriteriaContent": {
                      "type": "string"
                    },
                    "AvailableValues": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "DefaultValue": {
                      "type": "string"
                    },
                    "AllowAvailableValuesMultiselect": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "WorklistId": {
      "type": "string"
    },
    "DataRequestCriteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "CriteriaId": {
            "type": "string"
          },
          "ColumnId": {
            "type": "string"
          },
          "SelectedValue": {
            "type": "string"
          }
        }
      }
    },
    "Page": {
      "format": "int32",
      "type": "integer"
    },
    "ResultsPerPage": {
      "format": "int32",
      "type": "integer"
    }
  }
}

Responses

200 OK

Successful operation

Representations

{
  "WorklistId": "string",
  "TotalResults": 0,
  "PatientData": [
    {
      "DemographicData": {
        "Title": "string",
        "Surname": "string",
        "Forename": "string",
        "Address": "string",
        "DateOfBirth": "string",
        "DateOfDeath": "string",
        "LocalId": "string",
        "NationalId": "string",
        "DetailID": 0,
        "Gender": "string",
        "Postcode": "string",
        "SourceSiteCode": "string",
        "HasLinkedPatients": true,
        "IsMinorPatient": true,
        "RestrictedDemographics": true,
        "RestrictedRecord": true,
        "PatientContexts": {
          "RapportId": "string",
          "PatientLinksId": "string",
          "ExternalContexts": [
            {
              "ExternalName": "string",
              "ExternalId": "string",
              "NationalId": "string",
              "LocalId": "string",
              "IsMainId": true,
              "IsOriginal": true,
              "OtherIds": {}
            }
          ],
          "ContextIdAuthToken": "string"
        },
        "ContactNumber": "string",
        "RegisteredGp": {
          "Forename": "string",
          "Surname": "string",
          "Title": "string",
          "PracticeAddress": {
            "Line1": "string",
            "Line2": "string",
            "Line3": "string",
            "Line4": "string",
            "Line5": "string",
            "Postcode": "string",
            "Country": "string",
            "Formatted": "string"
          },
          "Surgery": "string",
          "ContactNumber": "string"
        },
        "Deleted": true
      },
      "ColumnData": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "WorklistId": {
      "type": "string"
    },
    "TotalResults": {
      "format": "int32",
      "type": "integer"
    },
    "PatientData": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "DemographicData": {
            "type": "object",
            "properties": {
              "Title": {
                "type": "string"
              },
              "Surname": {
                "type": "string"
              },
              "Forename": {
                "type": "string"
              },
              "Address": {
                "type": "string"
              },
              "DateOfBirth": {
                "type": "string"
              },
              "DateOfDeath": {
                "type": "string"
              },
              "LocalId": {
                "type": "string"
              },
              "NationalId": {
                "type": "string"
              },
              "DetailID": {
                "format": "int32",
                "type": "integer"
              },
              "Gender": {
                "type": "string"
              },
              "Postcode": {
                "type": "string"
              },
              "SourceSiteCode": {
                "type": "string"
              },
              "HasLinkedPatients": {
                "type": "boolean"
              },
              "IsMinorPatient": {
                "type": "boolean"
              },
              "RestrictedDemographics": {
                "type": "boolean"
              },
              "RestrictedRecord": {
                "type": "boolean"
              },
              "PatientContexts": {
                "type": "object",
                "properties": {
                  "RapportId": {
                    "type": "string"
                  },
                  "PatientLinksId": {
                    "type": "string"
                  },
                  "ExternalContexts": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ExternalName": {
                          "type": "string"
                        },
                        "ExternalId": {
                          "type": "string"
                        },
                        "NationalId": {
                          "type": "string"
                        },
                        "LocalId": {
                          "type": "string"
                        },
                        "IsMainId": {
                          "type": "boolean"
                        },
                        "IsOriginal": {
                          "type": "boolean"
                        },
                        "OtherIds": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  },
                  "ContextIdAuthToken": {
                    "type": "string"
                  }
                }
              },
              "ContactNumber": {
                "type": "string"
              },
              "RegisteredGp": {
                "type": "object",
                "properties": {
                  "Forename": {
                    "type": "string"
                  },
                  "Surname": {
                    "type": "string"
                  },
                  "Title": {
                    "type": "string"
                  },
                  "PracticeAddress": {
                    "type": "object",
                    "properties": {
                      "Line1": {
                        "type": "string"
                      },
                      "Line2": {
                        "type": "string"
                      },
                      "Line3": {
                        "type": "string"
                      },
                      "Line4": {
                        "type": "string"
                      },
                      "Line5": {
                        "type": "string"
                      },
                      "Postcode": {
                        "type": "string"
                      },
                      "Country": {
                        "type": "string"
                      },
                      "Formatted": {
                        "type": "string"
                      }
                    }
                  },
                  "Surgery": {
                    "type": "string"
                  },
                  "ContactNumber": {
                    "type": "string"
                  }
                }
              },
              "Deleted": {
                "type": "boolean"
              }
            }
          },
          "ColumnData": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
{
  "WorklistId": "string",
  "TotalResults": 0,
  "PatientData": [
    {
      "DemographicData": {
        "Title": "string",
        "Surname": "string",
        "Forename": "string",
        "Address": "string",
        "DateOfBirth": "string",
        "DateOfDeath": "string",
        "LocalId": "string",
        "NationalId": "string",
        "DetailID": 0,
        "Gender": "string",
        "Postcode": "string",
        "SourceSiteCode": "string",
        "HasLinkedPatients": true,
        "IsMinorPatient": true,
        "RestrictedDemographics": true,
        "RestrictedRecord": true,
        "PatientContexts": {
          "RapportId": "string",
          "PatientLinksId": "string",
          "ExternalContexts": [
            {
              "ExternalName": "string",
              "ExternalId": "string",
              "NationalId": "string",
              "LocalId": "string",
              "IsMainId": true,
              "IsOriginal": true,
              "OtherIds": {}
            }
          ],
          "ContextIdAuthToken": "string"
        },
        "ContactNumber": "string",
        "RegisteredGp": {
          "Forename": "string",
          "Surname": "string",
          "Title": "string",
          "PracticeAddress": {
            "Line1": "string",
            "Line2": "string",
            "Line3": "string",
            "Line4": "string",
            "Line5": "string",
            "Postcode": "string",
            "Country": "string",
            "Formatted": "string"
          },
          "Surgery": "string",
          "ContactNumber": "string"
        },
        "Deleted": true
      },
      "ColumnData": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "WorklistId": {
      "type": "string"
    },
    "TotalResults": {
      "format": "int32",
      "type": "integer"
    },
    "PatientData": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "DemographicData": {
            "type": "object",
            "properties": {
              "Title": {
                "type": "string"
              },
              "Surname": {
                "type": "string"
              },
              "Forename": {
                "type": "string"
              },
              "Address": {
                "type": "string"
              },
              "DateOfBirth": {
                "type": "string"
              },
              "DateOfDeath": {
                "type": "string"
              },
              "LocalId": {
                "type": "string"
              },
              "NationalId": {
                "type": "string"
              },
              "DetailID": {
                "format": "int32",
                "type": "integer"
              },
              "Gender": {
                "type": "string"
              },
              "Postcode": {
                "type": "string"
              },
              "SourceSiteCode": {
                "type": "string"
              },
              "HasLinkedPatients": {
                "type": "boolean"
              },
              "IsMinorPatient": {
                "type": "boolean"
              },
              "RestrictedDemographics": {
                "type": "boolean"
              },
              "RestrictedRecord": {
                "type": "boolean"
              },
              "PatientContexts": {
                "type": "object",
                "properties": {
                  "RapportId": {
                    "type": "string"
                  },
                  "PatientLinksId": {
                    "type": "string"
                  },
                  "ExternalContexts": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ExternalName": {
                          "type": "string"
                        },
                        "ExternalId": {
                          "type": "string"
                        },
                        "NationalId": {
                          "type": "string"
                        },
                        "LocalId": {
                          "type": "string"
                        },
                        "IsMainId": {
                          "type": "boolean"
                        },
                        "IsOriginal": {
                          "type": "boolean"
                        },
                        "OtherIds": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  },
                  "ContextIdAuthToken": {
                    "type": "string"
                  }
                }
              },
              "ContactNumber": {
                "type": "string"
              },
              "RegisteredGp": {
                "type": "object",
                "properties": {
                  "Forename": {
                    "type": "string"
                  },
                  "Surname": {
                    "type": "string"
                  },
                  "Title": {
                    "type": "string"
                  },
                  "PracticeAddress": {
                    "type": "object",
                    "properties": {
                      "Line1": {
                        "type": "string"
                      },
                      "Line2": {
                        "type": "string"
                      },
                      "Line3": {
                        "type": "string"
                      },
                      "Line4": {
                        "type": "string"
                      },
                      "Line5": {
                        "type": "string"
                      },
                      "Postcode": {
                        "type": "string"
                      },
                      "Country": {
                        "type": "string"
                      },
                      "Formatted": {
                        "type": "string"
                      }
                    }
                  },
                  "Surgery": {
                    "type": "string"
                  },
                  "ContactNumber": {
                    "type": "string"
                  }
                }
              },
              "Deleted": {
                "type": "boolean"
              }
            }
          },
          "ColumnData": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
<Worklists.Model.WorklistDataResults>
  <WorklistId>string</WorklistId>
  <TotalResults>0</TotalResults>
  <PatientData>
    <DemographicData>
      <Title>string</Title>
      <Surname>string</Surname>
      <Forename>string</Forename>
      <Address>string</Address>
      <DateOfBirth>string</DateOfBirth>
      <DateOfDeath>string</DateOfDeath>
      <LocalId>string</LocalId>
      <NationalId>string</NationalId>
      <DetailID>0</DetailID>
      <Gender>string</Gender>
      <Postcode>string</Postcode>
      <SourceSiteCode>string</SourceSiteCode>
      <HasLinkedPatients>true</HasLinkedPatients>
      <IsMinorPatient>true</IsMinorPatient>
      <RestrictedDemographics>true</RestrictedDemographics>
      <RestrictedRecord>true</RestrictedRecord>
      <PatientContexts>
        <RapportId>string</RapportId>
        <PatientLinksId>string</PatientLinksId>
        <ExternalContexts>
          <ExternalName>string</ExternalName>
          <ExternalId>string</ExternalId>
          <NationalId>string</NationalId>
          <LocalId>string</LocalId>
          <IsMainId>true</IsMainId>
          <IsOriginal>true</IsOriginal>
          <OtherIds />
        </ExternalContexts>
        <ContextIdAuthToken>string</ContextIdAuthToken>
      </PatientContexts>
      <ContactNumber>string</ContactNumber>
      <RegisteredGp>
        <Forename>string</Forename>
        <Surname>string</Surname>
        <Title>string</Title>
        <PracticeAddress>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <Line4>string</Line4>
          <Line5>string</Line5>
          <Postcode>string</Postcode>
          <Country>string</Country>
          <Formatted>string</Formatted>
        </PracticeAddress>
        <Surgery>string</Surgery>
        <ContactNumber>string</ContactNumber>
      </RegisteredGp>
      <Deleted>true</Deleted>
    </DemographicData>
    <ColumnData>
      <key>string</key>
      <value>string</value>
    </ColumnData>
  </PatientData>
</Worklists.Model.WorklistDataResults>
{
  "type": "object",
  "properties": {
    "WorklistId": {
      "type": "string"
    },
    "TotalResults": {
      "format": "int32",
      "type": "integer"
    },
    "PatientData": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "DemographicData": {
            "type": "object",
            "properties": {
              "Title": {
                "type": "string"
              },
              "Surname": {
                "type": "string"
              },
              "Forename": {
                "type": "string"
              },
              "Address": {
                "type": "string"
              },
              "DateOfBirth": {
                "type": "string"
              },
              "DateOfDeath": {
                "type": "string"
              },
              "LocalId": {
                "type": "string"
              },
              "NationalId": {
                "type": "string"
              },
              "DetailID": {
                "format": "int32",
                "type": "integer"
              },
              "Gender": {
                "type": "string"
              },
              "Postcode": {
                "type": "string"
              },
              "SourceSiteCode": {
                "type": "string"
              },
              "HasLinkedPatients": {
                "type": "boolean"
              },
              "IsMinorPatient": {
                "type": "boolean"
              },
              "RestrictedDemographics": {
                "type": "boolean"
              },
              "RestrictedRecord": {
                "type": "boolean"
              },
              "PatientContexts": {
                "type": "object",
                "properties": {
                  "RapportId": {
                    "type": "string"
                  },
                  "PatientLinksId": {
                    "type": "string"
                  },
                  "ExternalContexts": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ExternalName": {
                          "type": "string"
                        },
                        "ExternalId": {
                          "type": "string"
                        },
                        "NationalId": {
                          "type": "string"
                        },
                        "LocalId": {
                          "type": "string"
                        },
                        "IsMainId": {
                          "type": "boolean"
                        },
                        "IsOriginal": {
                          "type": "boolean"
                        },
                        "OtherIds": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  },
                  "ContextIdAuthToken": {
                    "type": "string"
                  }
                }
              },
              "ContactNumber": {
                "type": "string"
              },
              "RegisteredGp": {
                "type": "object",
                "properties": {
                  "Forename": {
                    "type": "string"
                  },
                  "Surname": {
                    "type": "string"
                  },
                  "Title": {
                    "type": "string"
                  },
                  "PracticeAddress": {
                    "type": "object",
                    "properties": {
                      "Line1": {
                        "type": "string"
                      },
                      "Line2": {
                        "type": "string"
                      },
                      "Line3": {
                        "type": "string"
                      },
                      "Line4": {
                        "type": "string"
                      },
                      "Line5": {
                        "type": "string"
                      },
                      "Postcode": {
                        "type": "string"
                      },
                      "Country": {
                        "type": "string"
                      },
                      "Formatted": {
                        "type": "string"
                      }
                    }
                  },
                  "Surgery": {
                    "type": "string"
                  },
                  "ContactNumber": {
                    "type": "string"
                  }
                }
              },
              "Deleted": {
                "type": "boolean"
              }
            }
          },
          "ColumnData": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
<Worklists.Model.WorklistDataResults>
  <WorklistId>string</WorklistId>
  <TotalResults>0</TotalResults>
  <PatientData>
    <DemographicData>
      <Title>string</Title>
      <Surname>string</Surname>
      <Forename>string</Forename>
      <Address>string</Address>
      <DateOfBirth>string</DateOfBirth>
      <DateOfDeath>string</DateOfDeath>
      <LocalId>string</LocalId>
      <NationalId>string</NationalId>
      <DetailID>0</DetailID>
      <Gender>string</Gender>
      <Postcode>string</Postcode>
      <SourceSiteCode>string</SourceSiteCode>
      <HasLinkedPatients>true</HasLinkedPatients>
      <IsMinorPatient>true</IsMinorPatient>
      <RestrictedDemographics>true</RestrictedDemographics>
      <RestrictedRecord>true</RestrictedRecord>
      <PatientContexts>
        <RapportId>string</RapportId>
        <PatientLinksId>string</PatientLinksId>
        <ExternalContexts>
          <ExternalName>string</ExternalName>
          <ExternalId>string</ExternalId>
          <NationalId>string</NationalId>
          <LocalId>string</LocalId>
          <IsMainId>true</IsMainId>
          <IsOriginal>true</IsOriginal>
          <OtherIds />
        </ExternalContexts>
        <ContextIdAuthToken>string</ContextIdAuthToken>
      </PatientContexts>
      <ContactNumber>string</ContactNumber>
      <RegisteredGp>
        <Forename>string</Forename>
        <Surname>string</Surname>
        <Title>string</Title>
        <PracticeAddress>
          <Line1>string</Line1>
          <Line2>string</Line2>
          <Line3>string</Line3>
          <Line4>string</Line4>
          <Line5>string</Line5>
          <Postcode>string</Postcode>
          <Country>string</Country>
          <Formatted>string</Formatted>
        </PracticeAddress>
        <Surgery>string</Surgery>
        <ContactNumber>string</ContactNumber>
      </RegisteredGp>
      <Deleted>true</Deleted>
    </DemographicData>
    <ColumnData>
      <key>string</key>
      <value>string</value>
    </ColumnData>
  </PatientData>
</Worklists.Model.WorklistDataResults>
{
  "type": "object",
  "properties": {
    "WorklistId": {
      "type": "string"
    },
    "TotalResults": {
      "format": "int32",
      "type": "integer"
    },
    "PatientData": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "DemographicData": {
            "type": "object",
            "properties": {
              "Title": {
                "type": "string"
              },
              "Surname": {
                "type": "string"
              },
              "Forename": {
                "type": "string"
              },
              "Address": {
                "type": "string"
              },
              "DateOfBirth": {
                "type": "string"
              },
              "DateOfDeath": {
                "type": "string"
              },
              "LocalId": {
                "type": "string"
              },
              "NationalId": {
                "type": "string"
              },
              "DetailID": {
                "format": "int32",
                "type": "integer"
              },
              "Gender": {
                "type": "string"
              },
              "Postcode": {
                "type": "string"
              },
              "SourceSiteCode": {
                "type": "string"
              },
              "HasLinkedPatients": {
                "type": "boolean"
              },
              "IsMinorPatient": {
                "type": "boolean"
              },
              "RestrictedDemographics": {
                "type": "boolean"
              },
              "RestrictedRecord": {
                "type": "boolean"
              },
              "PatientContexts": {
                "type": "object",
                "properties": {
                  "RapportId": {
                    "type": "string"
                  },
                  "PatientLinksId": {
                    "type": "string"
                  },
                  "ExternalContexts": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ExternalName": {
                          "type": "string"
                        },
                        "ExternalId": {
                          "type": "string"
                        },
                        "NationalId": {
                          "type": "string"
                        },
                        "LocalId": {
                          "type": "string"
                        },
                        "IsMainId": {
                          "type": "boolean"
                        },
                        "IsOriginal": {
                          "type": "boolean"
                        },
                        "OtherIds": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  },
                  "ContextIdAuthToken": {
                    "type": "string"
                  }
                }
              },
              "ContactNumber": {
                "type": "string"
              },
              "RegisteredGp": {
                "type": "object",
                "properties": {
                  "Forename": {
                    "type": "string"
                  },
                  "Surname": {
                    "type": "string"
                  },
                  "Title": {
                    "type": "string"
                  },
                  "PracticeAddress": {
                    "type": "object",
                    "properties": {
                      "Line1": {
                        "type": "string"
                      },
                      "Line2": {
                        "type": "string"
                      },
                      "Line3": {
                        "type": "string"
                      },
                      "Line4": {
                        "type": "string"
                      },
                      "Line5": {
                        "type": "string"
                      },
                      "Postcode": {
                        "type": "string"
                      },
                      "Country": {
                        "type": "string"
                      },
                      "Formatted": {
                        "type": "string"
                      }
                    }
                  },
                  "Surgery": {
                    "type": "string"
                  },
                  "ContactNumber": {
                    "type": "string"
                  }
                }
              },
              "Deleted": {
                "type": "boolean"
              }
            }
          },
          "ColumnData": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

400 Bad Request

Invalid parameter supplied

401 Unauthorized

Invalid credentials supplied

404 Not Found

Specified entity was not found or access denied

Code samples

@ECHO OFF

curl -v -X POST "https://graphnet-api-nonprod.azure-api.net/worklists/worklists/{listId}/data"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            var uri = "https://graphnet-api-nonprod.azure-api.net/worklists/worklists/{listId}/data?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://graphnet-api-nonprod.azure-api.net/worklists/worklists/{listId}/data");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "{access token}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://graphnet-api-nonprod.azure-api.net/worklists/worklists/{listId}/data?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://graphnet-api-nonprod.azure-api.net/worklists/worklists/{listId}/data";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://graphnet-api-nonprod.azure-api.net/worklists/worklists/{listId}/data');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
    conn.request("POST", "/worklists/worklists/{listId}/data?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('graphnet-api-nonprod.azure-api.net')
    conn.request("POST", "/worklists/worklists/{listId}/data?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://graphnet-api-nonprod.azure-api.net/worklists/worklists/{listId}/data')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body