Method GetObjectSchema

GetObjectSchema(String, RequestSettingsContract, String)

Get the object schema of 'name' (descriptions, typing)

Declaration

ObjectSchemaResultContract GetObjectSchema(string connectionId, RequestSettingsContract requestSettings, string name)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
RequestSettingsContract	requestSettings	Request settings, e.g. Language
System.String	name	The name of the object for which the schema are to be obtained, see ObjectsEnum

Returns

Type	Description
ObjectSchemaResultContract	Returns the object schema

Examples

PUT http://YourServerName/InfoShare/Json/Invoice/GetObjectSchema

Example for get object schema (descriptions, typing).

{
   "connectionId": "b6742bb8-ef97-44ae-819b-a2fa2200908a",
   "requestSettings":
   {
        "Language": "de"
   },
   "name": "GlAccount"
}

Response:

{
   "Description":
   {
       "Culture": "de",
       "Id": "MD_GlAccounts_Name",
       "Text": "Sachkonten"
   },
   "FieldSchemes": [
       {
           "Description":
           {
               "Culture": "de",
               "Id": "MD_GlAccounts_Blocked_Name",
               "Text": "Buchungssperre"
           },
           "FieldType": "Check",
           "IsKey": false,
           "Name": "Blocked",
           "Order": 6,
           "PossibleValues": ["No", "Yes"]
       },
       {
           "Description":
           {
               "Culture": "de",
               "Id": "MD_GlAccounts_BlockedFrom_Name",
               "Text": "Buchungssperre ab"
           },
           "FieldType": "Date",
           "IsKey": false,
           "Name": "BlockedFrom",
           "Order": 7,
           "PossibleValues": null
       },
       {
           "Description":
           {
               "Culture": "de",
               "Id": "MD_GlAccounts_CompanyNumber_Name",
               "Text": "Firma"
           },
           "FieldType": "Text",
           "IsKey": true,
           "Name": "CompanyNumber",
           "Order": 0,
           "PossibleValues": null
       },
       ...
       ..
       .
   ],
   "Name": "GlAccount",
   "RequestResult":
   {
       "Error": null,
       "Messages": null,
       "Result": "Valid"
   }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Verification code is needed: Verification code not yet verified (10152)