WSDL - SchoolDefinedFieldService

Use the following URL to access the service. Replace <server:port> with appropriate values for your environment.

http://<server:port>/Cmc.Integration.WebServices/SchoolDefinedFieldService.asmx

This WSDL describes the SchoolDefinedFieldService.

<?xml version="1.0" encoding="utf-8"?>
<wsdl:definitions xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:tns="http://www.campusmgmt.com/Soa/Foundation/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:s1="http://www.campusmgmt.com/Soa/Foundation/MessageDefinition.xsd" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" targetNamespace="http://www.campusmgmt.com/Soa/Foundation/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
  <wsdl:types>
    <s:schema elementFormDefault="qualified" targetNamespace="http://www.campusmgmt.com/Soa/Foundation/">
      <s:import namespace="http://www.campusmgmt.com/Soa/Foundation/MessageDefinition.xsd" />
      <s:element name="AddUpdateSchoolDefinedField">
        <s:complexType>
          <s:sequence>
            <s:element minOccurs="0" maxOccurs="1" ref="s1:AddUpdateSchoolDefinedFieldRequest" />
          </s:sequence>
        </s:complexType>
      </s:element>
      <s:element name="AddUpdateSchoolDefinedFieldResponse">
        <s:complexType>
          <s:sequence>
            <s:element minOccurs="0" maxOccurs="1" ref="s1:AddUpdateSchoolDefinedFieldResponse" />
          </s:sequence>
        </s:complexType>
      </s:element>
      <s:element name="RequestHeader" type="tns:RequestHeader" />
      <s:complexType name="RequestHeader">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="1" name="Headers" type="tns:ArrayOfAnyType" />
        </s:sequence>
        <s:anyAttribute />
      </s:complexType>
      <s:complexType name="ArrayOfAnyType">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="unbounded" name="anyType" nillable="true" />
        </s:sequence>
      </s:complexType>
      <s:element name="ResponseHeader" type="tns:ResponseHeader" />
      <s:complexType name="ResponseHeader">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="1" name="Headers" type="tns:ArrayOfAnyType" />
        </s:sequence>
        <s:anyAttribute />
      </s:complexType>
    </s:schema>
    <s:schema elementFormDefault="qualified" targetNamespace="http://www.campusmgmt.com/Soa/Foundation/MessageDefinition.xsd">
      <s:element name="AddUpdateSchoolDefinedFieldRequest" type="s1:AddUpdateSchoolDefinedFieldRequest" />
      <s:complexType name="AddUpdateSchoolDefinedFieldRequest">
        <s:complexContent mixed="false">
          <s:extension base="s1:GenericRequest">
            <s:sequence>
              <s:element minOccurs="0" maxOccurs="1" name="AddUpdateSchoolDefinedFields" type="s1:ArrayOfAddUpdateSchoolDefinedFieldInMsg" />
            </s:sequence>
          </s:extension>
        </s:complexContent>
      </s:complexType>
      <s:complexType name="GenericRequest">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="1" name="TokenId" type="s:string" />
        </s:sequence>
      </s:complexType>
      <s:complexType name="ArrayOfAddUpdateSchoolDefinedFieldInMsg">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="unbounded" name="AddUpdateSchoolDefinedFieldInMsg" nillable="true" type="s1:AddUpdateSchoolDefinedFieldInMsg" />
        </s:sequence>
      </s:complexType>
      <s:complexType name="AddUpdateSchoolDefinedFieldInMsg">
        <s:complexContent mixed="false">
          <s:extension base="s1:GenericInMsg">
            <s:sequence>
              <s:element minOccurs="1" maxOccurs="1" name="StudentId" type="s:int" />
            </s:sequence>
          </s:extension>
        </s:complexContent>
      </s:complexType>
      <s:complexType name="GenericInMsg">
        <s:complexContent mixed="false">
          <s:extension base="s1:GenericMsg">
            <s:sequence>
              <s:element minOccurs="0" maxOccurs="1" name="MessageState" type="s:string" />
            </s:sequence>
          </s:extension>
        </s:complexContent>
      </s:complexType>
      <s:complexType name="GenericMsg">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="1" default="-1" name="MessageId" type="s:int" />
          <s:element minOccurs="0" maxOccurs="1" name="CustomAttributes" type="s1:ArrayOfCustomAttributeMsg" />
          <s:element minOccurs="0" maxOccurs="1" default="-1" name="CorrelationId" type="s:int" />
          <s:element minOccurs="0" maxOccurs="1" default="false" name="SkipSemanticValidation" type="s:boolean" />
        </s:sequence>
      </s:complexType>
      <s:complexType name="ArrayOfCustomAttributeMsg">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="unbounded" name="CustomAttributeMsg" nillable="true" type="s1:CustomAttributeMsg" />
        </s:sequence>
      </s:complexType>
      <s:complexType name="CustomAttributeMsg">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="1" name="Name" type="s:string" />
          <s:element minOccurs="0" maxOccurs="1" name="Value" type="s:string" />
        </s:sequence>
      </s:complexType>
      <s:complexType name="GenericOutMsg">
        <s:complexContent mixed="false">
          <s:extension base="s1:GenericMsg">
            <s:sequence>
              <s:element minOccurs="0" maxOccurs="1" name="MessageResult" type="s:string" />
              <s:element minOccurs="0" maxOccurs="1" default="OK" name="MessageStatus" type="s1:MessageStatusType" />
              <s:element minOccurs="0" maxOccurs="1" name="MessageErrorCode" type="s:string" />
            </s:sequence>
          </s:extension>
        </s:complexContent>
      </s:complexType>
      <s:simpleType name="MessageStatusType">
        <s:restriction base="s:string">
          <s:enumeration value="OK" />
          <s:enumeration value="FailedValidation" />
          <s:enumeration value="FailedExecution" />
          <s:enumeration value="FailedAuthorization" />
          <s:enumeration value="FailedOther" />
        </s:restriction>
      </s:simpleType>
      <s:complexType name="AddUpdateSchoolDefinedFieldOutMsg">
        <s:complexContent mixed="false">
          <s:extension base="s1:GenericOutMsg">
            <s:sequence>
              <s:element minOccurs="0" maxOccurs="unbounded" name="SyUserValuesID" type="s:int" />
            </s:sequence>
          </s:extension>
        </s:complexContent>
      </s:complexType>
      <s:element name="AddUpdateSchoolDefinedFieldResponse" type="s1:AddUpdateSchoolDefinedFieldResponse" />
      <s:complexType name="AddUpdateSchoolDefinedFieldResponse">
        <s:complexContent mixed="false">
          <s:extension base="s1:GenericResponse">
            <s:sequence>
              <s:element minOccurs="0" maxOccurs="1" name="AddUpdateSchoolDefinedFields" type="s1:ArrayOfAddUpdateSchoolDefinedFieldOutMsg" />
            </s:sequence>
          </s:extension>
        </s:complexContent>
      </s:complexType>
      <s:complexType name="GenericResponse">
        <s:sequence>
          <s:element minOccurs="1" maxOccurs="1" name="Status" type="s1:TrxStatus" />
          <s:element minOccurs="0" maxOccurs="1" name="TrxResult" type="s:string" />
          <s:element minOccurs="0" maxOccurs="1" name="TokenId" type="s:string" />
        </s:sequence>
      </s:complexType>
      <s:simpleType name="TrxStatus">
        <s:restriction base="s:string">
          <s:enumeration value="OK" />
          <s:enumeration value="ErrorSQL" />
          <s:enumeration value="ErrorBusinessLogic" />
          <s:enumeration value="ErrorWebService" />
          <s:enumeration value="ErrorArguments" />
          <s:enumeration value="ErrorSecurity" />
          <s:enumeration value="ErrorSystem" />
          <s:enumeration value="ErrorMultiple" />
        </s:restriction>
      </s:simpleType>
      <s:complexType name="ArrayOfAddUpdateSchoolDefinedFieldOutMsg">
        <s:sequence>
          <s:element minOccurs="0" maxOccurs="unbounded" name="AddUpdateSchoolDefinedFieldOutMsg" nillable="true" type="s1:AddUpdateSchoolDefinedFieldOutMsg" />
        </s:sequence>
      </s:complexType>
    </s:schema>
  </wsdl:types>
  <wsdl:message name="AddUpdateSchoolDefinedFieldSoapIn">
    <wsdl:part name="parameters" element="tns:AddUpdateSchoolDefinedField" />
  </wsdl:message>
  <wsdl:message name="AddUpdateSchoolDefinedFieldSoapOut">
    <wsdl:part name="parameters" element="tns:AddUpdateSchoolDefinedFieldResponse" />
  </wsdl:message>
  <wsdl:message name="AddUpdateSchoolDefinedFieldRequestHeader">
    <wsdl:part name="RequestHeader" element="tns:RequestHeader" />
  </wsdl:message>
  <wsdl:message name="AddUpdateSchoolDefinedFieldResponseHeader">
    <wsdl:part name="ResponseHeader" element="tns:ResponseHeader" />
  </wsdl:message>
  <wsdl:portType name="SchoolDefinedFieldServiceSoap">
    <wsdl:operation name="AddUpdateSchoolDefinedField">
      <wsdl:input message="tns:AddUpdateSchoolDefinedFieldSoapIn" />
      <wsdl:output message="tns:AddUpdateSchoolDefinedFieldSoapOut" />
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="SchoolDefinedFieldServiceSoap" type="tns:SchoolDefinedFieldServiceSoap">
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http" />
    <wsdl:operation name="AddUpdateSchoolDefinedField">
      <soap:operation soapAction="http://www.campusmgmt.com/Soa/Foundation/AddUpdateSchoolDefinedField" style="document" />
      <wsdl:input>
        <soap:body use="literal" />
        <soap:header message="tns:AddUpdateSchoolDefinedFieldRequestHeader" part="RequestHeader" use="literal" />
      </wsdl:input>
      <wsdl:output>
        <soap:body use="literal" />
        <soap:header message="tns:AddUpdateSchoolDefinedFieldResponseHeader" part="ResponseHeader" use="literal" />
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:binding name="SchoolDefinedFieldServiceSoap12" type="tns:SchoolDefinedFieldServiceSoap">
    <soap12:binding transport="http://schemas.xmlsoap.org/soap/http" />
    <wsdl:operation name="AddUpdateSchoolDefinedField">
      <soap12:operation soapAction="http://www.campusmgmt.com/Soa/Foundation/AddUpdateSchoolDefinedField" style="document" />
      <wsdl:input>
        <soap12:body use="literal" />
        <soap12:header message="tns:AddUpdateSchoolDefinedFieldRequestHeader" part="RequestHeader" use="literal" />
      </wsdl:input>
      <wsdl:output>
        <soap12:body use="literal" />
        <soap12:header message="tns:AddUpdateSchoolDefinedFieldResponseHeader" part="ResponseHeader" use="literal" />
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="SchoolDefinedFieldService">
    <wsdl:port name="SchoolDefinedFieldServiceSoap" binding="tns:SchoolDefinedFieldServiceSoap">
      <soap:address location="http://localhost/Cmc.Integration.WebServices/SchoolDefinedFieldService.asmx" />
    </wsdl:port>
    <wsdl:port name="SchoolDefinedFieldServiceSoap12" binding="tns:SchoolDefinedFieldServiceSoap12">
      <soap12:address location="http://localhost/Cmc.Integration.WebServices/SchoolDefinedFieldService.asmx" />
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

