GET api/System?sessionId={sessionId}

Gets all systems

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of APISystem
NameDescriptionTypeAdditional information
PlatformName

Name of platform which hosts system

string

None.

Id

Unique identifier

integer

None.

Name

Textual identifier

string

None.

DisplayName

Name as displayed

string

None.

LanguageName

System's language name

string

None.

TimezoneId

Unique identifier of timezone to which this relates

integer

None.

TimezoneName

Long textual identifier of timezone to which this relates

string

None.

TimezoneShortName

Short textual identifier of timezone to which this relates

string

None.

TimezoneGeographicalName

Geographical name of timezone to which this relates

string

None.

TimezoneWindowsRegistryKey

Windows registry key of timezone to which this relates

string

None.

TimezoneDescription

Description of timezone to which this relates

string

None.

Currency

System's currency: GBP, USD, EUR, INR or TRY

string

None.

VATId

Unique identifier of VAT rate to which this relates

integer

None.

VATCode

Textual identifier of VAT rate to which this relates

string

None.

VATRate

VAT rate to which this relates

decimal number

None.

VATDescription

Description of VAT rate to which this relates

string

None.

State

Status: Active, Closed or Suspended

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "platformName": "sample string 1",
    "id": 2,
    "name": "sample string 3",
    "displayName": "sample string 4",
    "languageName": "sample string 5",
    "timezoneId": 1,
    "timezoneName": "sample string 6",
    "timezoneShortName": "sample string 7",
    "timezoneGeographicalName": "sample string 8",
    "timezoneWindowsRegistryKey": "sample string 9",
    "timezoneDescription": "sample string 10",
    "currency": "sample string 11",
    "vatId": 12,
    "vatCode": "sample string 13",
    "vatRate": 1.1,
    "vatDescription": "sample string 14",
    "state": "sample string 15"
  },
  {
    "platformName": "sample string 1",
    "id": 2,
    "name": "sample string 3",
    "displayName": "sample string 4",
    "languageName": "sample string 5",
    "timezoneId": 1,
    "timezoneName": "sample string 6",
    "timezoneShortName": "sample string 7",
    "timezoneGeographicalName": "sample string 8",
    "timezoneWindowsRegistryKey": "sample string 9",
    "timezoneDescription": "sample string 10",
    "currency": "sample string 11",
    "vatId": 12,
    "vatCode": "sample string 13",
    "vatRate": 1.1,
    "vatDescription": "sample string 14",
    "state": "sample string 15"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPISystem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APISystem>
    <Currency>sample string 11</Currency>
    <DisplayName>sample string 4</DisplayName>
    <Id>2</Id>
    <LanguageName>sample string 5</LanguageName>
    <Name>sample string 3</Name>
    <PlatformName>sample string 1</PlatformName>
    <State>sample string 15</State>
    <TimezoneDescription>sample string 10</TimezoneDescription>
    <TimezoneGeographicalName>sample string 8</TimezoneGeographicalName>
    <TimezoneId>1</TimezoneId>
    <TimezoneName>sample string 6</TimezoneName>
    <TimezoneShortName>sample string 7</TimezoneShortName>
    <TimezoneWindowsRegistryKey>sample string 9</TimezoneWindowsRegistryKey>
    <VATCode>sample string 13</VATCode>
    <VATDescription>sample string 14</VATDescription>
    <VATId>12</VATId>
    <VATRate>1.1</VATRate>
  </APISystem>
  <APISystem>
    <Currency>sample string 11</Currency>
    <DisplayName>sample string 4</DisplayName>
    <Id>2</Id>
    <LanguageName>sample string 5</LanguageName>
    <Name>sample string 3</Name>
    <PlatformName>sample string 1</PlatformName>
    <State>sample string 15</State>
    <TimezoneDescription>sample string 10</TimezoneDescription>
    <TimezoneGeographicalName>sample string 8</TimezoneGeographicalName>
    <TimezoneId>1</TimezoneId>
    <TimezoneName>sample string 6</TimezoneName>
    <TimezoneShortName>sample string 7</TimezoneShortName>
    <TimezoneWindowsRegistryKey>sample string 9</TimezoneWindowsRegistryKey>
    <VATCode>sample string 13</VATCode>
    <VATDescription>sample string 14</VATDescription>
    <VATId>12</VATId>
    <VATRate>1.1</VATRate>
  </APISystem>
</ArrayOfAPISystem>