POST api/v{version}/laboratory/{laboratoryId}/member

Request Information

URI Parameters

Name	Description	Type	Additional information
laboratoryId		integer	Required
version		string	None.

Body Parameters

LaboratoryMemberEnrollmentModel

Name	Type	Additional information
GlobalUniqueID	globally unique identifier	Required
NameTitle	string	String length: inclusive between 0 and 15
FirstName	string	Required String length: inclusive between 1 and 15
MiddleName	string	String length: inclusive between 0 and 15
LastName	string	Required String length: inclusive between 1 and 20
NameSuffix	string	String length: inclusive between 0 and 15
CallBy	string	String length: inclusive between 0 and 35
WorkAddressLine1	string	String length: inclusive between 0 and 35
WorkAddressLine2	string	String length: inclusive between 0 and 35
WorkAddressCity	string	String length: inclusive between 0 and 25
WorkAddressState	string	String length: inclusive between 0 and 2
WorkAddressPostalCode	string	String length: inclusive between 0 and 10
WorkPhone	string	String length: inclusive between 0 and 25
CellPhone	string	String length: inclusive between 0 and 25
EmailAddress	string	String length: inclusive between 0 and 50
AlertLowMethodID	integer	None.
AlertMediumMethodID	integer	None.
AlertHighMethodID	integer	None.
AlertEmergencyMethodID	integer	None.
MessageReceivedNotificationLevelID	integer	None.
WorkPhoneVisibleToSubjects	boolean	None.
CellPhoneVisibleToSubjects	boolean	None.
EmailVisibleToSubjects	boolean	None.
FacetimeWithSubjects	boolean	None.
AcceptsMessages	boolean	None.
TimeZone	string	Required String length: inclusive between 1 and 50
NationalLanguageID	integer	None.
Gender	string	None.
DateOfBirth	string	String length: inclusive between 0 and 10
CareTeamID	integer	None.
CareTeamRoleID	integer	None.
CareTeamShiftID	integer	None.
UserID	string	Required
Role	integer	None.
DefaultMenuID	integer	None.
DefaultDashboardID	integer	None.
SearchSubjectID	integer	None.
HidePHI	boolean	None.
UserClassID	integer	None.
StartAppID	integer	None.
AncillaryStaff	boolean	None.
EmrUserName	string	None.
RestrictSearch	boolean	None.
RegionID	integer	None.
LocationID	integer	None.
PoolID	integer	None.
TeamID	integer	None.
OtherID	integer	None.
LaboratoryRoleClassID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "globalUniqueID": "b35a7b08-571e-43df-960e-30942a8a55e2",
  "nameTitle": "sample string 1",
  "firstName": "sample string 2",
  "middleName": "sample string 3",
  "lastName": "sample string 4",
  "nameSuffix": "sample string 5",
  "callBy": "sample string 6",
  "workAddressLine1": "sample string 7",
  "workAddressLine2": "sample string 8",
  "workAddressCity": "sample string 9",
  "workAddressState": "sample string 10",
  "workAddressPostalCode": "sample string 11",
  "workPhone": "sample string 12",
  "cellPhone": "sample string 13",
  "emailAddress": "sample string 14",
  "alertLowMethodID": 15,
  "alertMediumMethodID": 16,
  "alertHighMethodID": 17,
  "alertEmergencyMethodID": 18,
  "messageReceivedNotificationLevelID": 19,
  "workPhoneVisibleToSubjects": true,
  "cellPhoneVisibleToSubjects": true,
  "emailVisibleToSubjects": true,
  "facetimeWithSubjects": true,
  "acceptsMessages": true,
  "timeZone": "sample string 25",
  "nationalLanguageID": 1,
  "gender": "sample string 26",
  "dateOfBirth": "sample string 27",
  "careTeamID": 1,
  "careTeamRoleID": 1,
  "careTeamShiftID": 1,
  "userID": "sample string 28",
  "role": 1,
  "defaultMenuID": 29,
  "defaultDashboardID": 30,
  "searchSubjectID": 31,
  "hidePHI": true,
  "userClassID": 33,
  "startAppID": 34,
  "ancillaryStaff": true,
  "emrUserName": "sample string 36",
  "restrictSearch": true,
  "regionID": 38,
  "locationID": 39,
  "poolID": 40,
  "teamID": 41,
  "otherID": 42,
  "laboratoryRoleClassID": 1
}

application/xml, text/xml

Sample:

<LaboratoryMemberEnrollmentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models">
  <AncillaryStaff>true</AncillaryStaff>
  <DefaultDashboardID>30</DefaultDashboardID>
  <DefaultMenuID>29</DefaultMenuID>
  <EmrUserName>sample string 36</EmrUserName>
  <HidePHI>true</HidePHI>
  <LaboratoryRoleClassID>1</LaboratoryRoleClassID>
  <LocationID>39</LocationID>
  <OtherID>42</OtherID>
  <PoolID>40</PoolID>
  <RegionID>38</RegionID>
  <RestrictSearch>true</RestrictSearch>
  <Role>1</Role>
  <SearchSubjectID>31</SearchSubjectID>
  <StartAppID>34</StartAppID>
  <TeamID>41</TeamID>
  <UserClassID>33</UserClassID>
  <UserID>sample string 28</UserID>
  <AcceptsMessages>true</AcceptsMessages>
  <AlertEmergencyMethodID>18</AlertEmergencyMethodID>
  <AlertHighMethodID>17</AlertHighMethodID>
  <AlertLowMethodID>15</AlertLowMethodID>
  <AlertMediumMethodID>16</AlertMediumMethodID>
  <CallBy>sample string 6</CallBy>
  <CareTeamID>1</CareTeamID>
  <CareTeamRoleID>1</CareTeamRoleID>
  <CareTeamShiftID>1</CareTeamShiftID>
  <CellPhone>sample string 13</CellPhone>
  <CellPhoneVisibleToSubjects>true</CellPhoneVisibleToSubjects>
  <DateOfBirth>sample string 27</DateOfBirth>
  <EmailAddress>sample string 14</EmailAddress>
  <EmailVisibleToSubjects>true</EmailVisibleToSubjects>
  <FacetimeWithSubjects>true</FacetimeWithSubjects>
  <FirstName>sample string 2</FirstName>
  <Gender>sample string 26</Gender>
  <GlobalUniqueID>b35a7b08-571e-43df-960e-30942a8a55e2</GlobalUniqueID>
  <LastName>sample string 4</LastName>
  <MessageReceivedNotificationLevelID>19</MessageReceivedNotificationLevelID>
  <MiddleName>sample string 3</MiddleName>
  <NameSuffix>sample string 5</NameSuffix>
  <NameTitle>sample string 1</NameTitle>
  <NationalLanguageID>1</NationalLanguageID>
  <TimeZone>sample string 25</TimeZone>
  <WorkAddressCity>sample string 9</WorkAddressCity>
  <WorkAddressLine1>sample string 7</WorkAddressLine1>
  <WorkAddressLine2>sample string 8</WorkAddressLine2>
  <WorkAddressPostalCode>sample string 11</WorkAddressPostalCode>
  <WorkAddressState>sample string 10</WorkAddressState>
  <WorkPhone>sample string 12</WorkPhone>
  <WorkPhoneVisibleToSubjects>true</WorkPhoneVisibleToSubjects>
</LaboratoryMemberEnrollmentModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfLaboratoryMemberListItem

Name	Description	Type	Additional information
Data		LaboratoryMemberListItem	None.
StatusCode	Gets or sets the status code.	HttpStatusCode	None.
StatusDescription	Gets or sets the status description.	string	None.
Errors		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "data": {
    "laboratoryID": 1,
    "userProfileID": 2,
    "role": 3,
    "active": true,
    "callBy": "sample string 5",
    "firstName": "sample string 6",
    "lastName": "sample string 7",
    "lastCommaFirst": "sample string 7, sample string 6",
    "laboratoryName": "sample string 8",
    "userStatus": "sample string 9",
    "defaultMenuID": 10,
    "defaultDashboardID": 11,
    "hidePatientIdentifiableInformation": true,
    "totalActiveSubjects": 13,
    "totalActiveMembers": 14,
    "startAppID": 15,
    "isAdmin": true,
    "calendarColor": "sample string 17",
    "emrUserName": "sample string 18",
    "ancillaryStaffMember": true,
    "userClassID": 20,
    "userClassName": "sample string 21",
    "systemRoleName": "sample string 22",
    "privilege": 23.0,
    "schedulerEmployeeID": 24,
    "userID": "sample string 25",
    "systemRoleNameParenPrivilege": "sample string 26",
    "globalUniqueID": "sample string 27",
    "dealer": true,
    "supportStaff": true,
    "testAccount": true,
    "acceptsMessages": true,
    "epidemicExpert": true,
    "experticeArea": "sample string 33",
    "regionDescription": "sample string 34",
    "locationDescription": "sample string 35",
    "cellPhone": "sample string 36",
    "workPhone": "sample string 37",
    "laboratoryRoleClassID": 1,
    "practiceID": 38,
    "practiceName": "sample string 39",
    "jobTitle": "sample string 40",
    "lastAccess": "2024-10-30T09:08:10.551623-07:00",
    "timeZoneSensitiveLastAccess": "2024-10-30T09:08:10.551623-07:00",
    "clinicalRoleID": 41,
    "clinicalRoleName": "sample string 42",
    "clinicalPrivilege": 43.0,
    "clinicalRoleNameAndPrivilege": "sample string 44"
  },
  "statusCode": 100,
  "statusDescription": "sample string 1",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ResponseOfLaboratoryMemberListItemuFpbgzW1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <StatusCode>Continue</StatusCode>
  <StatusDescription>sample string 1</StatusDescription>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/DomainObjects">
    <d2p1:AcceptsMessages>true</d2p1:AcceptsMessages>
    <d2p1:Active>true</d2p1:Active>
    <d2p1:AncillaryStaffMember>true</d2p1:AncillaryStaffMember>
    <d2p1:CalendarColor>sample string 17</d2p1:CalendarColor>
    <d2p1:CallBy>sample string 5</d2p1:CallBy>
    <d2p1:CellPhone>sample string 36</d2p1:CellPhone>
    <d2p1:ClinicalPrivilege>43</d2p1:ClinicalPrivilege>
    <d2p1:ClinicalRoleID>41</d2p1:ClinicalRoleID>
    <d2p1:ClinicalRoleName>sample string 42</d2p1:ClinicalRoleName>
    <d2p1:ClinicalRoleNameAndPrivilege>sample string 44</d2p1:ClinicalRoleNameAndPrivilege>
    <d2p1:Dealer>true</d2p1:Dealer>
    <d2p1:DefaultDashboardID>11</d2p1:DefaultDashboardID>
    <d2p1:DefaultMenuID>10</d2p1:DefaultMenuID>
    <d2p1:EMRUserName>sample string 18</d2p1:EMRUserName>
    <d2p1:EpidemicExpert>true</d2p1:EpidemicExpert>
    <d2p1:ExperticeArea>sample string 33</d2p1:ExperticeArea>
    <d2p1:FirstName>sample string 6</d2p1:FirstName>
    <d2p1:GlobalUniqueID>sample string 27</d2p1:GlobalUniqueID>
    <d2p1:HidePatientIdentifiableInformation>true</d2p1:HidePatientIdentifiableInformation>
    <d2p1:IsAdmin>true</d2p1:IsAdmin>
    <d2p1:JobTitle>sample string 40</d2p1:JobTitle>
    <d2p1:LaboratoryID>1</d2p1:LaboratoryID>
    <d2p1:LaboratoryName>sample string 8</d2p1:LaboratoryName>
    <d2p1:LaboratoryRoleClassID>1</d2p1:LaboratoryRoleClassID>
    <d2p1:LastAccess>2024-10-30T09:08:10.551623-07:00</d2p1:LastAccess>
    <d2p1:LastName>sample string 7</d2p1:LastName>
    <d2p1:LocationDescription>sample string 35</d2p1:LocationDescription>
    <d2p1:PracticeID>38</d2p1:PracticeID>
    <d2p1:PracticeName>sample string 39</d2p1:PracticeName>
    <d2p1:Privilege>23</d2p1:Privilege>
    <d2p1:RegionDescription>sample string 34</d2p1:RegionDescription>
    <d2p1:Role>3</d2p1:Role>
    <d2p1:SchedulerEmployeeID>24</d2p1:SchedulerEmployeeID>
    <d2p1:StartAppID>15</d2p1:StartAppID>
    <d2p1:SupportStaff>true</d2p1:SupportStaff>
    <d2p1:SystemRoleName>sample string 22</d2p1:SystemRoleName>
    <d2p1:SystemRoleNameParenPrivilege>sample string 26</d2p1:SystemRoleNameParenPrivilege>
    <d2p1:TestAccount>true</d2p1:TestAccount>
    <d2p1:TimeZoneSensitiveLastAccess>2024-10-30T09:08:10.551623-07:00</d2p1:TimeZoneSensitiveLastAccess>
    <d2p1:TotalActiveMembers>14</d2p1:TotalActiveMembers>
    <d2p1:TotalActiveSubjects>13</d2p1:TotalActiveSubjects>
    <d2p1:UserClassID>20</d2p1:UserClassID>
    <d2p1:UserClassName>sample string 21</d2p1:UserClassName>
    <d2p1:UserID>sample string 25</d2p1:UserID>
    <d2p1:UserProfileID>2</d2p1:UserProfileID>
    <d2p1:UserStatus>sample string 9</d2p1:UserStatus>
    <d2p1:WorkPhone>sample string 37</d2p1:WorkPhone>
  </Data>
</ResponseOfLaboratoryMemberListItemuFpbgzW1>