POST Patient/Update

Update patient

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Id	Patient Id	integer	None.
First	First Name [DonorInfo_NameAndOther_Edit]	string	None.
Last	Last Name [DonorInfo_NameAndOther_Edit]	string	None.
Middle	Middle name [DonorInfo_NameAndOther_Edit]	string	None.
ProgramId	Program Id - Readonly	integer	None.
AccountId	Account Id - Readonly	integer	None.
DonorId1	PIN Code	string	None.
Birthdate	Donor Birthday [DonorInfo_NameAndOther_Edit]	date	None.
Gender	Gender [DonorInfo_NameAndOther_Edit]	string	None.
Ethnicity	Race [DonorInfo_NameAndOther_Edit]	string	None.
Status	Is Donor Active or Not DonorInfo_Active	boolean	None.
ProgramsGroupId	Frequency Group Id [DonorInfo_NameAndOther_Edit]	integer	None.
ProgramsPanelsGroupsId	Panel Group Id [Donor_PanelGroupEdit]	integer	None.
ManagerId1	Case Manager Id [DonorInfo_ContactAndOther_Edit]	integer	None.
ManagerId2	Case Manager Id [DonorInfo_ContactAndOther_Edit]	integer	None.
Picture	Picture as Base64 string	string	None.
AvailableFrequencyGroups	list of available frequency groups	Collection of FrequencyGroup	None.
AvailableGenders	list of available genders	Collection of string	None.
AvailableEthnicities	list of available races	Collection of string	None.
AvailablePanelGroups	list of available panel groups	Collection of PanelGroup	None.
AvailableCaseManagers	list of available Case Managers	Collection of CaseManager	None.
DonorInfo_Active	Permissions	boolean	None.
DonorInfo_ContactAndOther_Edit	Permissions	boolean	None.
DonorInfo_ContactAndOther_View	Permissions	boolean	None.
DonorInfo_PanelGroupEdit	Permissions	boolean	None.
DonorInfo_NameAndOther_Edit	Permissions	boolean	None.
IsLocked_CaseManager1	If true, ManagerId is not editable	boolean	None.
IsRequired_CaseManager1	If true, ManagerId is a required field	boolean	None.
CanCreateNewOrder	If true, New Order button is visible	boolean	None.
PatientId2	Patient Id 2	string	None.
PatientId3	Patient Id 3	string	None.
PatientId2InstructionalText	PatientId 2 Instructional Text	string	None.
PatientId3InstructionalText	PatientId 3 Instructional Text	string	None.
RequiredId2		boolean	None.
RequiredId3		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "First": "sample string 2",
  "Last": "sample string 3",
  "Middle": "sample string 4",
  "ProgramId": 1,
  "AccountId": 1,
  "DonorId1": "sample string 5",
  "Birthdate": "2024-11-14T15:13:42.2915968+00:00",
  "Gender": "sample string 6",
  "Ethnicity": "sample string 7",
  "Status": true,
  "ProgramsGroupId": 1,
  "ProgramsPanelsGroupsId": 1,
  "ManagerId1": 1,
  "ManagerId2": 1,
  "Picture": "sample string 9",
  "AvailableFrequencyGroups": [
    {
      "Id": 1,
      "Name": "sample string 1",
      "IsDefault": true
    },
    {
      "Id": 1,
      "Name": "sample string 1",
      "IsDefault": true
    }
  ],
  "AvailableGenders": [
    "sample string 1",
    "sample string 2"
  ],
  "AvailableEthnicities": [
    "sample string 1",
    "sample string 2"
  ],
  "AvailablePanelGroups": [
    {
      "Id": 1,
      "Name": "sample string 1"
    },
    {
      "Id": 1,
      "Name": "sample string 1"
    }
  ],
  "AvailableCaseManagers": [
    {
      "Id": 1,
      "Name": "sample string 1"
    },
    {
      "Id": 1,
      "Name": "sample string 1"
    }
  ],
  "DonorInfo_Active": true,
  "DonorInfo_ContactAndOther_Edit": true,
  "DonorInfo_ContactAndOther_View": true,
  "DonorInfo_PanelGroupEdit": true,
  "DonorInfo_NameAndOther_Edit": true,
  "IsLocked_CaseManager1": true,
  "IsRequired_CaseManager1": true,
  "CanCreateNewOrder": true,
  "PatientId2": "sample string 16",
  "PatientId3": "sample string 17",
  "PatientId2InstructionalText": "sample string 18",
  "PatientId3InstructionalText": "sample string 19",
  "RequiredId2": true,
  "RequiredId3": true
}

application/xml, text/xml

Sample:

<Patient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avertest.Aversys.DataLayer.Patients">
  <AccountId>1</AccountId>
  <AvailableCaseManagers>
    <CaseManager>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </CaseManager>
    <CaseManager>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </CaseManager>
  </AvailableCaseManagers>
  <AvailableEthnicities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AvailableEthnicities>
  <AvailableFrequencyGroups>
    <FrequencyGroup>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </FrequencyGroup>
    <FrequencyGroup>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </FrequencyGroup>
  </AvailableFrequencyGroups>
  <AvailableGenders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AvailableGenders>
  <AvailablePanelGroups>
    <PanelGroup>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </PanelGroup>
    <PanelGroup>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </PanelGroup>
  </AvailablePanelGroups>
  <Birthdate>2024-11-14T15:13:42.2915968+00:00</Birthdate>
  <CanCreateNewOrder>true</CanCreateNewOrder>
  <DonorId1>sample string 5</DonorId1>
  <DonorInfo_Active>true</DonorInfo_Active>
  <DonorInfo_ContactAndOther_Edit>true</DonorInfo_ContactAndOther_Edit>
  <DonorInfo_ContactAndOther_View>true</DonorInfo_ContactAndOther_View>
  <DonorInfo_NameAndOther_Edit>true</DonorInfo_NameAndOther_Edit>
  <DonorInfo_PanelGroupEdit>true</DonorInfo_PanelGroupEdit>
  <Ethnicity>sample string 7</Ethnicity>
  <First>sample string 2</First>
  <Gender>sample string 6</Gender>
  <Id>1</Id>
  <IsLocked_CaseManager1>true</IsLocked_CaseManager1>
  <IsRequired_CaseManager1>true</IsRequired_CaseManager1>
  <Last>sample string 3</Last>
  <ManagerId1>1</ManagerId1>
  <ManagerId2>1</ManagerId2>
  <Middle>sample string 4</Middle>
  <PatientId2>sample string 16</PatientId2>
  <PatientId2InstructionalText>sample string 18</PatientId2InstructionalText>
  <PatientId3>sample string 17</PatientId3>
  <PatientId3InstructionalText>sample string 19</PatientId3InstructionalText>
  <Picture>sample string 9</Picture>
  <ProgramId>1</ProgramId>
  <ProgramsGroupId>1</ProgramsGroupId>
  <ProgramsPanelsGroupsId>1</ProgramsPanelsGroupsId>
  <Status>true</Status>
</Patient>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Patient'.

Response Information

Resource Description

UpdateDonorInfo

Name	Description	Type	Additional information
IsSuccess		boolean	None.
Patient		Patient	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Patient": {
    "Id": 1,
    "First": "sample string 2",
    "Last": "sample string 3",
    "Middle": "sample string 4",
    "ProgramId": 1,
    "AccountId": 1,
    "DonorId1": "sample string 5",
    "Birthdate": "2024-11-14T15:13:42.2925955+00:00",
    "Gender": "sample string 6",
    "Ethnicity": "sample string 7",
    "Status": true,
    "ProgramsGroupId": 1,
    "ProgramsPanelsGroupsId": 1,
    "ManagerId1": 1,
    "ManagerId2": 1,
    "Picture": "sample string 9",
    "AvailableFrequencyGroups": [
      {
        "Id": 1,
        "Name": "sample string 1",
        "IsDefault": true
      },
      {
        "Id": 1,
        "Name": "sample string 1",
        "IsDefault": true
      }
    ],
    "AvailableGenders": [
      "sample string 1",
      "sample string 2"
    ],
    "AvailableEthnicities": [
      "sample string 1",
      "sample string 2"
    ],
    "AvailablePanelGroups": [
      {
        "Id": 1,
        "Name": "sample string 1"
      },
      {
        "Id": 1,
        "Name": "sample string 1"
      }
    ],
    "AvailableCaseManagers": [
      {
        "Id": 1,
        "Name": "sample string 1"
      },
      {
        "Id": 1,
        "Name": "sample string 1"
      }
    ],
    "DonorInfo_Active": true,
    "DonorInfo_ContactAndOther_Edit": true,
    "DonorInfo_ContactAndOther_View": true,
    "DonorInfo_PanelGroupEdit": true,
    "DonorInfo_NameAndOther_Edit": true,
    "IsLocked_CaseManager1": true,
    "IsRequired_CaseManager1": true,
    "CanCreateNewOrder": true,
    "PatientId2": "sample string 16",
    "PatientId3": "sample string 17",
    "PatientId2InstructionalText": "sample string 18",
    "PatientId3InstructionalText": "sample string 19",
    "RequiredId2": true,
    "RequiredId3": true
  }
}

