Data Warehouse Web Service

POST

Service URL

LIVE: https://api.relateddigital.com/live/datawarehouse.asmx

ECOMM: https://api.relateddigital.com/ecomm/datawarehouse.asmx

MAX: https://api.relateddigital.com/max/datawarehouse.asmx

LIVEB: https://api.relateddigital.com/liveb/datawarehouse.asmx

Data Warehouse Web Service Methods

Method	Description
InsertUpdateRowInDwTable	Inserts/Updates a row in a Data Warehouse table. The reference column is defined by Key and Value pair.
SelectRowsFromDwTable	Selects details of rows from a Data Warehouse table. The reference column is defined by Key and Value pair.
UploadDataWarehouseFile	Uploads Data Warehouse file as byte array.
QueryMemberDatawarehouse	Selects Data Warehouse table by the reference column.
GetFLTableColumns	Gets Data Warehouse columns by table name.
UpdateDwTableExpireDate	Updates Data Warehouse table expiration date.

InsertUpdateRowInDwTable

Back To Top ^

`<InsertUpdateRowInDwTable>`
Inserts/Updates a row in a Data Warehouse table. The reference column is defined by Key and Value pair.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
DwTableName	The name of the desired DW Table	MANDATORY
DemograficData	Define the fields for member with the EmKeyValue string	MANDATORY
InsertEmptyValueForNonDemograficColumns	If flag is true, inserting empty value instead of non-demographic columns.	MANDATORY
ForceUpdate	If the member exists in the system and the value is `true` , then the existing member is updated.	MANDATORY
Key	EMAIL, MEMBER_ID or a field name of your defined in RMC account management panel.	MANDATORY
Value	The value of the field name specified in the `Key` field	MANDATORY

EXAMPLE REQUEST

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InsertUpdateRowInDwTable xmlns="http://ws.euromsg.com/datawarehouse">
      <ServiceTicket>string</ServiceTicket>
      <DwTableName>string</DwTableName>
      <Key>string</Key>
      <Value>string</Value>
      <DemograficData>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
        <EmKeyValue>
          <Key>string</Key>
          <Value>string</Value>
        </EmKeyValue>
      </DemograficData>
      <ForceUpdate>boolean</ForceUpdate>
      <InsertEmptyValueForNonDemograficColumns>boolean</InsertEmptyValueForNonDemograficColumns>
    </InsertUpdateRowInDwTable>
  </soap:Body>
</soap:Envelope>

EXAMPLE RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InsertUpdateRowInDwTableResponse xmlns="http://ws.euromsg.com/datawarehouse">
      <InsertUpdateRowInDwTableResult />
      <MemberID>string</MemberID>
    </InsertUpdateRowInDwTableResponse>
  </soap:Body>
</soap:Envelope>

If the request was successful, the <CODE> parameter will return 00 as a response.

Error Parameters

Code	Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	Member does not exist in the system.

SelectRowsFromDwTable

Back To Top ^

`<SelectRowsFromDwTable>`
Selects details of rows from a Data Warehouse table. The reference column is defined by Key and Value pair.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
DwTableName	The name of the desired DW Table	MANDATORY
Key	EMAIL, MEMBER_ID or a field name of your defined in RMC account management panel.	MANDATORY
Value	The value of the field name specified in the `Key` field	MANDATORY

EXAMPLE REQUEST

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SelectRowsFromDwTable xmlns="http://ws.euromsg.com/datawarehouse">
      <ServiceTicket>string</ServiceTicket>
      <DwTableName>string</DwTableName>
      <Key>string</Key>
      <Value>string</Value>
    </SelectRowsFromDwTable>
  </soap12:Body>
</soap12:Envelope>

EXAMPLE RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SelectRowsFromDwTableResponse xmlns="http://ws.euromsg.com/datawarehouse">
      <SelectRowsFromDwTableResult />
      <DemograficData>
        <ArrayOfEmKeyValue>
          <EmKeyValue>
            <Key>string</Key>
            <Value>string</Value>
          </EmKeyValue>
          <EmKeyValue>
            <Key>string</Key>
            <Value>string</Value>
          </EmKeyValue>
        </ArrayOfEmKeyValue>
        <ArrayOfEmKeyValue>
          <EmKeyValue>
            <Key>string</Key>
            <Value>string</Value>
          </EmKeyValue>
          <EmKeyValue>
            <Key>string</Key>
            <Value>string</Value>
          </EmKeyValue>
        </ArrayOfEmKeyValue>
      </DemograficData>
    </SelectRowsFromDwTableResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the <CODE> parameter will return 00 as a response.

Error Parameters

Code	Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	Member does not exist in the system.

UploadDatawarehouseFile

Back To Top ^

`<UploadDatawarehouseFile>`
Uploads Data Warehouse file as byte array.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
FileName	Name of file which is used for saving file.	MANDATORY
FileContent	File content, should be converted to byte array.	MANDATORY
FileExtensionType	File is saved with this extension code. System allows three extensions: use 1 for .txt use 2 for .zip use 3 for .csv	MANDATORY

