All URIs are relative to https://v2.namsor.com/NamSorAPIv2
Method | HTTP request | Description |
---|---|---|
chineseNameCandidates | GET /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin} | Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming |
chineseNameCandidatesBatch | POST /api2/json/chineseNameCandidatesBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming |
chineseNameCandidatesGenderBatch | POST /api2/json/chineseNameCandidatesGenderBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming. |
chineseNameGenderCandidates | GET /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender} | Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming - having a known gender ('male' or 'female') |
chineseNameMatch | GET /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName} | Return a score for matching Chinese name ex. 王晓明 with a romanized name ex. Wang Xiaoming |
chineseNameMatchBatch | POST /api2/json/chineseNameMatchBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming |
genderChineseName | GET /api2/json/genderChineseName/{chineseName} | Infer the likely gender of a Chinese full name ex. 王晓明 |
genderChineseNameBatch | POST /api2/json/genderChineseNameBatch | Infer the likely gender of up to 100 full names ex. 王晓明 |
genderChineseNamePinyin | GET /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin} | Infer the likely gender of a Chinese name in LATIN (Pinyin). |
genderChineseNamePinyinBatch | POST /api2/json/genderChineseNamePinyinBatch | Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin). |
parseChineseName | GET /api2/json/parseChineseName/{chineseName} | Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name) |
parseChineseNameBatch | POST /api2/json/parseChineseNameBatch | Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name). |
pinyinChineseName | GET /api2/json/pinyinChineseName/{chineseName} | Romanize the Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name) |
pinyinChineseNameBatch | POST /api2/json/pinyinChineseNameBatch | Romanize a list of Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name). |
RomanizedNameOut chineseNameCandidates(chineseSurnameLatin, chineseGivenNameLatin)
Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
String chineseSurnameLatin = "chineseSurnameLatin_example"; // String |
String chineseGivenNameLatin = "chineseGivenNameLatin_example"; // String |
try {
RomanizedNameOut result = apiInstance.chineseNameCandidates(chineseSurnameLatin, chineseGivenNameLatin);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#chineseNameCandidates");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
chineseSurnameLatin | String | ||
chineseGivenNameLatin | String |
- Content-Type: Not defined
- Accept: application/json
BatchNameMatchCandidatesOut chineseNameCandidatesBatch(batchFirstLastNameIn)
Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
BatchFirstLastNameIn batchFirstLastNameIn = new BatchFirstLastNameIn(); // BatchFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname
try {
BatchNameMatchCandidatesOut result = apiInstance.chineseNameCandidatesBatch(batchFirstLastNameIn);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#chineseNameCandidatesBatch");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
batchFirstLastNameIn | BatchFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname | [optional] |
- Content-Type: application/json
- Accept: application/json
BatchNameMatchCandidatesOut chineseNameCandidatesGenderBatch(batchFirstLastNameIn)
Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming.
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
BatchFirstLastNameIn batchFirstLastNameIn = new BatchFirstLastNameIn(); // BatchFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname
try {
BatchNameMatchCandidatesOut result = apiInstance.chineseNameCandidatesGenderBatch(batchFirstLastNameIn);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#chineseNameCandidatesGenderBatch");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
batchFirstLastNameIn | BatchFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname | [optional] |
- Content-Type: application/json
- Accept: application/json
RomanizedNameOut chineseNameGenderCandidates(chineseSurnameLatin, chineseGivenNameLatin, knownGender)
Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming - having a known gender ('male' or 'female')
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
String chineseSurnameLatin = "chineseSurnameLatin_example"; // String |
String chineseGivenNameLatin = "chineseGivenNameLatin_example"; // String |
String knownGender = "knownGender_example"; // String |
try {
RomanizedNameOut result = apiInstance.chineseNameGenderCandidates(chineseSurnameLatin, chineseGivenNameLatin, knownGender);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#chineseNameGenderCandidates");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
chineseSurnameLatin | String | ||
chineseGivenNameLatin | String | ||
knownGender | String |
- Content-Type: Not defined
- Accept: application/json
RomanizedNameOut chineseNameMatch(chineseSurnameLatin, chineseGivenNameLatin, chineseName)
Return a score for matching Chinese name ex. 王晓明 with a romanized name ex. Wang Xiaoming
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
String chineseSurnameLatin = "chineseSurnameLatin_example"; // String |
String chineseGivenNameLatin = "chineseGivenNameLatin_example"; // String |
String chineseName = "chineseName_example"; // String |
try {
RomanizedNameOut result = apiInstance.chineseNameMatch(chineseSurnameLatin, chineseGivenNameLatin, chineseName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#chineseNameMatch");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
chineseSurnameLatin | String | ||
chineseGivenNameLatin | String | ||
chineseName | String |
- Content-Type: Not defined
- Accept: application/json
BatchNameMatchCandidatesOut chineseNameMatchBatch(batchFirstLastNameIn)
Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
BatchFirstLastNameIn batchFirstLastNameIn = new BatchFirstLastNameIn(); // BatchFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname
try {
BatchNameMatchCandidatesOut result = apiInstance.chineseNameMatchBatch(batchFirstLastNameIn);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#chineseNameMatchBatch");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
batchFirstLastNameIn | BatchFirstLastNameIn | A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname | [optional] |
- Content-Type: application/json
- Accept: application/json
PersonalNameGenderedOut genderChineseName(chineseName)
Infer the likely gender of a Chinese full name ex. 王晓明
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
String chineseName = "chineseName_example"; // String |
try {
PersonalNameGenderedOut result = apiInstance.genderChineseName(chineseName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#genderChineseName");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
chineseName | String |
- Content-Type: Not defined
- Accept: application/json
BatchPersonalNameGenderedOut genderChineseNameBatch(batchPersonalNameIn)
Infer the likely gender of up to 100 full names ex. 王晓明
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
BatchPersonalNameIn batchPersonalNameIn = new BatchPersonalNameIn(); // BatchPersonalNameIn | A list of personal names, with a country ISO2 code
try {
BatchPersonalNameGenderedOut result = apiInstance.genderChineseNameBatch(batchPersonalNameIn);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#genderChineseNameBatch");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
batchPersonalNameIn | BatchPersonalNameIn | A list of personal names, with a country ISO2 code | [optional] |
- Content-Type: application/json
- Accept: application/json
FirstLastNameGenderedOut genderChineseNamePinyin(chineseSurnameLatin, chineseGivenNameLatin)
Infer the likely gender of a Chinese name in LATIN (Pinyin).
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
String chineseSurnameLatin = "chineseSurnameLatin_example"; // String |
String chineseGivenNameLatin = "chineseGivenNameLatin_example"; // String |
try {
FirstLastNameGenderedOut result = apiInstance.genderChineseNamePinyin(chineseSurnameLatin, chineseGivenNameLatin);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#genderChineseNamePinyin");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
chineseSurnameLatin | String | ||
chineseGivenNameLatin | String |
- Content-Type: Not defined
- Accept: application/json
BatchFirstLastNameGenderedOut genderChineseNamePinyinBatch(batchFirstLastNameIn)
Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin).
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
BatchFirstLastNameIn batchFirstLastNameIn = new BatchFirstLastNameIn(); // BatchFirstLastNameIn | A list of names, with country code.
try {
BatchFirstLastNameGenderedOut result = apiInstance.genderChineseNamePinyinBatch(batchFirstLastNameIn);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#genderChineseNamePinyinBatch");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
batchFirstLastNameIn | BatchFirstLastNameIn | A list of names, with country code. | [optional] |
- Content-Type: application/json
- Accept: application/json
PersonalNameParsedOut parseChineseName(chineseName)
Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name)
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
String chineseName = "chineseName_example"; // String |
try {
PersonalNameParsedOut result = apiInstance.parseChineseName(chineseName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#parseChineseName");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
chineseName | String |
- Content-Type: Not defined
- Accept: application/json
BatchPersonalNameParsedOut parseChineseNameBatch(batchPersonalNameIn)
Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name).
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
BatchPersonalNameIn batchPersonalNameIn = new BatchPersonalNameIn(); // BatchPersonalNameIn | A list of personal names
try {
BatchPersonalNameParsedOut result = apiInstance.parseChineseNameBatch(batchPersonalNameIn);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#parseChineseNameBatch");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
batchPersonalNameIn | BatchPersonalNameIn | A list of personal names | [optional] |
- Content-Type: application/json
- Accept: application/json
PersonalNameParsedOut pinyinChineseName(chineseName)
Romanize the Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name)
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
String chineseName = "chineseName_example"; // String |
try {
PersonalNameParsedOut result = apiInstance.pinyinChineseName(chineseName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#pinyinChineseName");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
chineseName | String |
- Content-Type: Not defined
- Accept: application/json
BatchPersonalNameParsedOut pinyinChineseNameBatch(batchPersonalNameIn)
Romanize a list of Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name).
// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.ChineseApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");
ChineseApi apiInstance = new ChineseApi();
BatchPersonalNameIn batchPersonalNameIn = new BatchPersonalNameIn(); // BatchPersonalNameIn | A list of Chinese names
try {
BatchPersonalNameParsedOut result = apiInstance.pinyinChineseNameBatch(batchPersonalNameIn);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ChineseApi#pinyinChineseNameBatch");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
batchPersonalNameIn | BatchPersonalNameIn | A list of Chinese names | [optional] |
- Content-Type: application/json
- Accept: application/json