Reference for DSService.svc - GetToken

Given user credentials, retrieves a secure token that can be used for data access.

REQUEST PARAMETERS

The operation takes in a parameter of type DSGetTokenRequest which has the following members.

Name Type Description Example Value
UserName String The username to validate ZABC123
Password String The password corresponding to username yourpassword
Properties DSStringObjectKVPair[] Properties to customize behavior null

The operation returns a parameter of type DSGetTokenResponse which has the following members.

Name Type Description Example Value
TokenValue String The token value that must be used in subsequent data requests. n9IcXCXIq+ApBEe0zLBeTrU11D65F6BB2ED74E3467EA0EBE
TokenExpiry DateTime The duration (in UTC) until which the token is valid. 2013-01-30T21:11:22.2771093Z
Properties DSStringObjectKVPair[] Properties describing behavior null

SOAP

The following is a sample SOAP request.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
 <s:Header>
  <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://dsws.datastream.com/client/V1/IDSService/GetToken</Action> 
 </s:Header>
 <s:Body>
  <GetToken xmlns="http://dsws.datastream.com/client/V1/">
    <request xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <UserName>ZABC123</UserName> 
      <Password>yourpassword</Password> 
      <Properties i:nil="true" /> 
     </request>
  </GetToken>
 </s:Body>
</s:Envelope>

The following is a sample SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header /> 
  <s:Body>
    <GetTokenResponse xmlns="http://dsws.datastream.com/client/V1/">
      <GetTokenResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <TokenValue>n9IcXCXIq+ApBEe0zLBeTrU11D65F6BB2ED74E3467EA0EBE0C</TokenValue> 
        <TokenExpiry>2013-01-30T21:11:22.2771093Z</TokenExpiry> 
        <Properties i:nil="true" /> 
      </GetTokenResult>
    </GetTokenResponse>
  </s:Body>
</s:Envelope>