Show / Hide Table of Contents

Subscriptions info

The purpose of this endpoint is to enable retrieving information about subscriptions. The call has to be made in the context of an account.

Get all active language pairs from all active subscriptions

This call should be used to retrieve information about all active language pairs from all active subscriptions of the specified account. You need to provide your account id.

Linux

curl -XGET -H 'Authorization: Bearer asd0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsI' -H 'Trace-ID: 2c0c4dda-8333-4538-983e-e098de7cf555' \
'https://api.languageweaver.com/v4/accounts/12/subscriptions/language-pairs'
Windows

curl -XGET -H "Authorization: Bearer asd0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsI" -H "Trace-ID: 2c0c4dda-8333-4538-983e-e098de7cf555" ^
https://api.languageweaver.com/v4/accounts/12/subscriptions/language-pairs

Access token type
User credentials - Allowed User Roles: Admin, Linguist, Translator
API credentials

HTTP Request
GET /v4/accounts/{accountId}/subscriptions/language-pairs

Headers

Name Value (example) Description
Authorization Bearer asd0eXAi... Bearer token
Trace-ID 2c0c4dda-8333-4538-983e-e098de7cf555 Optional unique request identifier (UUID) provided by client

Response JSON:


{
  "accountId": 2,
  "endDate": "2025/05/18",
  "languagePairs": [
    {
        "name": "engita_generic",
        "active": "yes",
        "displayName": "Generic",
        "sourceLanguageId": "eng",
        "targetLanguageId": "ita",
        "model": "generic",
        "autoAdaptiveSupport": true,
        "autoAdaptiveStatus": false,
        "adaptationSupport": true,
    },
    {
        "name": "engspa_custom",
        "active": "yes",
        "displayName": "Custom",
        "sourceLanguageId": "eng",
        "targetLanguageId": "spa",
        "model": "custom"
    },
    {
        "name": "fraeng_generic",
        "active": "yes",
        "displayName": "Generic",
        "sourceLanguageId": "fra",
        "targetLanguageId": "eng",
        "model": "generic",
        "autoAdaptiveSupport": true,
        "autoAdaptiveStatus": true,
        "adaptationSupport": true,
        "linguisticOptions": [
          {
            "id": "Spelling",
            "name": "Spelling",
            "systemDefault": "US",
            "values": [
              "UK",
              "US"
            ]
          }
        ]
    }
  ]
}

Response

Headers

Name Value (example) Description
BeGlobal-Request-ID dbbbc062-88a7-4783-8d52-dea795e517f4 Unique request identifier (UUID)
Trace-ID 2c0c4dda-8333-4538-983e-e098de7cf555 The identifier provided in the request (UUID)

Format
JSON

Name Type Description
accountId integer The account id for which subscriptions were requested
endDate string The expire date of the current subscription
languagePairs list The language pairs list
name string Language pair name
displayName string Display Name used in Language Weaver UI
sourceLanguageId string Three letters language code of the source language
targetLanguageId string Three letters language code of the target language
model string A string representing a unique identifier for the language pair combination sourceLanguageId-targetLanguageId-model. (e.g. generic)
linguisticOptions list List of linguistic options available for a specific language pair
id string Linguistic option identifier
systemDefault string System default linguistic option
values list Available values for the current linguistic option
autoAdaptiveSupport boolean Auto adaptation is supported by language pair
autoAdaptiveStatus boolean Auto adaptation is enabled for language pair
adaptationSupport boolean Manual adaptation is supported by language pair
{
    "errors": [{
        "code": 1002,
        "description": "account with id 12 does not exist"
    }]
}

Error Response

Format
JSON

Name Type Description
errors list A list with the errors that occurred
code integer The code of the error
description string The description of the error

Returned HTTP Codes:

Http Code Description
200 When all account language pairs are successfully returned
401 When the authentication process failed or the access token is not valid
403 Forbidden to access resource
500 Application internal error

Get subscription

This call should be used to retrieve information about the subscription. You need to provide the subscription id for which you want the info.

Linux

curl -XGET -H 'Authorization: Bearer asd0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsI' -H 'Trace-ID: 2c0c4dda-8333-4538-983e-e098de7cf555' \
'https://api.languageweaver.com/v4/accounts/12/subscriptions/123'
Windows

curl -XGET -H "Authorization: Bearer asd0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsI" -H "Trace-ID: 2c0c4dda-8333-4538-983e-e098de7cf555" ^
https://api.languageweaver.com/v4/accounts/12/subscriptions/123

