GET api/GroupExportStatus?requestid={requestid}

Gets status for Group Export Request.

Request Information

URI Parameters

Name	Description	Type	Additional information
requestid		string	Required

Body Parameters

None.

Response Information

Resource Description

GroupExportStatusResponse

Name	Description	Type	Additional information
RequestId	Request ID of the Group Export Request.	string	None.
Status	Indicates current status of the Group Export process.	string	None.
Details	Details of successfully / unsuccessfuly processed Practices and its patients.	GroupExportDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "RequestId": "sample string 1",
  "Status": "sample string 2",
  "Details": {
    "Practices": [
      {
        "ExternalId": "sample string 1",
        "GroupId": "sample string 2",
        "PassedValidation": [
          {
            "PatientId": "sample string 1",
            "Message": "sample string 2"
          },
          {
            "PatientId": "sample string 1",
            "Message": "sample string 2"
          }
        ],
        "FailedValidation": [
          {
            "PatientId": "sample string 1",
            "Message": "sample string 2"
          },
          {
            "PatientId": "sample string 1",
            "Message": "sample string 2"
          }
        ]
      },
      {
        "ExternalId": "sample string 1",
        "GroupId": "sample string 2",
        "PassedValidation": [
          {
            "PatientId": "sample string 1",
            "Message": "sample string 2"
          },
          {
            "PatientId": "sample string 1",
            "Message": "sample string 2"
          }
        ],
        "FailedValidation": [
          {
            "PatientId": "sample string 1",
            "Message": "sample string 2"
          },
          {
            "PatientId": "sample string 1",
            "Message": "sample string 2"
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GroupExportStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.FHIR">
  <Details>
    <Practices>
      <PracticeResponse>
        <ExternalId>sample string 1</ExternalId>
        <FailedValidation>
          <PatientResponse>
            <Message>sample string 2</Message>
            <PatientId>sample string 1</PatientId>
          </PatientResponse>
          <PatientResponse>
            <Message>sample string 2</Message>
            <PatientId>sample string 1</PatientId>
          </PatientResponse>
        </FailedValidation>
        <GroupId>sample string 2</GroupId>
        <PassedValidation>
          <PatientResponse>
            <Message>sample string 2</Message>
            <PatientId>sample string 1</PatientId>
          </PatientResponse>
          <PatientResponse>
            <Message>sample string 2</Message>
            <PatientId>sample string 1</PatientId>
          </PatientResponse>
        </PassedValidation>
      </PracticeResponse>
      <PracticeResponse>
        <ExternalId>sample string 1</ExternalId>
        <FailedValidation>
          <PatientResponse>
            <Message>sample string 2</Message>
            <PatientId>sample string 1</PatientId>
          </PatientResponse>
          <PatientResponse>
            <Message>sample string 2</Message>
            <PatientId>sample string 1</PatientId>
          </PatientResponse>
        </FailedValidation>
        <GroupId>sample string 2</GroupId>
        <PassedValidation>
          <PatientResponse>
            <Message>sample string 2</Message>
            <PatientId>sample string 1</PatientId>
          </PatientResponse>
          <PatientResponse>
            <Message>sample string 2</Message>
            <PatientId>sample string 1</PatientId>
          </PatientResponse>
        </PassedValidation>
      </PracticeResponse>
    </Practices>
  </Details>
  <RequestId>sample string 1</RequestId>
  <Status>sample string 2</Status>
</GroupExportStatusResponse>