POST api/Translation/RetrieveTranslations

Retrieves a list of translations.

Request Information

Parameters

NameDescriptionAdditional information
req 

                
                            
Define this parameter in the request body.

                		
            

    

            
Request body formats




        
application/json, text/json

        

            Sample:

{
  "LanguageCode": "sample string 1",
  "TranslationLanguageCode": "sample string 2",
  "KeyNameCSV": "sample string 3",
  "SecurableID": "sample string 4",
  "NeedTranslated": 5,
  "Token": "sample string 6",
  "FreeText": "sample string 7",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 8,
  "ToIndex": 9,
  "IsWebCalling": true,
  "RequestMode": "sample string 11",
  "Client": "sample string 12",
  "AppVersion": "sample string 13",
  "AppOperatingSystem": "sample string 14",
  "AppName": "sample string 15",
  "MasterUserID": 16,
  "IsRecurringRequest": true
}


        

        
text/html

        

            Sample:

{"LanguageCode":"sample string 1","TranslationLanguageCode":"sample string 2","KeyNameCSV":"sample string 3","SecurableID":"sample string 4","NeedTranslated":5,"Token":"sample string 6","FreeText":"sample string 7","GroupIds":[1,2,3],"FromIndex":8,"ToIndex":9,"IsWebCalling":true,"RequestMode":"sample string 11","Client":"sample string 12","AppVersion":"sample string 13","AppOperatingSystem":"sample string 14","AppName":"sample string 15","MasterUserID":16,"IsRecurringRequest":true}


        

        
application/xml, text/xml

        

            Sample:

<APITranslationLiteralsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.APIModels">
  <AppName xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 15</AppName>
  <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 14</AppOperatingSystem>
  <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 13</AppVersion>
  <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 12</Client>
  <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 7</FreeText>
  <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">8</FromIndex>
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </GroupIds>
  <IsRecurringRequest xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsRecurringRequest>
  <IsWebCalling xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsWebCalling>
  <MasterUserID xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">16</MasterUserID>
  <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 11</RequestMode>
  <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">9</ToIndex>
  <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 6</Token>
  <KeyNameCSV>sample string 3</KeyNameCSV>
  <LanguageCode>sample string 1</LanguageCode>
  <NeedTranslated>5</NeedTranslated>
  <SecurableID>sample string 4</SecurableID>
  <TranslationLanguageCode>sample string 2</TranslationLanguageCode>
</APITranslationLiteralsRequest>


        

        
application/x-www-form-urlencoded

        

            Sample:
    
Sample not available.


        



        
Response Information

            

        
Response body formats




        
application/json, text/json

        

            Sample:

{
  "LastTranslationUpdatedOn": "2024-10-16T17:17:36.6325947+02:00",
  "TranslationDataList": [
    {
      "KeyName": "sample string 1",
      "EnglishValue": "sample string 2",
      "Value": "sample string 3",
      "LanguageCode": "sample string 4",
      "DesireLanguageValue": "sample string 5",
      "LastUpdatedOn": "2024-10-16T17:17:36.6335728+02:00"
    },
    {
      "KeyName": "sample string 1",
      "EnglishValue": "sample string 2",
      "Value": "sample string 3",
      "LanguageCode": "sample string 4",
      "DesireLanguageValue": "sample string 5",
      "LastUpdatedOn": "2024-10-16T17:17:36.6335728+02:00"
    },
    {
      "KeyName": "sample string 1",
      "EnglishValue": "sample string 2",
      "Value": "sample string 3",
      "LanguageCode": "sample string 4",
      "DesireLanguageValue": "sample string 5",
      "LastUpdatedOn": "2024-10-16T17:17:36.6335728+02:00"
    }
  ],
  "Success": true,
  "ErrorMessage": "sample string 2",
  "MenuAccessData": {
    "HasAccessToMap": true,
    "HasAccessToVehicle": true,
    "HasAccessToVehicleAdministration": true,
    "HasAccessToDriver": true,
    "HasAccessToPOI": true,
    "HasAccessToReports": true,
    "HasAccessToSettings": true,
    "HasAccessToTrips": true,
    "HasAccessToTranslations": true,
    "HasAccessToDashboard": true,
    "HasAccessToLogBook": true,
    "HasAccessToGroup": true,
    "HasAccessToTemplate": true,
    "HasAccessToUnit": true,
    "HasAccessToUser": true,
    "HasAccessToTicket": true,
    "HasAccessToContract": true,
    "HasAccessToSIM": true,
    "HasAccessToCommand": true,
    "HasAccessToUnitProfile": true,
    "HasAccessToProfileTrigger": true,
    "HasAccessToScript": true,
    "HasAccessToTriggerSchedule": true
  },
  "StatusCode": 3,
  "ComponentFilterIds": [
    1,
    2,
    3
  ]
}


        

        
text/html

        

            Sample:

{"LastTranslationUpdatedOn":"2024-10-16T17:17:36.6325947+02:00","TranslationDataList":[{"KeyName":"sample string 1","EnglishValue":"sample string 2","Value":"sample string 3","LanguageCode":"sample string 4","DesireLanguageValue":"sample string 5","LastUpdatedOn":"2024-10-16T17:17:36.6335728+02:00"},{"KeyName":"sample string 1","EnglishValue":"sample string 2","Value":"sample string 3","LanguageCode":"sample string 4","DesireLanguageValue":"sample string 5","LastUpdatedOn":"2024-10-16T17:17:36.6335728+02:00"},{"KeyName":"sample string 1","EnglishValue":"sample string 2","Value":"sample string 3","LanguageCode":"sample string 4","DesireLanguageValue":"sample string 5","LastUpdatedOn":"2024-10-16T17:17:36.6335728+02:00"}],"Success":true,"ErrorMessage":"sample string 2","MenuAccessData":{"HasAccessToMap":true,"HasAccessToVehicle":true,"HasAccessToVehicleAdministration":true,"HasAccessToDriver":true,"HasAccessToPOI":true,"HasAccessToReports":true,"HasAccessToSettings":true,"HasAccessToTrips":true,"HasAccessToTranslations":true,"HasAccessToDashboard":true,"HasAccessToLogBook":true,"HasAccessToGroup":true,"HasAccessToTemplate":true,"HasAccessToUnit":true,"HasAccessToUser":true,"HasAccessToTicket":true,"HasAccessToContract":true,"HasAccessToSIM":true,"HasAccessToCommand":true,"HasAccessToUnitProfile":true,"HasAccessToProfileTrigger":true,"HasAccessToScript":true,"HasAccessToTriggerSchedule":true},"StatusCode":3,"ComponentFilterIds":[1,2,3]}


        

        
application/xml, text/xml

        

            Sample:

<APITranslationLiteralsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.APIModels">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.Transport">Success</ResponseCode>
  <ComponentFilterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ComponentFilterIds>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 2</ErrorMessage>
  <MenuAccessData xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <HasAccessToCommand>true</HasAccessToCommand>
    <HasAccessToContract>true</HasAccessToContract>
    <HasAccessToDashboard>true</HasAccessToDashboard>
    <HasAccessToDriver>true</HasAccessToDriver>
    <HasAccessToGroup>true</HasAccessToGroup>
    <HasAccessToLogBook>true</HasAccessToLogBook>
    <HasAccessToMap>true</HasAccessToMap>
    <HasAccessToPOI>true</HasAccessToPOI>
    <HasAccessToProfileTrigger>true</HasAccessToProfileTrigger>
    <HasAccessToReports>true</HasAccessToReports>
    <HasAccessToSIM>true</HasAccessToSIM>
    <HasAccessToScript>true</HasAccessToScript>
    <HasAccessToSettings>true</HasAccessToSettings>
    <HasAccessToTemplate>true</HasAccessToTemplate>
    <HasAccessToTicket>true</HasAccessToTicket>
    <HasAccessToTranslations>true</HasAccessToTranslations>
    <HasAccessToTriggerSchedule>true</HasAccessToTriggerSchedule>
    <HasAccessToTrips>true</HasAccessToTrips>
    <HasAccessToUnit>true</HasAccessToUnit>
    <HasAccessToUnitProfile>true</HasAccessToUnitProfile>
    <HasAccessToUser>true</HasAccessToUser>
    <HasAccessToVehicle>true</HasAccessToVehicle>
    <HasAccessToVehicleAdministration>true</HasAccessToVehicleAdministration>
  </MenuAccessData>
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">3</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</Success>
  <LastTranslationUpdatedOn>2024-10-16T17:17:36.6325947+02:00</LastTranslationUpdatedOn>
  <TranslationDataList>
    <APITranslationLiteralData>
      <DesireLanguageValue>sample string 5</DesireLanguageValue>
      <EnglishValue>sample string 2</EnglishValue>
      <KeyName>sample string 1</KeyName>
      <LanguageCode>sample string 4</LanguageCode>
      <LastUpdatedOn>2024-10-16T17:17:36.6335728+02:00</LastUpdatedOn>
      <Value>sample string 3</Value>
    </APITranslationLiteralData>
    <APITranslationLiteralData>
      <DesireLanguageValue>sample string 5</DesireLanguageValue>
      <EnglishValue>sample string 2</EnglishValue>
      <KeyName>sample string 1</KeyName>
      <LanguageCode>sample string 4</LanguageCode>
      <LastUpdatedOn>2024-10-16T17:17:36.6335728+02:00</LastUpdatedOn>
      <Value>sample string 3</Value>
    </APITranslationLiteralData>
    <APITranslationLiteralData>
      <DesireLanguageValue>sample string 5</DesireLanguageValue>
      <EnglishValue>sample string 2</EnglishValue>
      <KeyName>sample string 1</KeyName>
      <LanguageCode>sample string 4</LanguageCode>
      <LastUpdatedOn>2024-10-16T17:17:36.6335728+02:00</LastUpdatedOn>
      <Value>sample string 3</Value>
    </APITranslationLiteralData>
  </TranslationDataList>
</APITranslationLiteralsResponse>