Zum Inhalt

Locale

Overview

Description Method Endpoint
Create translation POST /hosting/api/client/{clientId}/domain/{domainId}/locale
Read all translations GET /hosting/api/client/{clientId}/domain/{domainId}/locale
Read translation GET /hosting/api/client/{clientId}/domain/{domainId}/locale/{localeName}
Update translation PUT /hosting/api/client/{clientId}/domain/{domainId}/locale/{localeName}
Remove translation DELETE /hosting/api/client/{clientId}/domain/{domainId}/locale/{localeName}

Create translation

Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/locale

Method:POST

Query:

  • {clientId}: string - The ID of a CCM19-customer account
  • {domainId}: string - The ID of a domain that exists in the client account

Payload:Locale

Response:

  • 201 - Resource successfully created
  • Locale
  • 400 - Invalid or missing properties

Read all translations

Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/locale

Method:GET

Query:

  • {clientId}: string - The ID of a CCM19-customer account
  • {domainId}: string - The ID of a domain that exists in the client account

Response:

Read translation

Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/locale/{localeName}

Method:GET

Query:

  • {clientId}: string - The ID of a CCM19-customer account
  • {domainId}: string - The ID of a domain that exists in the client account
  • {localeName}: string - The name of the resource to be handled

Response:

  • 200 - Success
  • Locale
  • 404 - Resource not found

Update translation

Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/locale/{localeName}

Method:PUT

Query:

  • {clientId}: string - The ID of a CCM19-customer account
  • {domainId}: string - The ID of a domain that exists in the client account
  • {localeName}: string - The name of the resource to be handled

Payload:Locale

Response:

  • 200 - Success
  • Locale
  • 400 - Invalid or missing properties
  • 404 - Resource not found

Remove translation

Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/locale/{localeName}

Method:DELETE

Query:

  • {clientId}: string - The ID of a CCM19-customer account
  • {domainId}: string - The ID of a domain that exists in the client account
  • {localeName}: string - The name of the resource to be handled

Response:

  • 204 - Resource successfully deleted
  • 404 - Resource not found