GET UIElementCompany/{CompanyId}/{ApplicationTypeCodeId}/{DeviceTypeCodeId}/{UIElementCompanyVersion}

Get list of UIElementCompany that needs to be updated

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyId

Company Id. 0 means get the list for all companies

integer

Required

ApplicationTypeCodeId

1: Client, 2: Provider, 3: ManagementTool, 99: Other

integer

Required

DeviceTypeCodeId

1 iPhone, 2 Android, 5 Web

integer

Required

UIElementCompanyVersion

Current version of the UI obtained from the server. If set as 0, the server will return the complete list of UI element

integer

Required

Body Parameters

None.

Response Information

Resource Description

ResultUIElementCompany
NameDescriptionTypeAdditional information
UIElementCompanyVersion

integer

None.

ItemList

Collection of ResultUIElementCompanyItem

None.

Response Formats

application/json, text/json

Sample:
{
  "UIElementCompanyVersion": 1,
  "ItemList": [
    {
      "CompanyId": 1,
      "SystemLanguageId": 2,
      "SystemLanguageCode": "sample string 3",
      "ElementKey": "sample string 4",
      "ElementValue": "sample string 5",
      "CompanyCode": "sample string 6"
    },
    {
      "CompanyId": 1,
      "SystemLanguageId": 2,
      "SystemLanguageCode": "sample string 3",
      "ElementKey": "sample string 4",
      "ElementValue": "sample string 5",
      "CompanyCode": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<ResultUIElementCompany xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <ItemList>
    <ResultUIElementCompanyItem>
      <CompanyCode>sample string 6</CompanyCode>
      <CompanyId>1</CompanyId>
      <ElementKey>sample string 4</ElementKey>
      <ElementValue>sample string 5</ElementValue>
      <SystemLanguageCode>sample string 3</SystemLanguageCode>
      <SystemLanguageId>2</SystemLanguageId>
    </ResultUIElementCompanyItem>
    <ResultUIElementCompanyItem>
      <CompanyCode>sample string 6</CompanyCode>
      <CompanyId>1</CompanyId>
      <ElementKey>sample string 4</ElementKey>
      <ElementValue>sample string 5</ElementValue>
      <SystemLanguageCode>sample string 3</SystemLanguageCode>
      <SystemLanguageId>2</SystemLanguageId>
    </ResultUIElementCompanyItem>
  </ItemList>
  <UIElementCompanyVersion>1</UIElementCompanyVersion>
</ResultUIElementCompany>