Access token type
User credentials - Allowed User Roles: Admin, Linguist, Translator
API credentials

HTTP Request
GET /v4/accounts/{accountId}/subscriptions/{subscriptionId}

Headers

Name Value (example) Description
Authorization Bearer asd0eXAi... Bearer token
Trace-ID 2c0c4dda-8333-4538-983e-e098de7cf555 Optional unique request identifier (UUID) provided by client

Response JSON:

{
   "id": 123,
   "accountId": 12,
   "description ": "description of the subscription",
   "startDate": "2018/05/19",
   "endDate": "2019/05/18",
   "active": "yes",
   "languagePairs": [
        {
            "name": "engfra_custom",
            "active": "yes",
            "displayName": "Custom",
            "sourceLanguageId": "eng",
            "targetLanguageId": "fra",
            "model": "custom"
        },
        {
            "name": "engger_custom",
            "active": "yes",
            "displayName": "Custom",
            "sourceLanguageId": "eng",
            "targetLanguageId": "ger",
            "model": "custom"
        }
    ]
}

Response

Headers

Name Value (example) Description
BeGlobal-Request-ID dbbbc062-88a7-4783-8d52-dea795e517f4 Unique request identifier (UUID)
Trace-ID 2c0c4dda-8333-4538-983e-e098de7cf555 The identifier provided in the request (UUID)

Format
JSON

Name Type Description
id integer Unique numeric identifier for the subscription
accountId integer Unique numeric identifier for the account associated to the subscription
description string A brief description of the subscription
startDate string Start date of the subscription validity
endDate string End date of the subscription validity
active string Subscription State
languagePairs list The language pairs list
name string Language pair name
displayName string Display Name used in Language Weaver UI
sourceLanguageId string Three letters language code of the source language
targetLanguageId string Three letters language code of the target language
model string A string representing a unique identifier for the language pair combination sourceLanguageId-targetLanguageId-model. (e.g. generic)

Error JSON:

{
   "errors":[
      {
         "code":1002,
         "description":"account with id 12 does not exist"
      }
   ]
}

Error Response

Format
JSON

Name Type Description
errors list A list with the errors that occurred
code integer The code of the error
description string The description of the error

Returned HTTP Codes:

Http Code Description
200 When the subscription is returned
400 When the input data is not valid
401 When the authentication process failed or the access token is not valid
403 Forbidden to access resource
500 Application internal error

Get all subscriptions for the account

This call should be used to retrieve information about all the subscriptions of the specified account.

Linux

curl -XGET -H 'Authorization: Bearer asd0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsI' -H 'Trace-ID: 2c0c4dda-8333-4538-983e-e098de7cf555' \
'https://api.languageweaver.com/v4/accounts/{accountId}/subscriptions'
Windows

curl -XGET -H "Authorization: Bearer asd0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsI" -H "Trace-ID: 2c0c4dda-8333-4538-983e-e098de7cf555" ^
https://api.languageweaver.com/v4/accounts/{accountId}/subscriptions

Access token type
User credentials - Allowed User Roles: Admin, Linguist, Translator
API credentials

HTTP Request
GET /v4/accounts/{accountId}/subscriptions?pageNumber={pageNumber}&pageSize={pageSize}

Headers

Name Value (example) Description
Authorization Bearer asd0eXAi... Bearer token
Trace-ID 2c0c4dda-8333-4538-983e-e098de7cf555 Optional unique request identifier (UUID) provided by client

Query Parameters

Name Type Mandatory Default value Description
pageNumber int no 1 Integer specifying the requested page number
pageSize int no 10 Integer specifying the requested page size, limited to 100

Response JSON:

{
   "accountId": 12,
   "totalCount": 11,
   "pageNumber": 1,
   "pageSize": 2,
   "subscriptions": [
    {
       "id": 452,
       "accountId": 12,
       "description ": "description of the subscription",
       "startDate": "2018/05/19",
       "endDate": "2019/05/18",
       "active": "yes",
       "languagePairs": [
            {
                "name": "engfra_custom",
                "active": "yes",
                "displayName": "Custom",
                "sourceLanguageId": "eng",
                "targetLanguageId": "fra",
                "model": "custom"
            },
            {
                "name": "engger_custom",
                "active": "yes",
                "displayName": "Custom",
                "sourceLanguageId": "eng",
                "targetLanguageId": "ger",
                "model": "custom"
            }
        ]
    },
    {
       "id": 452,
       "accountId": 12,
       "description ": "description of the subscription",
       "startDate": "2018/05/19",
       "endDate": "2019/06/18",
       "active": "yes",
       "languagePairs": [
            {
                "name": "engita_generic",
                "active": "yes",
                "displayName": "Generic",
                "sourceLanguageId": "eng",
                "targetLanguageId": "ita",
                "model": "generic"
            },
            {
                "name": "engspa_custom",
                "active": "yes",
                "displayName": "Custom",
                "sourceLanguageId": "eng",
                "targetLanguageId": "spa",
                "model": "custom"
            }
          ]
        }
      ]
}