SOAP Request and Response

The following are the SOAP 1.1 and SOAP 1.2 service request and response of the SchoolDefinedFieldService.

The placeholders for data types (boolean, decimal, dateTime, int, string) and length need to be replaced with actual values.

SOAP 1.1

POST /Cmc.Integration.WebServices/SchoolDefinedFieldService.asmx HTTP/1.1

Host: cltstgapi1

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.campusmgmt.com/Soa/Foundation/AddUpdateSchoolDefinedField"

<?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>

<RequestHeader xmlns="http://www.campusmgmt.com/Soa/Foundation/">

<Headers>

<anyType />

<anyType />

</Headers>

</RequestHeader>

</soap:Header>

<soap:Body>

<AddUpdateSchoolDefinedField xmlns="http://www.campusmgmt.com/Soa/Foundation/">

<AddUpdateSchoolDefinedFieldRequest xmlns="http://www.campusmgmt.com/Soa/Foundation/MessageDefinition.xsd">

<AddUpdateSchoolDefinedFields>

<AddUpdateSchoolDefinedFieldInMsg>

<StudentId>int</StudentId>

</AddUpdateSchoolDefinedFieldInMsg>

<AddUpdateSchoolDefinedFieldInMsg>

<StudentId>int</StudentId>

</AddUpdateSchoolDefinedFieldInMsg>

