GET api/UserInfo

Retrieve the status information related to a User

Request Information

URI Parameters

None.

Body Parameters

Collection of UserInfoRequest

Name	Description	Type	Additional information
PracticeID	External Practice ID	string	Required Max length: 100
ExternalId	External User ID	string	Max length: 100

Name

Description

Type

Additional information

PracticeID

External Practice ID

string

Required

Max length: 100

ExternalId

External User ID

string

Max length: 100

Request Formats

application/json, text/json

Sample:

[
  {
    "PracticeID": "sample string 1",
    "ExternalId": "sample string 2"
  },
  {
    "PracticeID": "sample string 1",
    "ExternalId": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.ApiModel">
  <UserInfoRequest>
    <ExternalId>sample string 2</ExternalId>
    <PracticeID>sample string 1</PracticeID>
  </UserInfoRequest>
  <UserInfoRequest>
    <ExternalId>sample string 2</ExternalId>
    <PracticeID>sample string 1</PracticeID>
  </UserInfoRequest>
</ArrayOfUserInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of UserInfoResult

Name	Description	Type	Additional information
Success	Indicates successful retrieval	boolean	None.
Message	Error message	string	None.
InReferenceToPracticeID	External Practice ID the User belongs to	string	None.
InReferenceToUserExternalId	User's External ID	string	None.
ConnectEhrStatus	Status Information for ConnectEHR	ConnectEhrStatusResult	None.
CqmSolutionStatus		CqmSolutionStatusResult	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Success": true,
    "Message": "sample string 2",
    "InReferenceToPracticeID": "sample string 3",
    "InReferenceToUserExternalId": "sample string 4",
    "ConnectEhrStatus": {
      "Success": true,
      "ErrorMessage": "sample string 2",
      "DirectOnboardingStatus": {
        "DirectOnboardingStatus": 1,
        "DirectOnboardingStatusDescription": "sample string 2",
        "DirectUsername": "sample string 3",
        "IdProofedIndividualId": 4
      },
      "UserIsActive": true
    },
    "CqmSolutionStatus": {
      "Success": true,
      "ErrorMessage": "sample string 2",
      "UserIsActive": true
    }
  },
  {
    "Success": true,
    "Message": "sample string 2",
    "InReferenceToPracticeID": "sample string 3",
    "InReferenceToUserExternalId": "sample string 4",
    "ConnectEhrStatus": {
      "Success": true,
      "ErrorMessage": "sample string 2",
      "DirectOnboardingStatus": {
        "DirectOnboardingStatus": 1,
        "DirectOnboardingStatusDescription": "sample string 2",
        "DirectUsername": "sample string 3",
        "IdProofedIndividualId": 4
      },
      "UserIsActive": true
    },
    "CqmSolutionStatus": {
      "Success": true,
      "ErrorMessage": "sample string 2",
      "UserIsActive": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserInfoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.ApiModel">
  <UserInfoResult>
    <ConnectEhrStatus>
      <DirectOnboardingStatus>
        <DirectOnboardingStatus>1</DirectOnboardingStatus>
        <DirectOnboardingStatusDescription>sample string 2</DirectOnboardingStatusDescription>
        <DirectUsername>sample string 3</DirectUsername>
        <IdProofedIndividualId>4</IdProofedIndividualId>
      </DirectOnboardingStatus>
      <ErrorMessage>sample string 2</ErrorMessage>
      <Success>true</Success>
      <UserIsActive>true</UserIsActive>
    </ConnectEhrStatus>
    <CqmSolutionStatus>
      <ErrorMessage>sample string 2</ErrorMessage>
      <Success>true</Success>
      <UserIsActive>true</UserIsActive>
    </CqmSolutionStatus>
    <InReferenceToPracticeID>sample string 3</InReferenceToPracticeID>
    <InReferenceToUserExternalId>sample string 4</InReferenceToUserExternalId>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </UserInfoResult>
  <UserInfoResult>
    <ConnectEhrStatus>
      <DirectOnboardingStatus>
        <DirectOnboardingStatus>1</DirectOnboardingStatus>
        <DirectOnboardingStatusDescription>sample string 2</DirectOnboardingStatusDescription>
        <DirectUsername>sample string 3</DirectUsername>
        <IdProofedIndividualId>4</IdProofedIndividualId>
      </DirectOnboardingStatus>
      <ErrorMessage>sample string 2</ErrorMessage>
      <Success>true</Success>
      <UserIsActive>true</UserIsActive>
    </ConnectEhrStatus>
    <CqmSolutionStatus>
      <ErrorMessage>sample string 2</ErrorMessage>
      <Success>true</Success>
      <UserIsActive>true</UserIsActive>
    </CqmSolutionStatus>
    <InReferenceToPracticeID>sample string 3</InReferenceToPracticeID>
    <InReferenceToUserExternalId>sample string 4</InReferenceToUserExternalId>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </UserInfoResult>
</ArrayOfUserInfoResult>