Wiki
retrieve Service List

retrieveServiceList

Purpose

  1. Allow a user to query range of support offered by a particular service implementation.
  2. Provide definitions that can be further referenced when requesting quotes/translations (e.g. Service offerings)

Passed In

Returned

Support specification

Note : For the following we should decide whether we wish to include it, and if so, whether its Explicit (and restricted), Free Format or Extensible (i.e. some definitions provided only).

Support Comment Include, Format
Languages support Language support Yes, Explicit
Service Types See Appendix 1 Yes, Combination
Mime Types Types of file supported Yes, Extensible
Domain

Schema

Request

<xsd:element name="retrieveServiceListRequest">
  <xsd:complexType>
   <xsd:sequence/>
  </xsd:complexType>
</xsd:element>

Response

<xsd:element name="retrieveServiceListResponse">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="types:languagePairs"/>
      <xsd:element ref="types:services"/>
      <xsd:element ref="types:mimeTypes"/>
      <xsd:element ref="types:domains"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

<xsd:element name="locale">
  <xsd:complexType>
    <xsd:attribute name="country" type="iso3166:CodeContentType" use="required"/>
    <xsd:attribute name="language" type="iso639:CodeContentType" use="required"/>
    <xsd:attribute name="variant" type="xsd:string" use="optional"/>
  </xsd:complexType>
</xsd:element>

<xsd:element name="source">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="types:locale"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

<xsd:element name="target">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="types:locale"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

<xsd:element name="languagePair">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element ref="types:source"/>
      <xsd:element ref="types:target"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

<xsd:element name="languagePairs">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element minOccurs="1" maxOccurs="unbounded" ref="types:languagePair"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

<xsd:element name="service" type="WSTransServiceTypes:CodeContentType"/>
<xsd:element name="services">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element maxOccurs="unbounded" minOccurs="1" ref="types:service"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

<xsd:element name="mimeType" type="WSTransMimeTypes:CodeContentType" />
<xsd:element name="mimeTypes">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element maxOccurs="unbounded" minOccurs="1" ref="types:mimeType"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

<xsd:element name="domain" type="WSTransDomainTypes:CodeContentType"/>
<xsd:element name="domains">
  <xsd:complexType>
    <xsd:sequence>
      <xsd:element maxOccurs="unbounded" minOccurs="1" ref="types:domain"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:element>

Sample Message

Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" 
                  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <retrieveServiceListRequest xmlns="urn:oasis:names:tc:wstrans:v1:types"/>
  </soapenv:Body>
</soapenv:Envelope>

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" 
                  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <retrieveServiceListResponse xmlns="urn:oasis:names:tc:wstrans:v1:types">
      <languagePairs>
        <languagePair>
          <source>
            <locale country="US" language="en"/>
          </source>
          <target>
            <locale country="FR" language="fr"/>
          </target>
        </languagePair>
        <languagePair>
          <source>
            <locale country="US" language="en"/>
          </source>
          <target>
            <locale country="DE" language="de"/>
          </target>
        </languagePair>
      </languagePairs>
      <services>
        <service>01.00</service>
        <service>01.01</service>
        <service>01.02</service>
        <service>01.03</service>
        <service>01.04</service>
        <service>01.05</service>
        <service>01.06</service>
        <service>01.07</service>
        <service>01.08</service>
        <service>01.09</service>
      </services>
      <mimeTypes>
        <mimeType>application/EDI-Consent</mimeType>
        <mimeType>application/EDI-X12</mimeType>
        <mimeType>application/EDIFACT</mimeType>
        <mimeType>application/SLA</mimeType>
        <mimeType>application/STEP</mimeType>
      </mimeTypes>
      <domains>
        <domain>01.00</domain>
        <domain>01.01</domain>
        <domain>01.02</domain>
        <domain>01.03</domain>
        <domain>01.04</domain>
      </domains>
    </retrieveServiceListResponse>
  </soapenv:Body>
</soapenv:Envelope>