</AddUpdateSchoolDefinedFields>

</AddUpdateSchoolDefinedFieldRequest>

</AddUpdateSchoolDefinedField>

</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>

<ResponseHeader xmlns="http://www.campusmgmt.com/Soa/Foundation/">

<Headers>

<anyType />

<anyType />

</Headers>

</ResponseHeader>

</soap:Header>

<soap:Body>

<AddUpdateSchoolDefinedFieldResponse xmlns="http://www.campusmgmt.com/Soa/Foundation/">

<AddUpdateSchoolDefinedFieldResponse xmlns="http://www.campusmgmt.com/Soa/Foundation/MessageDefinition.xsd">

<AddUpdateSchoolDefinedFields>

<AddUpdateSchoolDefinedFieldOutMsg>

<SyUserValuesID>int</SyUserValuesID>

<SyUserValuesID>int</SyUserValuesID>

</AddUpdateSchoolDefinedFieldOutMsg>

<AddUpdateSchoolDefinedFieldOutMsg>

<SyUserValuesID>int</SyUserValuesID>

<SyUserValuesID>int</SyUserValuesID>

</AddUpdateSchoolDefinedFieldOutMsg>

</AddUpdateSchoolDefinedFields>

</AddUpdateSchoolDefinedFieldResponse>

</AddUpdateSchoolDefinedFieldResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2

