POST api/v{version}/laboratory/{laboratoryId}/member/enroll-existing
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
laboratoryId | integer |
Required |
|
version | string |
None. |
Body Parameters
LaboratoryMemberEnrollmentBaseName | Description | Type | Additional information |
---|---|---|---|
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:
{ "userID": "sample string 1", "role": 1, "defaultMenuID": 2, "defaultDashboardID": 3, "searchSubjectID": 4, "hidePHI": true, "userClassID": 6, "startAppID": 7, "ancillaryStaff": true, "emrUserName": "sample string 9", "restrictSearch": true, "regionID": 11, "locationID": 12, "poolID": 13, "teamID": 14, "otherID": 15, "laboratoryRoleClassID": 1 }
application/xml, text/xml
Sample:
<LaboratoryMemberEnrollmentBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models"> <AncillaryStaff>true</AncillaryStaff> <DefaultDashboardID>3</DefaultDashboardID> <DefaultMenuID>2</DefaultMenuID> <EmrUserName>sample string 9</EmrUserName> <HidePHI>true</HidePHI> <LaboratoryRoleClassID>1</LaboratoryRoleClassID> <LocationID>12</LocationID> <OtherID>15</OtherID> <PoolID>13</PoolID> <RegionID>11</RegionID> <RestrictSearch>true</RestrictSearch> <Role>1</Role> <SearchSubjectID>4</SearchSubjectID> <StartAppID>7</StartAppID> <TeamID>14</TeamID> <UserClassID>6</UserClassID> <UserID>sample string 1</UserID> </LaboratoryMemberEnrollmentBase>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfBaseResponseName | Description | Type | Additional information |
---|---|---|---|
Data | BaseResponse |
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": { "statusCode": 100, "statusDescription": "sample string 1", "errors": [ "sample string 1", "sample string 2" ] }, "statusCode": 100, "statusDescription": "sample string 1", "errors": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<ResponseOfBaseResponsem8NcPL_PI 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> <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Errors> <StatusCode>Continue</StatusCode> <StatusDescription>sample string 1</StatusDescription> </Data> </ResponseOfBaseResponsem8NcPL_PI>