Skip to main content

Back to Outstanding Requests Service Back to Home

Outstanding Requests Schema Explain

Data input field (from Land Registry (LR) test harness) Description Mandatory Minimum value Maximum value Has a pattern constraint XML datatype
Message ID Message ID is a unique input, used to identify your request. Yes Yes xs:string 

<xs:element name="ID"
    type="Q1IdentifierType"
    minOccurs="1" maxOccurs="1" />

<xs:complexType name="Q1IdentifierType">
    <xs:sequence>
        <xs:element name="MessageID"
            type="Q1TextType"
            minOccurs="1" maxOccurs="1">
            <xs:annotation>
                <xs:documentation>A character string
                    (i.e. a finite set of characters)
                    generally in the form of words of
                    a language.
                </xs:documentation>

<xs:complexType name="Q1TextType">
    <xs:annotation>
        <xs:documentation>A character string
            (i.e. a finite set of characters)
            generally in the form of words of
            a language.
    <xs:simpleContent>
        <xs:extension base="Q1TextContentType" />
    </xs:simpleContent>
</xs:complexType>

<xs:simpleType name="Q1TextContentType">
    <xs:restriction base="xs:string">
        <xs:minLength value="5" />
        <xs:maxLength value="50" />
        <xs:pattern value="[a-zA-Z0-9][a-zA-Z0-9\-]*" />
    </xs:restriction>
</xs:simpleType>
Request Outstanding Requests This is the main container for the service. 

<xs:element name="RequestOutstandingRequests"
    type="RequestOutstandingRequestsType" />
Request Outstanding Requests Type

ID element is described above (message ID).

The product element is described below.

 

<xs:complexType
    name="RequestOutstandingRequestsType">
    <xs:sequence>
        <xs:element name="ID"
            type="Q1IdentifierType"
            minOccurs="1" maxOccurs="1" />
        <xs:element name="Product"
            type="Q1OutstandingRequestsProductType"
            minOccurs="1" maxOccurs="1">
            <xs:annotation>
                <xs:documentation>This component contains
                    components holding details of the
                    requests being searched for
                </xs:documentation>
Q1 Outstanding Requests Product Type Main product element containing two items, both described below. 

<xs:element name="Product"
    type="Q1OutstandingRequestsProductType"
    minOccurs="1" maxOccurs="1">
    <xs:annotation>
        <xs:documentation>This component contains
            components holding details of the requests
            being searched for</xs:documentation>

<xs:complexType
    name="Q1OutstandingRequestsProductType">
    <xs:annotation>
        <xs:documentation>This component contains
            details regarding the requests being
            searched for.</xs:documentation>
    </xs:annotation>
    <xs:sequence>
        <xs:element name="ShowOnlyNewResponses"
            type="IndicatorType" default="false"
            minOccurs="1" maxOccurs="1" />
        <xs:element name="SpecificService"
            type="Q1ServiceType"
            minOccurs="0" maxOccurs="1" />
    </xs:sequence>
Specific Service This is the service type of the request. xs:int 

<xs:element name="SpecificService"
    type="Q1ServiceType"
    minOccurs="0" maxOccurs="1" />

<xs:simpleType name="Q1ServiceType">
    <xs:restriction base="xs:int" />
</xs:simpleType>
Show Only New Responses If set to true, system will only return new responses. If set to false, system will return all responses. xs:boolean 

<xs:element name="ShowOnlyNewResponses"
    type="IndicatorType" default="false"
    minOccurs="1" maxOccurs="1" />

<xs:complexType name="IndicatorType">
    <xs:annotation>
        <xs:documentation>A list of two mutually exclusive
            Boolean values that express the only possible
            states of a Property.</xs:documentation>
    </xs:annotation>
    <xs:simpleContent>
        <xs:extension base="xs:boolean" />
    </xs:simpleContent>
Numeric Type This element exists in the schema but is not currently used. xs:decimal 

<xs:simpleType name="NumericType">
    <xs:restriction base="xs:decimal" />
</xs:simpleType>