AbodeONE

<back to all web services

GetDiscipline

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/disciplines/{Id}
GetDiscipline Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
GetDisciplineResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformDisciplineDTONo
ResponseStatusformResponseStatusNo
DisciplineDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TitleformstringNo
StudentIdformintNo
DescriptionformstringNo
DisciplineDateformDateTimeNo
TypesformIEnumerable<DisciplineTypeDTO>No
CommentsformstringNo
NotesformstringNo
Attachmentformbyte[]No
LetterIssuedformboolNo
ProbationformboolNo
ActionformstringNo
IssuingDeanformstringNo
ResolvedformboolNo
ProbationStartformDateTime?No
ProbationEndformDateTime?No
IncidentIdformint?No
Tracked Parameters:
NameParameterData TypeRequiredDescription
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo
DisciplineTypeDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DefaultChargeformint?No
NameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET //disciplines/{Id} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDisciplineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel.Disciplines">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">String</CreatedBy>
    <CreatedDt xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">0001-01-01T00:00:00</CreatedDt>
    <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">String</ModifiedBy>
    <ModifiedDt xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">0001-01-01T00:00:00</ModifiedDt>
    <Action>String</Action>
    <Attachment>AA==</Attachment>
    <Comments>String</Comments>
    <Description>String</Description>
    <DisciplineDate>0001-01-01T00:00:00</DisciplineDate>
    <Id>0</Id>
    <IncidentId>0</IncidentId>
    <IssuingDean>String</IssuingDean>
    <LetterIssued>false</LetterIssued>
    <Notes>String</Notes>
    <Probation>false</Probation>
    <ProbationEnd>0001-01-01T00:00:00</ProbationEnd>
    <ProbationStart>0001-01-01T00:00:00</ProbationStart>
    <Resolved>false</Resolved>
    <StudentId>0</StudentId>
    <Title>String</Title>
    <Types xmlns:d3p1="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel.DisciplineTypes" i:nil="true" />
  </Result>
</GetDisciplineResponse>