Reference for http://product.datastream.com/DswsClient/V1/DSService.svc/rest/Ping?props={PROPS}&format={FORMAT}
Issues a ping request to check connectivity and health.
Url: http://product.datastream.com/DswsClient/V1/DSService.svc/rest/Ping?props={PROPS}&format={FORMAT}
HTTP Method: GET
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<ArrayOfDSStringObjectKVPair xmlns="http://dsws.datastream.com/client/V1/"> <DSStringObjectKVPair> <Key>String content</Key> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <Value xmlns:d7="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:type="d7:ArrayOfanyType" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <d7:anyType i:nil="true" /> <d7:anyType i:nil="true" /> </d7:anyType> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <d7:anyType i:nil="true" /> <d7:anyType i:nil="true" /> </d7:anyType> </d7:anyType> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <d7:anyType i:nil="true" /> <d7:anyType i:nil="true" /> </d7:anyType> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <d7:anyType i:nil="true" /> <d7:anyType i:nil="true" /> </d7:anyType> </d7:anyType> </Value> </DSStringObjectKVPair> <DSStringObjectKVPair> <Key>String content</Key> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <Value xmlns:d7="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:type="d7:ArrayOfanyType" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <d7:anyType i:nil="true" /> <d7:anyType i:nil="true" /> </d7:anyType> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <d7:anyType i:nil="true" /> <d7:anyType i:nil="true" /> </d7:anyType> </d7:anyType> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <d7:anyType i:nil="true" /> <d7:anyType i:nil="true" /> </d7:anyType> <!--Valid elements of type: ArrayOfanyType, ArrayOfboolean, ArrayOfdateTime, ArrayOfdouble, ArrayOfDSStringObjectKVPair, ArrayOfint, ArrayOfstring, DSStringObjectKVPair, KVPairOfstringanyType, schema--> <d7:anyType i:type="ArrayOfanyType"> <d7:anyType i:nil="true" /> <d7:anyType i:nil="true" /> </d7:anyType> </d7:anyType> </Value> </DSStringObjectKVPair> </ArrayOfDSStringObjectKVPair>
The following is an example response Json body:
[{ "Key":"String content", "Value":{ "anyType":{ "anyType":{ "anyType":null } } } }]
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://dsws.datastream.com/client/V1/" elementFormDefault="qualified" targetNamespace="http://dsws.datastream.com/client/V1/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:simpleType name="DSFaultCodes"> <xs:restriction base="xs:string"> <xs:enumeration value="Undefined" /> <xs:enumeration value="InvalidCredentials" /> <xs:enumeration value="InvalidToken" /> <xs:enumeration value="InvalidArgument" /> <xs:enumeration value="NotAuthorized" /> <xs:enumeration value="ResponseTooLarge" /> <xs:enumeration value="DataError" /> <xs:enumeration value="Timeout" /> </xs:restriction> </xs:simpleType> <xs:element name="DSFaultCodes" nillable="true" type="tns:DSFaultCodes" /> <xs:simpleType name="DSInstrumentPropertyNames"> <xs:restriction base="xs:string"> <xs:enumeration value="IsList" /> <xs:enumeration value="IsExpression" /> <xs:enumeration value="IsSymbolSet" /> <xs:enumeration value="ReturnCurrency" /> <xs:enumeration value="ReturnName" /> <xs:enumeration value="ReturnNoDates"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="DSInstrumentPropertyNames" nillable="true" type="tns:DSInstrumentPropertyNames" /> <xs:simpleType name="DSDataTypePropertyNames"> <xs:restriction base="xs:string"> <xs:enumeration value="Scale" /> <xs:enumeration value="Currency" /> <xs:enumeration value="DecimalPlaces" /> <xs:enumeration value="ReturnName" /> </xs:restriction> </xs:simpleType> <xs:element name="DSDataTypePropertyNames" nillable="true" type="tns:DSDataTypePropertyNames" /> <xs:simpleType name="DSDateNames"> <xs:restriction base="xs:string"> <xs:enumeration value="BDATE" /> <xs:enumeration value="SWDATE" /> <xs:enumeration value="SMDATE" /> <xs:enumeration value="SQDATE" /> <xs:enumeration value="SYDATE" /> <xs:enumeration value="TIME" /> <xs:enumeration value="LATESTDATE" /> <xs:enumeration value="DEFAULTDATE" /> <xs:enumeration value="TODAY" /> <xs:enumeration value="YRE" /> <xs:enumeration value="MTE" /> <xs:enumeration value="QTE" /> <xs:enumeration value="WKE" /> <xs:enumeration value="YRS" /> <xs:enumeration value="MTS" /> <xs:enumeration value="QTS" /> <xs:enumeration value="WKS" /> <xs:enumeration value="YRM" /> <xs:enumeration value="MTM" /> <xs:enumeration value="QTM" /> <xs:enumeration value="WKM" /> </xs:restriction> </xs:simpleType> <xs:element name="DSDateNames" nillable="true" type="tns:DSDateNames" /> <xs:simpleType name="DSDateFrequencyNames"> <xs:restriction base="xs:string"> <xs:enumeration value="D" /> <xs:enumeration value="W" /> <xs:enumeration value="M" /> <xs:enumeration value="Q" /> <xs:enumeration value="Y" /> </xs:restriction> </xs:simpleType> <xs:element name="DSDateFrequencyNames" nillable="true" type="tns:DSDateFrequencyNames" /> <xs:complexType name="ArrayOfDSStringObjectKVPair"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="DSStringObjectKVPair" nillable="true" type="tns:DSStringObjectKVPair" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDSStringObjectKVPair" nillable="true" type="tns:ArrayOfDSStringObjectKVPair" /> <xs:complexType name="DSStringObjectKVPair"> <xs:complexContent mixed="false"> <xs:extension base="tns:KVPairOfstringanyType"> <xs:sequence /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DSStringObjectKVPair" nillable="true" type="tns:DSStringObjectKVPair" /> <xs:complexType name="KVPairOfstringanyType"> <xs:annotation> <xs:appinfo> <GenericType Name="KVPairOf{0}{1}{#}" Namespace="http://dsws.datastream.com/client/V1/" xmlns="http://schemas.microsoft.com/2003/10/Serialization/"> <GenericParameter Name="string" Namespace="http://www.w3.org/2001/XMLSchema" /> <GenericParameter Name="anyType" Namespace="http://www.w3.org/2001/XMLSchema" /> </GenericType> </xs:appinfo> </xs:annotation> <xs:sequence> <xs:element minOccurs="0" name="Key" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Value" nillable="true" type="xs:anyType" /> </xs:sequence> </xs:complexType> <xs:element name="KVPairOfstringanyType" nillable="true" type="tns:KVPairOfstringanyType" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfstring"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" /> <xs:complexType name="ArrayOfint"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="int" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfint" nillable="true" type="tns:ArrayOfint" /> <xs:complexType name="ArrayOfdateTime"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="dateTime" type="xs:dateTime" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfdateTime" nillable="true" type="tns:ArrayOfdateTime" /> <xs:complexType name="ArrayOfdouble"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="double" type="xs:double" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfdouble" nillable="true" type="tns:ArrayOfdouble" /> <xs:complexType name="ArrayOfboolean"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="boolean" type="xs:boolean" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfboolean" nillable="true" type="tns:ArrayOfboolean" /> <xs:complexType name="ArrayOfanyType"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="anyType" nillable="true" type="xs:anyType" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfanyType" nillable="true" type="tns:ArrayOfanyType" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>