application/xml, text/xml

Sample:

<UpdateDonorInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avertest.Aversys.DataLayer.Patients">
  <IsSuccess>true</IsSuccess>
  <Patient>
    <AccountId>1</AccountId>
    <AvailableCaseManagers>
      <CaseManager>
        <Id>1</Id>
        <Name>sample string 1</Name>
      </CaseManager>
      <CaseManager>
        <Id>1</Id>
        <Name>sample string 1</Name>
      </CaseManager>
    </AvailableCaseManagers>
    <AvailableEthnicities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AvailableEthnicities>
    <AvailableFrequencyGroups>
      <FrequencyGroup>
        <Id>1</Id>
        <Name>sample string 1</Name>
      </FrequencyGroup>
      <FrequencyGroup>
        <Id>1</Id>
        <Name>sample string 1</Name>
      </FrequencyGroup>
    </AvailableFrequencyGroups>
    <AvailableGenders xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </AvailableGenders>
    <AvailablePanelGroups>
      <PanelGroup>
        <Id>1</Id>
        <Name>sample string 1</Name>
      </PanelGroup>
      <PanelGroup>
        <Id>1</Id>
        <Name>sample string 1</Name>
      </PanelGroup>
    </AvailablePanelGroups>
    <Birthdate>2024-11-14T15:13:42.2925955+00:00</Birthdate>
    <CanCreateNewOrder>true</CanCreateNewOrder>
    <DonorId1>sample string 5</DonorId1>
    <DonorInfo_Active>true</DonorInfo_Active>
    <DonorInfo_ContactAndOther_Edit>true</DonorInfo_ContactAndOther_Edit>
    <DonorInfo_ContactAndOther_View>true</DonorInfo_ContactAndOther_View>
    <DonorInfo_NameAndOther_Edit>true</DonorInfo_NameAndOther_Edit>
    <DonorInfo_PanelGroupEdit>true</DonorInfo_PanelGroupEdit>
    <Ethnicity>sample string 7</Ethnicity>
    <First>sample string 2</First>
    <Gender>sample string 6</Gender>
    <Id>1</Id>
    <IsLocked_CaseManager1>true</IsLocked_CaseManager1>
    <IsRequired_CaseManager1>true</IsRequired_CaseManager1>
    <Last>sample string 3</Last>
    <ManagerId1>1</ManagerId1>
    <ManagerId2>1</ManagerId2>
    <Middle>sample string 4</Middle>
    <PatientId2>sample string 16</PatientId2>
    <PatientId2InstructionalText>sample string 18</PatientId2InstructionalText>
    <PatientId3>sample string 17</PatientId3>
    <PatientId3InstructionalText>sample string 19</PatientId3InstructionalText>
    <Picture>sample string 9</Picture>
    <ProgramId>1</ProgramId>
    <ProgramsGroupId>1</ProgramsGroupId>
    <ProgramsPanelsGroupsId>1</ProgramsPanelsGroupsId>
    <Status>true</Status>
  </Patient>
</UpdateDonorInfo>

Aversys Mobile API Help Page

POST Patient/Update

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml