AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

GetUsersByID

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /AxWCC1474WS/AchademixWS.asmx HTTP/1.1
Host: wcccws.achademix.info
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.Achademix.com/GetUsersByID"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap:Header>
  <soap:Body>
    <GetUsersByID xmlns="http://www.Achademix.com/">
      <UsersID>int</UsersID>
    </GetUsersByID>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap:Header>
  <soap:Body>
    <GetUsersByIDResponse xmlns="http://www.Achademix.com/">
      <GetUsersByIDResult>
        <AuthenticationID>string</AuthenticationID>
        <FieldAccessLevel>int</FieldAccessLevel>
        <FieldEditLevel>int</FieldEditLevel>
        <Group>
          <GroupMembers>
            <Staff xsi:nil="true" />
            <Staff xsi:nil="true" />
          </GroupMembers>
          <GroupSecurity>
            <GroupSecurity xsi:nil="true" />
            <GroupSecurity xsi:nil="true" />
          </GroupSecurity>
          <GroupSessions>
            <GroupSession xsi:nil="true" />
            <GroupSession xsi:nil="true" />
          </GroupSessions>
          <MemberCount>int</MemberCount>
          <ClassNumberID>int</ClassNumberID>
          <ContractGroupID>int</ContractGroupID>
          <GroupsID>int</GroupsID>
          <FieldMaxAccessLevel>int</FieldMaxAccessLevel>
          <FieldMaxEditLevel>int</FieldMaxEditLevel>
          <RptAccessLevel>int</RptAccessLevel>
          <RptEditLevel>int</RptEditLevel>
          <Title>string</Title>
          <InvoiceNumberID>int</InvoiceNumberID>
          <PONumberID>int</PONumberID>
          <ReceiptNumberID>int</ReceiptNumberID>
        </Group>
        <IPAddress>string</IPAddress>
        <Person>
          <AddressList>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </AddressList>
          <ContactList>
            <Contact xsi:nil="true" />
            <Contact xsi:nil="true" />
          </ContactList>
          <PostaNotes>
            <PostaNote xsi:nil="true" />
            <PostaNote xsi:nil="true" />
          </PostaNotes>
          <Tags>
            <PersonTag xsi:nil="true" />
            <PersonTag xsi:nil="true" />
          </Tags>
          <AlertTag>string</AlertTag>
          <MaskedSSN>string</MaskedSSN>
          <AccountID>int</AccountID>
          <PerAge>int</PerAge>
          <AlertLevel>int</AlertLevel>
          <AutoTag>string</AutoTag>
          <PerCitizenStatusListID>int</PerCitizenStatusListID>
          <Code>string</Code>
          <CountryOfBirth>string</CountryOfBirth>
          <CountryOfCitzenship>string</CountryOfCitzenship>
          <Dependents>int</Dependents>
          <DOB>dateTime</DOB>
          <PerDOBVerifyListID>int</PerDOBVerifyListID>
          <DriverLicNum>string</DriverLicNum>
          <PerDwellingListID>int</PerDwellingListID>
          <PerEdLevelListID>int</PerEdLevelListID>
          <Employer>string</Employer>
          <PerEthnicityListID>int</PerEthnicityListID>
          <FirstName>string</FirstName>
          <Gender>string</Gender>
          <GenIdentity>string</GenIdentity>
          <HasBenefit>boolean</HasBenefit>
          <HasPopulation>boolean</HasPopulation>
          <PerGUID>string</PerGUID>
          <PerHomeLanguageID>int</PerHomeLanguageID>
          <ImportKey>int</ImportKey>
          <PerIncomeListID>int</PerIncomeListID>
          <Initals>string</Initals>
          <IsArchived>boolean</IsArchived>
          <IsDependent>boolean</IsDependent>
          <IsSenior>boolean</IsSenior>
          <IsEmployed>boolean</IsEmployed>
          <PerLanguageListID>int</PerLanguageListID>
          <LastName>string</LastName>
          <MaidenName>string</MaidenName>
          <PerMaritalListID>int</PerMaritalListID>
          <MidName>string</MidName>
          <ParkPermitNumber>string</ParkPermitNumber>
          <PlaceOfBirth>string</PlaceOfBirth>
          <Prefix>string</Prefix>
          <PrefName>string</PrefName>
          <PerRaceListID>int</PerRaceListID>
          <PersonID>int</PersonID>
          <SignatureID>int</SignatureID>
          <SSN>string</SSN>
          <PerSSNVerifyListID>int</PerSSNVerifyListID>
          <StateOfBirth>string</StateOfBirth>
          <Suffix>string</Suffix>
          <Title>string</Title>
          <UserData>string</UserData>
          <PictureID>int</PictureID>
          <SchoolID>int</SchoolID>
          <VendorCode>string</VendorCode>
        </Person>
        <ReportAccessLevel>int</ReportAccessLevel>
        <ReportEditLevel>int</ReportEditLevel>
        <Reset>boolean</Reset>
        <SocialNetwork>
          <Email>string</Email>
          <FaceBook>string</FaceBook>
          <LinkedIn>string</LinkedIn>
          <MobilePhone>string</MobilePhone>
          <MySpace>string</MySpace>
          <Skype>string</Skype>
          <StumbleUpon>string</StumbleUpon>
          <Twitter>string</Twitter>
        </SocialNetwork>
        <Staff>
          <CampusKeys>string</CampusKeys>
          <LastLogin>dateTime</LastLogin>
          <LoginName>string</LoginName>
          <PrimaryCampusID>int</PrimaryCampusID>
          <SecurityGroupID>int</SecurityGroupID>
          <SecurityGrpName>string</SecurityGrpName>
          <CertExpireDate>dateTime</CertExpireDate>
          <CertPID>string</CertPID>
          <Documents>
            <StaffNote xsi:nil="true" />
            <StaffNote xsi:nil="true" />
          </Documents>
          <StatusTitle>string</StatusTitle>
          <Summary>
            <Alerts xsi:nil="true" />
            <ClassResourceCount>int</ClassResourceCount>
            <CurrentActivity>string</CurrentActivity>
            <CurrentLocation>string</CurrentLocation>
            <Email>string</Email>
            <EmergencyContact>string</EmergencyContact>
            <PrimaryAddress>string</PrimaryAddress>
            <PrimaryPhone>string</PrimaryPhone>
            <StudentCounts>string</StudentCounts>
          </Summary>
          <TeaAuth>string</TeaAuth>
          <Teacher>
            <Staff xsi:nil="true" />
            <TypeTitle>string</TypeTitle>
            <StaffID>int</StaffID>
            <CertExpireDate>dateTime</CertExpireDate>
            <CertPID>string</CertPID>
            <TeaAuth>string</TeaAuth>
            <TeacherID>int</TeacherID>
            <ImportKey>int</ImportKey>
            <TeaCode>string</TeaCode>
            <TeaTypeListID>int</TeaTypeListID>
            <UserData>string</UserData>
          </Teacher>
          <TeaCode>string</TeaCode>
          <ContactRules>string</ContactRules>
          <EndDate>dateTime</EndDate>
          <IsAdministrator>boolean</IsAdministrator>
          <IsCoordinator>boolean</IsCoordinator>
          <Bio>string</Bio>
          <StaffID>int</StaffID>
          <IsAdvisor>boolean</IsAdvisor>
          <IsRecruit>boolean</IsRecruit>
          <IsSchoolContact>boolean</IsSchoolContact>
          <IsTeacher>boolean</IsTeacher>
          <StartDate>dateTime</StartDate>
          <StaStatusID>int</StaStatusID>
          <StatusChangeDate>dateTime</StatusChangeDate>
          <StaTypeListID>int</StaTypeListID>
        </Staff>
        <GroupsID>int</GroupsID>
        <L1AccessKey>base64Binary</L1AccessKey>
        <L2AccessKey>base64Binary</L2AccessKey>
        <PersonID>int</PersonID>
        <Login>string</Login>
        <PictureIDusr>int</PictureIDusr>
        <UsersID>int</UsersID>
        <AccessKey>base64Binary</AccessKey>
        <Answer>string</Answer>
        <Calendar>string</Calendar>
        <UsrEmail>string</UsrEmail>
        <KeyDate>dateTime</KeyDate>
        <LastLogin>dateTime</LastLogin>
        <MustChangePwd>boolean</MustChangePwd>
        <Question>string</Question>
        <Status>int</Status>
        <UsrTempPwd>string</UsrTempPwd>
        <UseAD>boolean</UseAD>
        <CalendarID>int</CalendarID>
      </GetUsersByIDResult>
    </GetUsersByIDResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /AxWCC1474WS/AchademixWS.asmx HTTP/1.1
Host: wcccws.achademix.info
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap12:Header>
  <soap12:Body>
    <GetUsersByID xmlns="http://www.Achademix.com/">
      <UsersID>int</UsersID>
    </GetUsersByID>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap12:Header>
  <soap12:Body>
    <GetUsersByIDResponse xmlns="http://www.Achademix.com/">
      <GetUsersByIDResult>
        <AuthenticationID>string</AuthenticationID>
        <FieldAccessLevel>int</FieldAccessLevel>
        <FieldEditLevel>int</FieldEditLevel>
        <Group>
          <GroupMembers>
            <Staff xsi:nil="true" />
            <Staff xsi:nil="true" />
          </GroupMembers>
          <GroupSecurity>
            <GroupSecurity xsi:nil="true" />
            <GroupSecurity xsi:nil="true" />
          </GroupSecurity>
          <GroupSessions>
            <GroupSession xsi:nil="true" />
            <GroupSession xsi:nil="true" />
          </GroupSessions>
          <MemberCount>int</MemberCount>
          <ClassNumberID>int</ClassNumberID>
          <ContractGroupID>int</ContractGroupID>
          <GroupsID>int</GroupsID>
          <FieldMaxAccessLevel>int</FieldMaxAccessLevel>
          <FieldMaxEditLevel>int</FieldMaxEditLevel>
          <RptAccessLevel>int</RptAccessLevel>
          <RptEditLevel>int</RptEditLevel>
          <Title>string</Title>
          <InvoiceNumberID>int</InvoiceNumberID>
          <PONumberID>int</PONumberID>
          <ReceiptNumberID>int</ReceiptNumberID>
        </Group>
        <IPAddress>string</IPAddress>
        <Person>
          <AddressList>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </AddressList>
          <ContactList>
            <Contact xsi:nil="true" />
            <Contact xsi:nil="true" />
          </ContactList>
          <PostaNotes>
            <PostaNote xsi:nil="true" />
            <PostaNote xsi:nil="true" />
          </PostaNotes>
          <Tags>
            <PersonTag xsi:nil="true" />
            <PersonTag xsi:nil="true" />
          </Tags>
          <AlertTag>string</AlertTag>
          <MaskedSSN>string</MaskedSSN>
          <AccountID>int</AccountID>
          <PerAge>int</PerAge>
          <AlertLevel>int</AlertLevel>
          <AutoTag>string</AutoTag>
          <PerCitizenStatusListID>int</PerCitizenStatusListID>
          <Code>string</Code>
          <CountryOfBirth>string</CountryOfBirth>
          <CountryOfCitzenship>string</CountryOfCitzenship>
          <Dependents>int</Dependents>
          <DOB>dateTime</DOB>
          <PerDOBVerifyListID>int</PerDOBVerifyListID>
          <DriverLicNum>string</DriverLicNum>
          <PerDwellingListID>int</PerDwellingListID>
          <PerEdLevelListID>int</PerEdLevelListID>
          <Employer>string</Employer>
          <PerEthnicityListID>int</PerEthnicityListID>
          <FirstName>string</FirstName>
          <Gender>string</Gender>
          <GenIdentity>string</GenIdentity>
          <HasBenefit>boolean</HasBenefit>
          <HasPopulation>boolean</HasPopulation>
          <PerGUID>string</PerGUID>
          <PerHomeLanguageID>int</PerHomeLanguageID>
          <ImportKey>int</ImportKey>
          <PerIncomeListID>int</PerIncomeListID>
          <Initals>string</Initals>
          <IsArchived>boolean</IsArchived>
          <IsDependent>boolean</IsDependent>
          <IsSenior>boolean</IsSenior>
          <IsEmployed>boolean</IsEmployed>
          <PerLanguageListID>int</PerLanguageListID>
          <LastName>string</LastName>
          <MaidenName>string</MaidenName>
          <PerMaritalListID>int</PerMaritalListID>
          <MidName>string</MidName>
          <ParkPermitNumber>string</ParkPermitNumber>
          <PlaceOfBirth>string</PlaceOfBirth>
          <Prefix>string</Prefix>
          <PrefName>string</PrefName>
          <PerRaceListID>int</PerRaceListID>
          <PersonID>int</PersonID>
          <SignatureID>int</SignatureID>
          <SSN>string</SSN>
          <PerSSNVerifyListID>int</PerSSNVerifyListID>
          <StateOfBirth>string</StateOfBirth>
          <Suffix>string</Suffix>
          <Title>string</Title>
          <UserData>string</UserData>
          <PictureID>int</PictureID>
          <SchoolID>int</SchoolID>
          <VendorCode>string</VendorCode>
        </Person>
        <ReportAccessLevel>int</ReportAccessLevel>
        <ReportEditLevel>int</ReportEditLevel>
        <Reset>boolean</Reset>
        <SocialNetwork>
          <Email>string</Email>
          <FaceBook>string</FaceBook>
          <LinkedIn>string</LinkedIn>
          <MobilePhone>string</MobilePhone>
          <MySpace>string</MySpace>
          <Skype>string</Skype>
          <StumbleUpon>string</StumbleUpon>
          <Twitter>string</Twitter>
        </SocialNetwork>
        <Staff>
          <CampusKeys>string</CampusKeys>
          <LastLogin>dateTime</LastLogin>
          <LoginName>string</LoginName>
          <PrimaryCampusID>int</PrimaryCampusID>
          <SecurityGroupID>int</SecurityGroupID>
          <SecurityGrpName>string</SecurityGrpName>
          <CertExpireDate>dateTime</CertExpireDate>
          <CertPID>string</CertPID>
          <Documents>
            <StaffNote xsi:nil="true" />
            <StaffNote xsi:nil="true" />
          </Documents>
          <StatusTitle>string</StatusTitle>
          <Summary>
            <Alerts xsi:nil="true" />
            <ClassResourceCount>int</ClassResourceCount>
            <CurrentActivity>string</CurrentActivity>
            <CurrentLocation>string</CurrentLocation>
            <Email>string</Email>
            <EmergencyContact>string</EmergencyContact>
            <PrimaryAddress>string</PrimaryAddress>
            <PrimaryPhone>string</PrimaryPhone>
            <StudentCounts>string</StudentCounts>
          </Summary>
          <TeaAuth>string</TeaAuth>
          <Teacher>
            <Staff xsi:nil="true" />
            <TypeTitle>string</TypeTitle>
            <StaffID>int</StaffID>
            <CertExpireDate>dateTime</CertExpireDate>
            <CertPID>string</CertPID>
            <TeaAuth>string</TeaAuth>
            <TeacherID>int</TeacherID>
            <ImportKey>int</ImportKey>
            <TeaCode>string</TeaCode>
            <TeaTypeListID>int</TeaTypeListID>
            <UserData>string</UserData>
          </Teacher>
          <TeaCode>string</TeaCode>
          <ContactRules>string</ContactRules>
          <EndDate>dateTime</EndDate>
          <IsAdministrator>boolean</IsAdministrator>
          <IsCoordinator>boolean</IsCoordinator>
          <Bio>string</Bio>
          <StaffID>int</StaffID>
          <IsAdvisor>boolean</IsAdvisor>
          <IsRecruit>boolean</IsRecruit>
          <IsSchoolContact>boolean</IsSchoolContact>
          <IsTeacher>boolean</IsTeacher>
          <StartDate>dateTime</StartDate>
          <StaStatusID>int</StaStatusID>
          <StatusChangeDate>dateTime</StatusChangeDate>
          <StaTypeListID>int</StaTypeListID>
        </Staff>
        <GroupsID>int</GroupsID>
        <L1AccessKey>base64Binary</L1AccessKey>
        <L2AccessKey>base64Binary</L2AccessKey>
        <PersonID>int</PersonID>
        <Login>string</Login>
        <PictureIDusr>int</PictureIDusr>
        <UsersID>int</UsersID>
        <AccessKey>base64Binary</AccessKey>
        <Answer>string</Answer>
        <Calendar>string</Calendar>
        <UsrEmail>string</UsrEmail>
        <KeyDate>dateTime</KeyDate>
        <LastLogin>dateTime</LastLogin>
        <MustChangePwd>boolean</MustChangePwd>
        <Question>string</Question>
        <Status>int</Status>
        <UsrTempPwd>string</UsrTempPwd>
        <UseAD>boolean</UseAD>
        <CalendarID>int</CalendarID>
      </GetUsersByIDResult>
    </GetUsersByIDResponse>
  </soap12:Body>
</soap12:Envelope>