POST /Cmc.Integration.WebServices/SchoolDefinedFieldService.asmx HTTP/1.1

Host: cltstgapi1

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>

<RequestHeader xmlns="http://www.campusmgmt.com/Soa/Foundation/">

<Headers>

<anyType />

<anyType />

</Headers>

</RequestHeader>

</soap12:Header>

<soap12:Body>

<AddUpdateSchoolDefinedField xmlns="http://www.campusmgmt.com/Soa/Foundation/">

<AddUpdateSchoolDefinedFieldRequest xmlns="http://www.campusmgmt.com/Soa/Foundation/MessageDefinition.xsd">

<AddUpdateSchoolDefinedFields>

<AddUpdateSchoolDefinedFieldInMsg>

<StudentId>int</StudentId>

</AddUpdateSchoolDefinedFieldInMsg>

<AddUpdateSchoolDefinedFieldInMsg>

<StudentId>int</StudentId>

</AddUpdateSchoolDefinedFieldInMsg>

</AddUpdateSchoolDefinedFields>

</AddUpdateSchoolDefinedFieldRequest>

</AddUpdateSchoolDefinedField>

</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>

<ResponseHeader xmlns="http://www.campusmgmt.com/Soa/Foundation/">

<Headers>

<anyType />

<anyType />

</Headers>

</ResponseHeader>

</soap12:Header>

<soap12:Body>

<AddUpdateSchoolDefinedFieldResponse xmlns="http://www.campusmgmt.com/Soa/Foundation/">

<AddUpdateSchoolDefinedFieldResponse xmlns="http://www.campusmgmt.com/Soa/Foundation/MessageDefinition.xsd">

<AddUpdateSchoolDefinedFields>

<AddUpdateSchoolDefinedFieldOutMsg>

<SyUserValuesID>int</SyUserValuesID>

<SyUserValuesID>int</SyUserValuesID>

</AddUpdateSchoolDefinedFieldOutMsg>

<AddUpdateSchoolDefinedFieldOutMsg>

<SyUserValuesID>int</SyUserValuesID>

<SyUserValuesID>int</SyUserValuesID>

</AddUpdateSchoolDefinedFieldOutMsg>

</AddUpdateSchoolDefinedFields>

</AddUpdateSchoolDefinedFieldResponse>

</AddUpdateSchoolDefinedFieldResponse>

</soap12:Body>

</soap12:Envelope>