AddCustomTable


 

Overview

Quick Links

Adds a Custom Table to the system.


Resource Information



Request FormatXML
Response FormatXML

Request Header

NameTypeDescription
StringStringAuthentication Token

Request Body

NameTypeDescription
ColumnsList of TableColumnDefinitionContains a definition for each column in the Table.
IdStringUnique Id of the Table.
NameStringThe name of the Table.
TTLColumnStringSpecify the name of the column that has a specific time to live.
TTLLenghtIntegerThe time to live specified in seconds. Maximum value of 31536000 (365 days).

Response

NameTypeDescription
ResultTableReturns the table as specified in the Request Body
ResultCodeStringString indicating the result. Either "Success" or "Error".
ResultMessageStringEmpty when call successful, error message otherwise.

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

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">api.billing.inter8.V1_3_2/IAPIServiceEndpoint/AddCustomTable</Action>
  <String xmlns="System">eb46c3ab-02a2-4d67-a314-b6f404cb2aa1</String>
 </s:Header>
 <s:Body>
  <AddCustomTable xmlns="api.billing.inter8.V1_3_2">
   <table xmlns:d4p1="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_3_2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <d4p1:Columns>
     <d4p1:TableColumnDefinition>
      <d4p1:ColumnName>C1</d4p1:ColumnName>
      <d4p1:ColumnType>String</d4p1:ColumnType>
      <d4p1:IndexNames xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
       <d7p1:string>C1_Index</d7p1:string>
      </d4p1:IndexNames>
      <d4p1:LongName>Column1</d4p1:LongName>
     </d4p1:TableColumnDefinition>
     <d4p1:TableColumnDefinition>
      <d4p1:ColumnName>C2</d4p1:ColumnName>
      <d4p1:ColumnType>Date</d4p1:ColumnType>
      <d4p1:IndexNames xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
       <d7p1:string>C2_Index</d7p1:string>
      </d4p1:IndexNames>
      <d4p1:LongName>Column2</d4p1:LongName>
     </d4p1:TableColumnDefinition>
     <d4p1:TableColumnDefinition>
      <d4p1:ColumnName>C3</d4p1:ColumnName>
      <d4p1:ColumnType>Numeric</d4p1:ColumnType>
      <d4p1:IndexNames xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
       <d7p1:string>C3_Index</d7p1:string>
      </d4p1:IndexNames>
      <d4p1:LongName>Column3</d4p1:LongName>
     </d4p1:TableColumnDefinition>
    </d4p1:Columns>
    <d4p1:Id i:nil="true" />
    <d4p1:Name>CustomTable</d4p1:Name>
    <d4p1:TTLColumn>C2</d4p1:TTLColumn>
    <d4p1:TTLLength>360000</d4p1:TTLLength>
   </table>
  </AddCustomTable>
 </s:Body>
</s:Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
 <s:Body>
  <AddCustomTableResponse xmlns="api.billing.inter8.V1_3_2">
   <AddCustomTableResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_3_2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <a:Result i:nil="true"/>
    <a:ResultCode>Error</a:ResultCode>
    <a:ResultMessage>Command createIndexes failed: Index: { v: 2, key: { C2: 1 }, name: "ixttl_C2", ns: "Sandbox.ct_CustomTable", expireAfterSeconds: 360000.0 } already exists with different options: { v: 2, key: { C2: 1 }, name: "ix_C2_Index", ns: "Sandbox.ct_CustomTable" }.</a:ResultMessage>
   </AddCustomTableResult>
  </AddCustomTableResponse>
 </s:Body>
</s:Envelope>