GET api/v{version}/laboratory?Active={Active}&CompanyName={CompanyName}&ManagerID={ManagerID}&Name={Name}&UserProfileID={UserProfileID}
Gets a list of Laboratories.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Active |
Gets or sets the active. |
boolean |
None. |
CompanyName |
Gets or sets the name of the company. |
string |
None. |
ManagerID |
Gets or sets the manager identifier. |
integer |
None. |
Name |
Gets or sets the name. |
string |
None. |
UserProfileID | integer |
None. |
|
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
ResponseOfIEnumerableOfLaboratoryModelName | Description | Type | Additional information |
---|---|---|---|
Data | Collection of LaboratoryModel |
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": [ { "active": true, "laboratoryID": 1, "name": "sample string 2", "companyName": "sample string 3", "focus": "sample string 4", "labManagerUserProfileID": 5, "membershipRequestsOptionID": 6, "addressLine1": "sample string 7", "addressLine2": "sample string 8", "city": "sample string 9", "state": "sample string 10", "postalCode": "sample string 11", "phoneNumber": "sample string 12", "allowOpenEnrollment": true, "foodMenuOptionID": 14, "subjectDashboardID": 15, "logoGraphicID": 16, "storeBackdropID": 17, "countryCode": 18, "schedulerAccountID": 19, "institutionID": 20, "customerName": "sample string 21" }, { "active": true, "laboratoryID": 1, "name": "sample string 2", "companyName": "sample string 3", "focus": "sample string 4", "labManagerUserProfileID": 5, "membershipRequestsOptionID": 6, "addressLine1": "sample string 7", "addressLine2": "sample string 8", "city": "sample string 9", "state": "sample string 10", "postalCode": "sample string 11", "phoneNumber": "sample string 12", "allowOpenEnrollment": true, "foodMenuOptionID": 14, "subjectDashboardID": 15, "logoGraphicID": 16, "storeBackdropID": 17, "countryCode": 18, "schedulerAccountID": 19, "institutionID": 20, "customerName": "sample string 21" } ], "statusCode": 100, "statusDescription": "sample string 1", "errors": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<ResponseOfArrayOfLaboratoryModeluskxzdf5 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/CancerBytesAPI.Models"> <d2p1:LaboratoryModel> <AddressLine1 xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 7</AddressLine1> <AddressLine2 xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 8</AddressLine2> <AllowOpenEnrollment xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">true</AllowOpenEnrollment> <City xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 9</City> <CompanyName xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 3</CompanyName> <CountryCode xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">18</CountryCode> <CustomerName xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 21</CustomerName> <Focus xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 4</Focus> <FoodMenuOptionID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">14</FoodMenuOptionID> <InstitutionID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">20</InstitutionID> <LabManagerUserProfileID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">5</LabManagerUserProfileID> <LaboratoryID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">1</LaboratoryID> <LogoGraphicID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">16</LogoGraphicID> <MembershipRequestsOptionID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">6</MembershipRequestsOptionID> <Name xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 2</Name> <PhoneNumber xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 12</PhoneNumber> <PostalCode xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 11</PostalCode> <SchedulerAccountID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">19</SchedulerAccountID> <State xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 10</State> <StoreBackdropID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">17</StoreBackdropID> <SubjectDashboardID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">15</SubjectDashboardID> <d2p1:Active>true</d2p1:Active> </d2p1:LaboratoryModel> <d2p1:LaboratoryModel> <AddressLine1 xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 7</AddressLine1> <AddressLine2 xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 8</AddressLine2> <AllowOpenEnrollment xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">true</AllowOpenEnrollment> <City xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 9</City> <CompanyName xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 3</CompanyName> <CountryCode xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">18</CountryCode> <CustomerName xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 21</CustomerName> <Focus xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 4</Focus> <FoodMenuOptionID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">14</FoodMenuOptionID> <InstitutionID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">20</InstitutionID> <LabManagerUserProfileID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">5</LabManagerUserProfileID> <LaboratoryID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">1</LaboratoryID> <LogoGraphicID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">16</LogoGraphicID> <MembershipRequestsOptionID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">6</MembershipRequestsOptionID> <Name xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 2</Name> <PhoneNumber xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 12</PhoneNumber> <PostalCode xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 11</PostalCode> <SchedulerAccountID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">19</SchedulerAccountID> <State xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">sample string 10</State> <StoreBackdropID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">17</StoreBackdropID> <SubjectDashboardID xmlns="http://schemas.datacontract.org/2004/07/DomainObjects">15</SubjectDashboardID> <d2p1:Active>true</d2p1:Active> </d2p1:LaboratoryModel> </Data> </ResponseOfArrayOfLaboratoryModeluskxzdf5>
text/csv
Sample:
1,20,sample string 2 1,20,sample string 2