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

Insert or Update a subject record

Request Information

URI Parameters

NameDescriptionTypeAdditional information
laboratoryId

The laboratory identifier.

integer

Required

version

string

None.

Body Parameters

The model.

SubjectUpdateModel
NameDescriptionTypeAdditional information
Title

Gets or sets the title.

string

String length: inclusive between 0 and 15

FirstName

Gets or sets the first name.

string

Required

String length: inclusive between 0 and 15

MiddleName

Gets or sets the name of the middle.

string

String length: inclusive between 0 and 15

LastName

Gets or sets the last name.

string

Required

String length: inclusive between 0 and 20

Suffix

Gets or sets the suffix.

string

String length: inclusive between 0 and 15

EmailAddress

Gets or sets the email address.

string

String length: inclusive between 0 and 50

AltEmailAddress

Gets or sets the alternate email address.

string

String length: inclusive between 0 and 50

MedicalRecordNumber

Gets or sets the medical record number.

string

Required

String length: inclusive between 0 and 15

FacilitySubjectID

Gets or sets the facility subject identifier.

string

String length: inclusive between 0 and 35

MasterMrn

Gets or sets the master MRN.

string

String length: inclusive between 0 and 15

ValidationCode

Gets or sets the validation code.

string

String length: inclusive between 0 and 128

HomeAddressLine1

Gets or sets the home address line1.

string

Required

String length: inclusive between 0 and 35

HomeAddressLine2

Gets or sets the home address line2.

string

String length: inclusive between 0 and 35

HomeCity

Gets or sets the home city.

string

Required

String length: inclusive between 0 and 25

HomeState

Gets or sets the state of the home.

string

Required

String length: inclusive between 0 and 2

HomePostalCode

Gets or sets the home postal code.

string

Required

String length: inclusive between 0 and 10

HomePhone

Gets or sets the home phone.

string

String length: inclusive between 0 and 25

CellPhone

Gets or sets the cell phone.

string

String length: inclusive between 0 and 25

WorkPhone

Gets or sets the work phone.

string

String length: inclusive between 0 and 25

PreferredPhone

Gets or sets the preferred phone.

string

String length: inclusive between 0 and 25

DateOfBirth

Gets or sets the date of birth.

date

Required

TimeOfDeath

Gets or sets the time of death.

date

None.

Gender

Gets or sets the gender.

string

String length: inclusive between 0 and 7

FurtherLocationInfo

Gets or sets the further location information.

string

String length: inclusive between 0 and 50

Category

Gets or sets the category.

string

String length: inclusive between 0 and 256

SubCategory

Gets or sets the sub category.

string

String length: inclusive between 0 and 256

SSN

Gets or sets the SSN.

string

String length: inclusive between 0 and 15

Relationship

Gets or sets the relationship.

string

String length: inclusive between 0 and 50

EnrollmentDate

Gets or sets the enrollment date.

date

Required

Request Formats

application/json, text/json

Sample:
{
  "title": "sample string 1",
  "firstName": "sample string 2",
  "middleName": "sample string 3",
  "lastName": "sample string 4",
  "suffix": "sample string 5",
  "emailAddress": "sample string 6",
  "altEmailAddress": "sample string 7",
  "medicalRecordNumber": "sample string 8",
  "facilitySubjectID": "sample string 9",
  "masterMrn": "sample string 10",
  "validationCode": "sample string 11",
  "homeAddressLine1": "sample string 12",
  "homeAddressLine2": "sample string 13",
  "homeCity": "sample string 14",
  "homeState": "sample string 15",
  "homePostalCode": "sample string 16",
  "homePhone": "sample string 17",
  "cellPhone": "sample string 18",
  "workPhone": "sample string 19",
  "preferredPhone": "sample string 20",
  "dateOfBirth": "2024-10-22T09:28:56.4660501-07:00",
  "timeOfDeath": "2024-10-22T09:28:56.4660501-07:00",
  "gender": "sample string 22",
  "furtherLocationInfo": "sample string 23",
  "category": "sample string 24",
  "subCategory": "sample string 25",
  "ssn": "sample string 26",
  "relationship": "sample string 27",
  "enrollmentDate": "2024-10-22T09:28:56.4660501-07:00"
}

application/xml, text/xml

Sample:
<SubjectUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models">
  <AltEmailAddress>sample string 7</AltEmailAddress>
  <Category>sample string 24</Category>
  <CellPhone>sample string 18</CellPhone>
  <DateOfBirth>2024-10-22T09:28:56.4660501-07:00</DateOfBirth>
  <EmailAddress>sample string 6</EmailAddress>
  <EnrollmentDate>2024-10-22T09:28:56.4660501-07:00</EnrollmentDate>
  <FacilitySubjectID>sample string 9</FacilitySubjectID>
  <FirstName>sample string 2</FirstName>
  <FurtherLocationInfo>sample string 23</FurtherLocationInfo>
  <Gender>sample string 22</Gender>
  <HomeAddressLine1>sample string 12</HomeAddressLine1>
  <HomeAddressLine2>sample string 13</HomeAddressLine2>
  <HomeCity>sample string 14</HomeCity>
  <HomePhone>sample string 17</HomePhone>
  <HomePostalCode>sample string 16</HomePostalCode>
  <HomeState>sample string 15</HomeState>
  <LastName>sample string 4</LastName>
  <MasterMrn>sample string 10</MasterMrn>
  <MedicalRecordNumber>sample string 8</MedicalRecordNumber>
  <MiddleName>sample string 3</MiddleName>
  <PreferredPhone>sample string 20</PreferredPhone>
  <Relationship>sample string 27</Relationship>
  <SSN>sample string 26</SSN>
  <SubCategory>sample string 25</SubCategory>
  <Suffix>sample string 5</Suffix>
  <TimeOfDeath>2024-10-22T09:28:56.4660501-07:00</TimeOfDeath>
  <Title>sample string 1</Title>
  <ValidationCode>sample string 11</ValidationCode>
  <WorkPhone>sample string 19</WorkPhone>
</SubjectUpdateModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfSubjectModel
NameDescriptionTypeAdditional information
Data

SubjectModel

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": {
    "userProfileID": 1,
    "masterMrn": "sample string 2",
    "iacuc": "sample string 3",
    "mortalityDescription": "sample string 4",
    "speciesName": "sample string 5",
    "laboratoryID": 6,
    "supportMode": 7,
    "useNagger": true,
    "firstName": "sample string 9",
    "lastName": "sample string 10",
    "active": true,
    "pictureID": 12,
    "score": 13,
    "demoSubject": true,
    "furtherLocationInfo": "sample string 15",
    "category": "sample string 16",
    "subCategory": "sample string 17",
    "diastolic": 1.0,
    "systolic": 1.0,
    "heartRate": 1.0,
    "pulseOx": 1.0,
    "temperature": 1.0,
    "scoreColor": "sample string 18",
    "riskCategory1": "sample string 19",
    "riskCategory2": "sample string 20",
    "riskCategory3": "sample string 21",
    "riskCategory4": "sample string 22",
    "riskCategory5": "sample string 23",
    "canSeeOnlyUserCalendar": true,
    "subjectRegionID": 25,
    "subjectLocationID": 26,
    "subjectPoolID": 27,
    "subjectOtherID": 28,
    "subjectTeamID": 29,
    "subjectRegionDescription": "sample string 30",
    "subjectLocationDescription": "sample string 31",
    "subjectPoolDescription": "sample string 32",
    "subjectOtherDescription": "sample string 33",
    "subjectTeamDescription": "sample string 34",
    "schedulerClientID": 35,
    "contactStatusID": 36,
    "contactStatusChangeDate": "2024-10-22T09:28:56.5129246-07:00",
    "suspended": true,
    "homeAddressLine1": "sample string 38",
    "homeAddressLine2": "sample string 39",
    "homeCity": "sample string 40",
    "homeState": "sample string 41",
    "homePostalCode": "sample string 42",
    "homePhone": "sample string 43",
    "command": "sample string 44",
    "subjectID": 45,
    "callBy": "sample string 46",
    "medicalRecordNumber": "sample string 47",
    "facilitySubjectID": "sample string 48",
    "dateOfBirth": "2024-10-22T09:28:56.5129246-07:00",
    "gender": "sample string 49",
    "laboratoryName": "sample string 50"
  },
  "statusCode": 100,
  "statusDescription": "sample string 1",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ResponseOfSubjectModeluskxzdf5 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:CallBy>sample string 46</d2p1:CallBy>
    <d2p1:DateOfBirth>2024-10-22T09:28:56.5129246-07:00</d2p1:DateOfBirth>
    <d2p1:FacilitySubjectID>sample string 48</d2p1:FacilitySubjectID>
    <d2p1:Gender>sample string 49</d2p1:Gender>
    <d2p1:LaboratoryName>sample string 50</d2p1:LaboratoryName>
    <d2p1:MedicalRecordNumber>sample string 47</d2p1:MedicalRecordNumber>
    <d2p1:SubjectID>45</d2p1:SubjectID>
    <d2p1:Active>true</d2p1:Active>
    <d2p1:CanSeeOnlyUserCalendar>true</d2p1:CanSeeOnlyUserCalendar>
    <d2p1:Category>sample string 16</d2p1:Category>
    <d2p1:Command>sample string 44</d2p1:Command>
    <d2p1:ContactStatusChangeDate>2024-10-22T09:28:56.5129246-07:00</d2p1:ContactStatusChangeDate>
    <d2p1:ContactStatusID>36</d2p1:ContactStatusID>
    <d2p1:DemoSubject>true</d2p1:DemoSubject>
    <d2p1:Diastolic>1</d2p1:Diastolic>
    <d2p1:FirstName>sample string 9</d2p1:FirstName>
    <d2p1:FurtherLocationInfo>sample string 15</d2p1:FurtherLocationInfo>
    <d2p1:HeartRate>1</d2p1:HeartRate>
    <d2p1:HomeAddressLine1>sample string 38</d2p1:HomeAddressLine1>
    <d2p1:HomeAddressLine2>sample string 39</d2p1:HomeAddressLine2>
    <d2p1:HomeCity>sample string 40</d2p1:HomeCity>
    <d2p1:HomePhone>sample string 43</d2p1:HomePhone>
    <d2p1:HomePostalCode>sample string 42</d2p1:HomePostalCode>
    <d2p1:HomeState>sample string 41</d2p1:HomeState>
    <d2p1:IACUC>sample string 3</d2p1:IACUC>
    <d2p1:LaboratoryID>6</d2p1:LaboratoryID>
    <d2p1:LastName>sample string 10</d2p1:LastName>
    <d2p1:MasterMrn>sample string 2</d2p1:MasterMrn>
    <d2p1:MortalityDescription>sample string 4</d2p1:MortalityDescription>
    <d2p1:PictureID>12</d2p1:PictureID>
    <d2p1:PulseOx>1</d2p1:PulseOx>
    <d2p1:RiskCategory1>sample string 19</d2p1:RiskCategory1>
    <d2p1:RiskCategory2>sample string 20</d2p1:RiskCategory2>
    <d2p1:RiskCategory3>sample string 21</d2p1:RiskCategory3>
    <d2p1:RiskCategory4>sample string 22</d2p1:RiskCategory4>
    <d2p1:RiskCategory5>sample string 23</d2p1:RiskCategory5>
    <d2p1:SchedulerClientID>35</d2p1:SchedulerClientID>
    <d2p1:Score>13</d2p1:Score>
    <d2p1:ScoreColor>sample string 18</d2p1:ScoreColor>
    <d2p1:SpeciesName>sample string 5</d2p1:SpeciesName>
    <d2p1:SubCategory>sample string 17</d2p1:SubCategory>
    <d2p1:SubjectLocationDescription>sample string 31</d2p1:SubjectLocationDescription>
    <d2p1:SubjectLocationID>26</d2p1:SubjectLocationID>
    <d2p1:SubjectOtherDescription>sample string 33</d2p1:SubjectOtherDescription>
    <d2p1:SubjectOtherID>28</d2p1:SubjectOtherID>
    <d2p1:SubjectPoolDescription>sample string 32</d2p1:SubjectPoolDescription>
    <d2p1:SubjectPoolID>27</d2p1:SubjectPoolID>
    <d2p1:SubjectRegionDescription>sample string 30</d2p1:SubjectRegionDescription>
    <d2p1:SubjectRegionID>25</d2p1:SubjectRegionID>
    <d2p1:SubjectTeamDescription>sample string 34</d2p1:SubjectTeamDescription>
    <d2p1:SubjectTeamID>29</d2p1:SubjectTeamID>
    <d2p1:SupportMode>7</d2p1:SupportMode>
    <d2p1:Suspended>true</d2p1:Suspended>
    <d2p1:Systolic>1</d2p1:Systolic>
    <d2p1:Temperature>1</d2p1:Temperature>
    <d2p1:UseNagger>true</d2p1:UseNagger>
    <d2p1:UserProfileID>1</d2p1:UserProfileID>
  </Data>
</ResponseOfSubjectModeluskxzdf5>