GET api/Instructors/{InstructorId}
Returns an Instructor.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
InstructorId |
Application identifier for the Instructor |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Instructor object for the specified InstructorId
InstructorName | Description | Type | Additional information |
---|---|---|---|
InstructorUid |
The user identifier for the Instructor. |
string |
None. |
Active |
The active indicator for the Instructor. |
boolean |
None. |
SIFRefId |
The SIFRefId for the Instructor. |
globally unique identifier |
None. |
InstructorPerson |
The Person for the Instructor. |
Person |
None. |
DefaultAddress |
The default address for the Instructor. |
Address |
None. |
AddressList |
The addresses for the Instructor. This list includes the default address for the Instructor. |
Collection of Address |
None. |
DefaultPhone |
The default phone for the Instructor. |
Phone |
None. |
PhoneList |
The phones for the Instructor. This list includes the default phone for the Instructor. |
Collection of Phone |
None. |
DefaultEmail |
The default email for the Instructor. |
None. |
|
EmailList |
The emails for the Instructor. This list includes the default email for the Instructor. |
Collection of Email |
None. |
Id |
The application identifier for the object. This cannot be changed by the user. |
globally unique identifier |
None. |
DataVersion |
The version of the API data |
string |
None. |
ApiName |
The name of the object without the Api suffix |
string |
None. |
Response Formats
application/json, text/json
{ "InstructorUid": "sample string 1", "Active": true, "SIFRefId": "6ccec007-9c4d-4473-9ba6-ab5b7f9ac069", "InstructorPerson": { "Title": "sample string 1", "FirstName": "sample string 2", "MiddleName": "sample string 3", "LastName": "sample string 4", "Suffix": "sample string 5", "AlternateFirstName": "sample string 6", "AlternateLastName": "sample string 7", "SSN": "sample string 8", "Gender": "sample string 9", "BirthDate": "2025-04-25T23:23:14.8334238-05:00", "HispanicLatino": true, "AmericanIndian": true, "White": true, "Asian": true, "PacificIslander": true, "Black": true, "UnknownRace": true, "EmployerName": "sample string 18", "LanguageCodeUid": "sample string 19", "LanguageCodeDescription": "sample string 20", "Id": "c8766aea-c4e8-43b0-bd7b-e8a209659dbc", "DataVersion": "sample string 22", "ApiName": "" }, "DefaultAddress": { "AddressType": "sample string 1", "AddressTypeDescription": "sample string 2", "Line1": "sample string 3", "Line2": "sample string 4", "Line3": "sample string 5", "Apartment": "sample string 6", "City": "sample string 7", "State": "sample string 8", "Country": "sample string 9", "PostalCode": "sample string 10", "Zip": "sample string 11", "ZipPlusFour": "sample string 12", "RoomNumber": "sample string 13", "Id": "72566ffc-48bb-49e5-97de-c390dfeffad8", "DataVersion": "sample string 15", "ApiName": "" }, "AddressList": [ { "AddressType": "sample string 1", "AddressTypeDescription": "sample string 2", "Line1": "sample string 3", "Line2": "sample string 4", "Line3": "sample string 5", "Apartment": "sample string 6", "City": "sample string 7", "State": "sample string 8", "Country": "sample string 9", "PostalCode": "sample string 10", "Zip": "sample string 11", "ZipPlusFour": "sample string 12", "RoomNumber": "sample string 13", "Id": "72566ffc-48bb-49e5-97de-c390dfeffad8", "DataVersion": "sample string 15", "ApiName": "" }, { "AddressType": "sample string 1", "AddressTypeDescription": "sample string 2", "Line1": "sample string 3", "Line2": "sample string 4", "Line3": "sample string 5", "Apartment": "sample string 6", "City": "sample string 7", "State": "sample string 8", "Country": "sample string 9", "PostalCode": "sample string 10", "Zip": "sample string 11", "ZipPlusFour": "sample string 12", "RoomNumber": "sample string 13", "Id": "72566ffc-48bb-49e5-97de-c390dfeffad8", "DataVersion": "sample string 15", "ApiName": "" } ], "DefaultPhone": { "MessageDeviceType": "sample string 1", "MessageDeviceTypeDescription": "sample string 2", "Number": "sample string 3", "Description": "sample string 4", "Id": "1379ea7f-b6e5-4da4-afd5-6924c0ad6c50", "DataVersion": "sample string 6", "ApiName": "" }, "PhoneList": [ { "MessageDeviceType": "sample string 1", "MessageDeviceTypeDescription": "sample string 2", "Number": "sample string 3", "Description": "sample string 4", "Id": "1379ea7f-b6e5-4da4-afd5-6924c0ad6c50", "DataVersion": "sample string 6", "ApiName": "" }, { "MessageDeviceType": "sample string 1", "MessageDeviceTypeDescription": "sample string 2", "Number": "sample string 3", "Description": "sample string 4", "Id": "1379ea7f-b6e5-4da4-afd5-6924c0ad6c50", "DataVersion": "sample string 6", "ApiName": "" } ], "DefaultEmail": { "Address": "sample string 1", "Description": "sample string 2", "Id": "72b7678a-dba8-4b72-8755-a87ca05d90dd", "DataVersion": "sample string 4", "ApiName": "" }, "EmailList": [ { "Address": "sample string 1", "Description": "sample string 2", "Id": "72b7678a-dba8-4b72-8755-a87ca05d90dd", "DataVersion": "sample string 4", "ApiName": "" }, { "Address": "sample string 1", "Description": "sample string 2", "Id": "72b7678a-dba8-4b72-8755-a87ca05d90dd", "DataVersion": "sample string 4", "ApiName": "" } ], "Id": "edb02f4a-955b-4b3b-97ae-85941b881265", "DataVersion": "sample string 5", "ApiName": "" }
application/xml, text/xml
<Instructor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1"> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 5</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">edb02f4a-955b-4b3b-97ae-85941b881265</Id> <Active>true</Active> <AddressList> <Address> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">72566ffc-48bb-49e5-97de-c390dfeffad8</Id> <AddressType>sample string 1</AddressType> <AddressTypeDescription>sample string 2</AddressTypeDescription> <Apartment>sample string 6</Apartment> <City>sample string 7</City> <Country>sample string 9</Country> <Line1>sample string 3</Line1> <Line2>sample string 4</Line2> <Line3>sample string 5</Line3> <PostalCode>sample string 10</PostalCode> <RoomNumber>sample string 13</RoomNumber> <State>sample string 8</State> <Zip>sample string 11</Zip> <ZipPlusFour>sample string 12</ZipPlusFour> </Address> <Address> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">72566ffc-48bb-49e5-97de-c390dfeffad8</Id> <AddressType>sample string 1</AddressType> <AddressTypeDescription>sample string 2</AddressTypeDescription> <Apartment>sample string 6</Apartment> <City>sample string 7</City> <Country>sample string 9</Country> <Line1>sample string 3</Line1> <Line2>sample string 4</Line2> <Line3>sample string 5</Line3> <PostalCode>sample string 10</PostalCode> <RoomNumber>sample string 13</RoomNumber> <State>sample string 8</State> <Zip>sample string 11</Zip> <ZipPlusFour>sample string 12</ZipPlusFour> </Address> </AddressList> <DefaultAddress> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">72566ffc-48bb-49e5-97de-c390dfeffad8</Id> <AddressType>sample string 1</AddressType> <AddressTypeDescription>sample string 2</AddressTypeDescription> <Apartment>sample string 6</Apartment> <City>sample string 7</City> <Country>sample string 9</Country> <Line1>sample string 3</Line1> <Line2>sample string 4</Line2> <Line3>sample string 5</Line3> <PostalCode>sample string 10</PostalCode> <RoomNumber>sample string 13</RoomNumber> <State>sample string 8</State> <Zip>sample string 11</Zip> <ZipPlusFour>sample string 12</ZipPlusFour> </DefaultAddress> <DefaultEmail> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">72b7678a-dba8-4b72-8755-a87ca05d90dd</Id> <Address>sample string 1</Address> <Description>sample string 2</Description> </DefaultEmail> <DefaultPhone> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">1379ea7f-b6e5-4da4-afd5-6924c0ad6c50</Id> <Description>sample string 4</Description> <MessageDeviceType>sample string 1</MessageDeviceType> <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription> <Number>sample string 3</Number> </DefaultPhone> <EmailList> <Email> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">72b7678a-dba8-4b72-8755-a87ca05d90dd</Id> <Address>sample string 1</Address> <Description>sample string 2</Description> </Email> <Email> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">72b7678a-dba8-4b72-8755-a87ca05d90dd</Id> <Address>sample string 1</Address> <Description>sample string 2</Description> </Email> </EmailList> <InstructorPerson> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 22</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">c8766aea-c4e8-43b0-bd7b-e8a209659dbc</Id> <AlternateFirstName>sample string 6</AlternateFirstName> <AlternateLastName>sample string 7</AlternateLastName> <AmericanIndian>true</AmericanIndian> <Asian>true</Asian> <BirthDate>2025-04-25T23:23:14.8334238-05:00</BirthDate> <Black>true</Black> <EmployerName>sample string 18</EmployerName> <FirstName>sample string 2</FirstName> <Gender>sample string 9</Gender> <HispanicLatino>true</HispanicLatino> <LanguageCodeDescription>sample string 20</LanguageCodeDescription> <LanguageCodeUid>sample string 19</LanguageCodeUid> <LastName>sample string 4</LastName> <MiddleName>sample string 3</MiddleName> <PacificIslander>true</PacificIslander> <SSN>sample string 8</SSN> <Suffix>sample string 5</Suffix> <Title>sample string 1</Title> <UnknownRace>true</UnknownRace> <White>true</White> </InstructorPerson> <InstructorUid>sample string 1</InstructorUid> <PhoneList> <Phone> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">1379ea7f-b6e5-4da4-afd5-6924c0ad6c50</Id> <Description>sample string 4</Description> <MessageDeviceType>sample string 1</MessageDeviceType> <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription> <Number>sample string 3</Number> </Phone> <Phone> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">1379ea7f-b6e5-4da4-afd5-6924c0ad6c50</Id> <Description>sample string 4</Description> <MessageDeviceType>sample string 1</MessageDeviceType> <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription> <Number>sample string 3</Number> </Phone> </PhoneList> <SIFRefId>6ccec007-9c4d-4473-9ba6-ab5b7f9ac069</SIFRefId> </Instructor>