Appendix A: Request/Response Message Schema Definitions
This section contains the Request and Response schemas associated to all the operations supported by the ROC Web Service.
Request Schema: NewIncomingChangeRequestNotification
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="NewIncomingChangeRequestNotification">
<xs:complexType>
<xs:sequence>
<xs:element name="RegistrationCode" type="xs:string" minOccurs="0"/>
<xs:element name="TxnID" type="xs:string" minOccurs="0"/>
<xs:element name="SubmittingRespOrg" type="xs:string" minOccurs="0"/>
<xs:element name="SubmitterName" type="xs:string" minOccurs="0"/>
<xs:element name="SubmitterPhone" type="xs:string" minOccurs="0"/>
<xs:element name="SubmitterEmail" type="xs:string" minOccurs="0"/>
<xs:element name="SubmitterCompanyName" type="xs:string" minOccurs="0"/>
<xs:element name="NewRespOrgID" type="xs:string" minOccurs="0"/>
<xs:element name="ControllingRespOrg" type="xs:string" minOccurs="0"/>
<xs:element name="SubmissionDateTime" type="xs:dateTime" minOccurs="0"/>
<xs:element name="DueDateTime" type="xs:dateTime" minOccurs="0"/>
<xs:element name="LOAID" type="xs:string" minOccurs="0"/>
<xs:element name="LOAFileName" type="xs:string" minOccurs="0"/>
<xs:element name="ExpediteROC" type="xs:string" minOccurs="0"/>
<xs:element name="DialNumberList">
<xs:complexType>
<xs:sequence>
<xs:element name="Dial" type="xs:string" maxOccurs="unbounded" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="DocumentList" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="Document" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="DocumentID" type="xs:string" minOccurs="0"/>
<xs:element name="FileTitle" type="xs:string" minOccurs="0"/>
<xs:element name="FileNotes" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Response Schema: NewIncomingChangeRequestNotification
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="NewIncomingChangeRequestNotificationResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" name="StatusCode" type="xs:unsignedByte"/>
<xs:element minOccurs="0" name="ErrorReason" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Request Schema: ProcessedOutgoingChangeRequestNotification
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ProcessedOutgoingChangeRequestNotification">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="RegistrationCode"/>
<xs:element type="xs:string" name="TxnID"/>
<xs:element name="DialNumberList" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="DialNumber" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="Dial"/>
<xs:element type="xs:string" name="CurrentRespOrg" minOccurs="0"/>
<xs:element type="xs:string" name="CompanyName" minOccurs="0"/>
<xs:element type="xs:string" name="Status"/>
<xs:element type="ProcessedDatetime" type="xs:datetime" minOccurs="0" nillable="true" />
<xs:element type="xs:string" name="RejectNote" minOccurs="0"/>
<xs:element name="RejectReasonList" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="RejectReason" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="ReasonCode"/>
<xs:element type="xs:string" name="ReasonDescription"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="LOAID" type="xs:string" minOccurs="0"/>
<xs:element name="LOAFileName" type="xs:string" minOccurs="0"/>
<xs:element name="DocumentList" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="Document" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="DocumentID" type="xs:string" minOccurs="0"/>
<xs:element name="FileTitle" type="xs:string" minOccurs="0"/>
<xs:element name="FileNotes" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element type="xs:string" name="Notes" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Response Schema: ProcessedOutgoingChangeRequestNotification
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ProcessedOutgoingChangeRequestNotificationResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" name="StatusCode" type="xs:unsignedByte"/>
<xs:element minOccurs="0" name="ErrorReason" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Request Schema: PushedToRespOrgs
<?xml version="1.0" encoding="utf-8" ?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="PushedToRespOrgsRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="RegistrationCode" type="xs:string" minOccurs="0"/>
<xs:element name="TxnID" type="xs:string" minOccurs="0"/>
<xs:element name="DialNumberDetailList">
<xs:complexType>
<xs:sequence>
<xs:element name="DialNumber" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="Dial" type="xs:string" minOccurs="0"/>
<xs:element name="CurrentRespOrgID" type="xs:string" minOccurs="0"/>
<xs:element name="CompanyName" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Response Schema: PushedToRespOrgs
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="PushedToRespOrgsResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" name="StatusCode" type="xs:unsignedByte"/>
<xs:element minOccurs="0" name="ErrorReason" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Request Schema: ProcessedIncomingChangeRequestNotification
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ProcessedIncomingChangeRequestNotification">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="RegistrationCode"/>
<xs:element type="xs:string" name="TxnID"/>
<xs:element name="DialNumberList" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="DialNumber" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="Dial"/>
<xs:element type="xs:string" name="CurrentRespOrg" minOccurs="0"/>
<xs:element type="xs:string" name="CompanyName" minOccurs="0"/>
<xs:element type="xs:string" name="Status"/>
<xs:element type="ProcessedDatetime" type="xs:datetime" minOccurs="0" nillable="true" />
<xs:element type="xs:string" name="RejectNote" minOccurs="0"/>
<xs:element name="RejectReasonList" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="RejectReason" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="ReasonCode"/>
<xs:element type="xs:string" name="ReasonDescription"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="LOAID" type="xs:string" minOccurs="0"/>
<xs:element name="LOAFileName" type="xs:string" minOccurs="0"/>
<xs:element name="DocumentList" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="Document" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="DocumentID" type="xs:string" minOccurs="0"/>
<xs:element name="FileTitle" type="xs:string" minOccurs="0"/>
<xs:element name="FileNotes" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element type="xs:string" name="Notes" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Response Schema: ProcessedIncomingChangeRequestNotification
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ProcessedIncomingChangeRequestNotificationResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" name="StatusCode" type="xs:unsignedByte"/>
<xs:element minOccurs="0" name="ErrorReason" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Request Schema: ProcessedHelpDeskROCInterventionRequest
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ProcessedHelpDeskROCInterventionRequest">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="RegistrationCode"/>
<xs:element type="xs:string" name="TxnID"/>
<xs:element name="DialNumberList">
<xs:complexType>
<xs:sequence>
<xs:element name="DialNumber" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="Dial"/>
<xs:element type="xs:string" name="CurrentRespOrg"/>
<xs:element type="xs:string" name="CompanyName"/>
<xs:element type="xs:string" name="Status"/>
<xs:element name="RejectReasonList" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="RejectReason" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="ReasonCode"/>
<xs:element type="xs:string" name="ReasonDescription"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element type="xs:string" name="RejectNote" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Response Schema: ProcessedHelpDeskROCInterventionRequest
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ProcessedHelpDeskROCInterventionNotificationResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" name="StatusCode" type="xs:unsignedByte"/>
<xs:element minOccurs="0" name="ErrorReason" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>