GET api/HelpText/{accountId}/{companyId}/{key}

Request Information

URI Parameters

Name	Type	Additional information
accountId	integer	Required
companyId	string	Required
key	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of HelpText

Name	Type	Additional information
Key	string	None.
AccountId	integer	None.
CompanyId	string	None.
CultureCode	string	None.
Text	string	None.
Description	string	None.
Module	string	None.
IsActive	boolean	None.
CreatedOn	date	None.
CreatedBy	string	None.
UpdatedOn	date	None.
UpdatedBy	string	None.
IsLockedForEditing	boolean	None.
LockedBy	string	None.
Id	integer	None.
FieldPermissions	Collection of DTOFieldPermission	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Key": "sample string 1",
    "AccountId": 1,
    "CompanyId": "sample string 2",
    "CultureCode": "sample string 3",
    "Text": "sample string 4",
    "Description": "sample string 5",
    "Module": "sample string 6",
    "IsActive": true,
    "CreatedOn": "2025-12-16T20:11:42.40488+00:00",
    "CreatedBy": "sample string 8",
    "UpdatedOn": "2025-12-16T20:11:42.40488+00:00",
    "UpdatedBy": "sample string 9",
    "IsLockedForEditing": true,
    "LockedBy": "sample string 11",
    "Id": 12,
    "FieldPermissions": []
  },
  {
    "Key": "sample string 1",
    "AccountId": 1,
    "CompanyId": "sample string 2",
    "CultureCode": "sample string 3",
    "Text": "sample string 4",
    "Description": "sample string 5",
    "Module": "sample string 6",
    "IsActive": true,
    "CreatedOn": "2025-12-16T20:11:42.40488+00:00",
    "CreatedBy": "sample string 8",
    "UpdatedOn": "2025-12-16T20:11:42.40488+00:00",
    "UpdatedBy": "sample string 9",
    "IsLockedForEditing": true,
    "LockedBy": "sample string 11",
    "Id": 12,
    "FieldPermissions": []
  }
]

application/xml, text/xml

Sample:

<ArrayOfHelpText xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.SAI.CMS">
  <HelpText>
    <Id xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">12</Id>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 8</CreatedBy>
    <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T20:11:42.40488+00:00</CreatedOn>
    <IsLockedForEditing xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">true</IsLockedForEditing>
    <LockedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 11</LockedBy>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 9</UpdatedBy>
    <UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T20:11:42.40488+00:00</UpdatedOn>
    <AccountId>1</AccountId>
    <CompanyId>sample string 2</CompanyId>
    <CultureCode>sample string 3</CultureCode>
    <Description>sample string 5</Description>
    <IsActive>true</IsActive>
    <Key>sample string 1</Key>
    <Module>sample string 6</Module>
    <Text>sample string 4</Text>
  </HelpText>
  <HelpText>
    <Id xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">12</Id>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 8</CreatedBy>
    <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T20:11:42.40488+00:00</CreatedOn>
    <IsLockedForEditing xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">true</IsLockedForEditing>
    <LockedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 11</LockedBy>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 9</UpdatedBy>
    <UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T20:11:42.40488+00:00</UpdatedOn>
    <AccountId>1</AccountId>
    <CompanyId>sample string 2</CompanyId>
    <CultureCode>sample string 3</CultureCode>
    <Description>sample string 5</Description>
    <IsActive>true</IsActive>
    <Key>sample string 1</Key>
    <Module>sample string 6</Module>
    <Text>sample string 4</Text>
  </HelpText>
</ArrayOfHelpText>