Response

Headers

Name Value (example) Description
BeGlobal-Request-ID dbbbc062-88a7-4783-8d52-dea795e517f4 Unique request identifier (UUID)
Trace-ID 2c0c4dda-8333-4538-983e-e098de7cf555 The identifier provided in the request (UUID)

Format
JSON

Name Type Description
totalCount integer Total number of subscriptions in account
pageNumber integer Requested page number
pageSize integer Requested page size
subscriptions list The list of all subscriptions associated with the given accountId
accountId integer Unique numeric identifier for the account associated to the subscriptions
id integer Unique numeric identifier for the subscription
description string A brief description of the subscription
startDate string Start date of the subscriptions validity
endDate string End date of the subscriptions validity
active string Subscription State
languagePairs list The language pairs list
name string Language pair name
displayName string Display Name used in Language Weaver UI
sourceLanguageId string Three letters language code of the source language
targetLanguageId string Three letters language code of the target language
model string A string representing a unique identifier for the language pair combination sourceLanguageId-targetLanguageId-model. (e.g. generic)

Error JSON:

{
   "errors":[
      {
         "code":1002,
         "description":"account with id 12 does not exist"
      }
   ]
}

Error Response

Format
JSON

Name Type Description
errors list A list with the errors that occurred
code integer The code of the error
description string The description of the error

Returned HTTP Codes:

Http Code Description
200 When the subscriptions were returned
400 When the input data is not valid
401 When the authentication process failed or the access token is not valid
403 Forbidden to access resource
500 Application internal error

Linguistic Options

Note

In order to use this feature you need to have it enabled on your account.

Get all Linguistic Options for a language pair

This call should be used to retrieve information about all the linguistic options of a specific language pair.

Linux

curl -XGET -H 'Authorization: Bearer asd0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsI' -H 'Trace-ID: 2c0c4dda-8333-4538-983e-e098de7cf555' \
'https://api.languageweaver.com/v4/accounts/12/subscriptions/language-pairs/engfra_generic/linguistic-options'
Windows

curl -XGET -H "Authorization: Bearer asd0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsI" -H "Trace-ID: 2c0c4dda-8333-4538-983e-e098de7cf555" ^
https://api.languageweaver.com/v4/accounts/12/subscriptions/language-pairs/engfra_generic/linguistic-options

Access token type
User credentials - Allowed User Roles: Admin, Linguist, Translator
API credentials

HTTP Request
GET /v4/accounts/{accountId}/subscriptions/language-pairs/{languagePairName}/linguistic-options

Headers

Name Value (example) Description
Authorization Bearer asd0eXAi... Bearer token
Trace-ID 2c0c4dda-8333-4538-983e-e098de7cf555 Optional unique request identifier (UUID) provided by client

Response JSON:

{
  "linguisticOptions": [
    {
      "id": "formality",
      "name": "Formality",
      "systemDefault": "Polite",
      "accountDefault": "Formal",
      "values": [
        "Formal",
        "Informal",
        "Polite"
      ]
    }
  ]
}

Response

Headers

Name Value (example) Description
BeGlobal-Request-ID dbbbc062-88a7-4783-8d52-dea795e517f4 Unique request identifier (UUID)
Trace-ID 2c0c4dda-8333-4538-983e-e098de7cf555 The identifier provided in the request (UUID)

Format
JSON

Name Type Description
linguisticOptions array List of linguistic options available for the requested language pair
id string Linguistic option identifier
name string Linguistic option name
systemDefault string System default linguistic option
accountDefault string Account default linguistic option. Field missing when there is no account default
values array Available values for the current linguistic option
{
    "errors": [{
        "code": 1002,
        "description": "account with id 12 does not exist"
    }]
}

Error Response

Format
JSON

Name Type Description
errors list A list with the errors that occurred
code integer The code of the error
description string The description of the error

Returned HTTP Codes:

Http Code Description
200 When linguistic options are successfully returned
401 When the authentication process failed or the access token is not valid
403 Forbidden to access resource
500 Application internal error
In This Page
Back to top