ApexERPHost

<back to all web services

GetSyncSchemas

Requires Authentication
Required role:SysAdmin
The following routes are available for this service:
GET/sync/schemas
GetSyncSchemasResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<ErpCompanySyncInfo>No
ErpCompanySyncInfo Parameters:
NameParameterData TypeRequiredDescription
CompanyCodeformstringNo
CompanyNameformstringNo
SyncInfoformList<SyncInfo>No
SyncInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
SourceDBConnformstringNo
SourceDBTypeformstringNo
SchemaNameformstringNo
ScopesformList<SyncScope>No
SyncScope Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TablesformList<SyncTable>No
IsTemplateformboolNo
NameTemplateformstringNo
ParamsformList<SyncParam>No
SyncTable Parameters:
NameParameterData TypeRequiredDescription
TableIDformintNo
ParamsformList<string>No
FilterClauseformstringNo
FilterColumnsformList<string>No
ProxyTableformboolNo
MergeFromTableformTableSchemaInfoNo
DtoTypeNameformstringNo
TableSchemaInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
SchemaNameformstringNo
ColumnsformList<ColumnSchemaInfo>No
IndexesformList<IndexSchemaInfo>No
ColumnSchemaInfo Parameters:
NameParameterData TypeRequiredDescription
IsPKformboolNo
DBColNameformstringNo
ColTypeformTypeNo
DBTypeformDbTypeNo
SqlDBTypeformSqlDbTypeNo
SizeformintNo
AllowNullformboolNo
NeedSizeformboolNo
AutoIncrementformboolNo
IndexSchemaInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ColumnsformList<string>No
IsUniqueformboolNo
SyncParam Parameters:
NameParameterData TypeRequiredDescription
SQLNameformstringNo
NameformstringNo
DbTypeformDbTypeNo
SizeformintNo
ValueformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sync/schemas HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSyncSchemasResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Sync">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <ErpCompanySyncInfo>
      <CompanyCode>String</CompanyCode>
      <CompanyName>String</CompanyName>
      <SyncInfo>
        <SyncInfo>
          <Name>String</Name>
          <SchemaName>String</SchemaName>
          <Scopes>
            <SyncScope>
              <IsTemplate>false</IsTemplate>
              <Name>String</Name>
              <NameTemplate>String</NameTemplate>
              <Params>
                <SyncParam>
                  <DbType>AnsiString</DbType>
                  <Name>String</Name>
                  <SQLName>String</SQLName>
                  <Size>0</Size>
                  <Value>String</Value>
                </SyncParam>
              </Params>
              <Tables>
                <SyncTable>
                  <Columns>
                    <ColumnSchemaInfo>
                      <AllowNull>false</AllowNull>
                      <AutoIncrement>false</AutoIncrement>
                      <ColType xmlns:d12p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
                      <DBColName>String</DBColName>
                      <DBType>AnsiString</DBType>
                      <IsPK>false</IsPK>
                      <NeedSize>false</NeedSize>
                      <Size>0</Size>
                      <SqlDBType>BigInt</SqlDBType>
                    </ColumnSchemaInfo>
                  </Columns>
                  <Indexes>
                    <IndexSchemaInfo>
                      <Columns xmlns:d12p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                        <d12p1:string>String</d12p1:string>
                      </Columns>
                      <IsUnique>false</IsUnique>
                      <Name>String</Name>
                    </IndexSchemaInfo>
                  </Indexes>
                  <Name>String</Name>
                  <SchemaName>String</SchemaName>
                  <DtoTypeName>String</DtoTypeName>
                  <FilterClause>String</FilterClause>
                  <FilterColumns xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>String</d10p1:string>
                  </FilterColumns>
                  <MergeFromTable>
                    <Columns>
                      <ColumnSchemaInfo>
                        <AllowNull>false</AllowNull>
                        <AutoIncrement>false</AutoIncrement>
                        <ColType xmlns:d13p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
                        <DBColName>String</DBColName>
                        <DBType>AnsiString</DBType>
                        <IsPK>false</IsPK>
                        <NeedSize>false</NeedSize>
                        <Size>0</Size>
                        <SqlDBType>BigInt</SqlDBType>
                      </ColumnSchemaInfo>
                    </Columns>
                    <Indexes>
                      <IndexSchemaInfo>
                        <Columns xmlns:d13p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                          <d13p1:string>String</d13p1:string>
                        </Columns>
                        <IsUnique>false</IsUnique>
                        <Name>String</Name>
                      </IndexSchemaInfo>
                    </Indexes>
                    <Name>String</Name>
                    <SchemaName>String</SchemaName>
                  </MergeFromTable>
                  <Params xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>String</d10p1:string>
                  </Params>
                  <ProxyTable>false</ProxyTable>
                  <TableID>0</TableID>
                </SyncTable>
              </Tables>
            </SyncScope>
          </Scopes>
          <SourceDBConn>String</SourceDBConn>
          <SourceDBType>String</SourceDBType>
        </SyncInfo>
      </SyncInfo>
    </ErpCompanySyncInfo>
  </Result>
</GetSyncSchemasResponse>