EXAMPLE REQUEST

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UploadDataWarehouseFile xmlns="http://ws.euromsg.com/datawarehouse">
      <serviceTicket>string</serviceTicket>
      <request>
        <FileName>string</FileName>
        <FileContent>base64Binary</FileContent>
        <FileExtensionType>int</FileExtensionType>
      </request>
    </UploadDataWarehouseFile>
  </soap12:Body>
</soap12:Envelope>

EXAMPLE RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UploadDataWarehouseFileResponse xmlns="http://ws.euromsg.com/datawarehouse">
      <UploadDataWarehouseFileResult />
    </UploadDataWarehouseFileResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the <CODE> parameter will return 00 as a response.

Error Parameters

Code	Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	Member does not exist in the system.

QueryMemberDatawarehouse

Back To Top ^

`<QueryMemberDatawarehouse>`
Selects data from the Data Warehouse table by the reference column.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
DwTableName	The name of the desired DW Table	MANDATORY
KeyColumn	EMAIL, MEMBER_ID or a field name of your defined in RMC account management panel.	MANDATORY
Values	Values of the field name specified in the `Key` field	MANDATORY
PageNumber	Total number of page to be displayed
PageSize	Total number of data to be displayed

EXAMPLE REQUEST

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryMemberDatawarehouse xmlns="http://ws.euromsg.com/datawarehouse">
      <ServiceTicket>string</ServiceTicket>
      <DwTableName>string</DwTableName>
      <KeyColumn>string</KeyColumn>
      <Values>
        <string>string</string>
        <string>string</string>
      </Values>
      <PageNumber>int</PageNumber>
      <PageSize>int</PageSize>
    </QueryMemberDatawarehouse>
  </soap12:Body>
</soap12:Envelope>

EXAMPLE RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryMemberDatawarehouseResponse xmlns="http://ws.euromsg.com/datawarehouse">
      <QueryMemberDatawarehouseResult />
      <dtable>
        <Rows>
          <ArrayOfDataWarehouseRow>
            <DataWarehouseRow xsi:nil="true" />
            <DataWarehouseRow xsi:nil="true" />
          </ArrayOfDataWarehouseRow>
          <ArrayOfDataWarehouseRow>
            <DataWarehouseRow xsi:nil="true" />
            <DataWarehouseRow xsi:nil="true" />
          </ArrayOfDataWarehouseRow>
        </Rows>
        <TotalCount>int</TotalCount>
      </dtable>
    </QueryMemberDatawarehouseResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the <CODE> parameter will return 00 as a response.

Error Parameters

Code	Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	Member does not exist in the system.

GetFLTableColumns

Back To Top ^

`<GetFLTableColumns>`
Gets Data Warehouse column by table name.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
DwTableName	The name of the desired DW Table	MANDATORY

EXAMPLE REQUEST

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetFLTableColumns xmlns="http://ws.euromsg.com/datawarehouse">
      <ServiceTicket>string</ServiceTicket>
      <DwTableName>string</DwTableName>
    </GetFLTableColumns>
  </soap12:Body>
</soap12:Envelope>

EXAMPLE RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetFLTableColumnsResponse xmlns="http://ws.euromsg.com/datawarehouse">
      <GetFLTableColumnsResult />
      <columns>
        <DatawarehouseColumn>
          <ColumnName>string</ColumnName>
          <ColumnType>Alphanumeric or Combo or Date or Integer</ColumnType>
          <Visible>boolean</Visible>
          <Required>boolean</Required>
          <ColumnTypeDetail>string</ColumnTypeDetail>
        </DatawarehouseColumn>
        <DatawarehouseColumn>
          <ColumnName>string</ColumnName>
          <ColumnType>Alphanumeric or Combo or Date or Integer</ColumnType>
          <Visible>boolean</Visible>
          <Required>boolean</Required>
          <ColumnTypeDetail>string</ColumnTypeDetail>
        </DatawarehouseColumn>
      </columns>
    </GetFLTableColumnsResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the <CODE> parameter will return 00 as a response.

Error Parameters

Code	Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	Member does not exist in the system.

UpdateDwTableExpireDate

Back To Top ^

`<UpdateDwTableExpireDate>`
Updates Data Warehouse table expiration date.

Parameters

Parameter	Value
ServiceTicket	`ServiceTicket` obtained through `Login`	MANDATORY
DwTableName	The name of the desired DW Table	MANDATORY
newDate	Expiration date	MANDATORY

EXAMPLE REQUEST

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UpdateDwTableExpireDate xmlns="http://ws.euromsg.com/datawarehouse">
      <ServiceTicket>string</ServiceTicket>
      <DwTableName>string</DwTableName>
      <newDate>dateTime</newDate>
    </UpdateDwTableExpireDate>
  </soap12:Body>
</soap12:Envelope>

EXAMPLE RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UpdateDwTableExpireDateResponse xmlns="http://ws.euromsg.com/datawarehouse">
      <UpdateDwTableExpireDateResult />
      <currentDate>dateTime</currentDate>
    </UpdateDwTableExpireDateResponse>
  </soap12:Body>
</soap12:Envelope>

If the request was successful, the <CODE> parameter will return 00 as a response.

Error Parameters

Code	Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such member!	Member does not exist in the system.

Parent Topic: SOAP Web Service