GET Utility/GetDbIdExists?userKey={userKey}&dbId={dbId}

Used as a validation check for the API that the DBID exists in the API Connections database

Request Information

URI Parameters

Name	Description	Type	Additional Information
userKey	The secrete key to allow this check to be performed	string	Required
dbId	The DBID to check	string	Required

Body Parameters

Response Information

Resource Description

Used as a validation check for the API that the DBID exists in the API Connections database

AgvUtilityDbStatistics

Name	Description	Type
Status	0 - Success; 1 - An error occurred; 2 - An error occurred; 3 - Descriptive message, process was successful	string
Message	Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know	string
Count	Number of results returned	string
Data	List of properties and values returned for each API connected database and the table information that matches the request	Collection of ClsResponse

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "Data": [
    {
      "Tables": [
        {
          "Name": "sample string 1",
          "Count": 2,
          "TableErrorMessage": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Count": 2,
          "TableErrorMessage": "sample string 3"
        }
      ],
      "DbId": "sample string 2",
      "CompanyNameFromApiSetup": "sample string 3",
      "DbNameOnSqlServer": "sample string 4",
      "ValidConnectionMade": true,
      "AgvanceDbVersion": "sample string 6"
    },
    {
      "Tables": [
        {
          "Name": "sample string 1",
          "Count": 2,
          "TableErrorMessage": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Count": 2,
          "TableErrorMessage": "sample string 3"
        }
      ],
      "DbId": "sample string 2",
      "CompanyNameFromApiSetup": "sample string 3",
      "DbNameOnSqlServer": "sample string 4",
      "ValidConnectionMade": true,
      "AgvanceDbVersion": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvUtilityDbStatistics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Utility">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.API">
    <d2p1:ClsDbStatistics.ClsResponse>
      <d2p1:AgvanceDbVersion>sample string 6</d2p1:AgvanceDbVersion>
      <d2p1:CompanyNameFromApiSetup>sample string 3</d2p1:CompanyNameFromApiSetup>
      <d2p1:DbId>sample string 2</d2p1:DbId>
      <d2p1:DbNameOnSqlServer>sample string 4</d2p1:DbNameOnSqlServer>
      <d2p1:Tables>
        <d2p1:ClsDbStatistics.ClsResponseTableObject>
          <d2p1:Count>2</d2p1:Count>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:TableErrorMessage>sample string 3</d2p1:TableErrorMessage>
        </d2p1:ClsDbStatistics.ClsResponseTableObject>
        <d2p1:ClsDbStatistics.ClsResponseTableObject>
          <d2p1:Count>2</d2p1:Count>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:TableErrorMessage>sample string 3</d2p1:TableErrorMessage>
        </d2p1:ClsDbStatistics.ClsResponseTableObject>
      </d2p1:Tables>
      <d2p1:ValidConnectionMade>true</d2p1:ValidConnectionMade>
    </d2p1:ClsDbStatistics.ClsResponse>
    <d2p1:ClsDbStatistics.ClsResponse>
      <d2p1:AgvanceDbVersion>sample string 6</d2p1:AgvanceDbVersion>
      <d2p1:CompanyNameFromApiSetup>sample string 3</d2p1:CompanyNameFromApiSetup>
      <d2p1:DbId>sample string 2</d2p1:DbId>
      <d2p1:DbNameOnSqlServer>sample string 4</d2p1:DbNameOnSqlServer>
      <d2p1:Tables>
        <d2p1:ClsDbStatistics.ClsResponseTableObject>
          <d2p1:Count>2</d2p1:Count>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:TableErrorMessage>sample string 3</d2p1:TableErrorMessage>
        </d2p1:ClsDbStatistics.ClsResponseTableObject>
        <d2p1:ClsDbStatistics.ClsResponseTableObject>
          <d2p1:Count>2</d2p1:Count>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:TableErrorMessage>sample string 3</d2p1:TableErrorMessage>
        </d2p1:ClsDbStatistics.ClsResponseTableObject>
      </d2p1:Tables>
      <d2p1:ValidConnectionMade>true</d2p1:ValidConnectionMade>
    </d2p1:ClsDbStatistics.ClsResponse>
  </Data>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvUtilityDbStatistics>