Library and API translations

Library and API translations

This area assists users who are already fimiliar with the OpenSRS API to match the corresponding commands in the library.

Domain Function list and corresponding Action and Object in OpenSRS XML API

PHP Function Name	XML Action	XML Object	XML Doc Page	PDF Page
premiumDomain	NAME_SUGGEST	DOMAIN	117	132
allinoneDomain	NAME_SUGGEST	DOMAIN	117	132
suggestDomain	NAME_SUGGEST	DOMAIN	117	132

NOTE: There is a difference between how NAME_SUGGEST is used by each function above. The function premiumDomain will only run NAME_SUGGEST for Premium domain suggestions. The suggestDomain function will only run NAME_SUGGEST for name suggestions. Finally, allinoneDomain will run NAME_SUGGEST for a TLD lookup, name suggestions and premium domains all at the same time.

PHP Function Name	XML Action	XML Object	XML Doc Page	PDF Page
authAuthenticateUser	AUTHENTICATE	USER
authChangeOwnership	CHANGE	OWNERSHIP	533	548
authChangePassword	CHANGE	PASSWORD	536	551
authSendAuthcode	SEND_AUTHCODE	DOMAIN	539	554
authSendPassword	SEND_PASSWORD	DOMAIN	542	557
sendCiraEmailPwd	CIRA_EMAIL_PWD	DOMAIN	23	38
bulkChange	SUBMIT	BULK_CHANGE	391	406
bulkTransfer	BULK_TRANSFER	DOMAIN	385	400
cookieDelete	DELETE	COOKIE	546	561
cookieSet	SET	COOKIE	551	566
cookieUpdate	UPDATE	COOKIE	556	571
dnsCreate	CREATE_DNS_ZONE	DOMAIN	455	470
dnsDelete	DELETE_DNS_ZONE	DOMAIN	465	480
dnsForce	FORCE_DNS_NAMESERVERS	DOMAIN	468	483
dnsGet	GET_DNS_ZONE	DOMAIN	471	486
dnsReset	RESET_DNS_ZONE	DOMAIN	478	493
dnsSet	SET_DNS_ZONE	DOMAIN	488	503
fwdCreate	CREATE_DOMAIN_FORWARDING	DOMAIN	499	514
fwdDelete	DELETE_DOMAIN_FORWARDING	DOMAIN	501	516
fwdGet	GET_DOMAIN_FORWARDING	DOMAIN	504	519
fwdSet	SET_DOMAIN_FORWARDING	DOMAIN	508	523
lookupBelongsToRsp	BELONGS_TO_RSP	DOMAIN	19	34
lookupDomain	LOOKUP	DOMAIN	112	127
lookupGetBalance	GET_BALANCE	BALANCE	26	41
lookupGetCaBlockerList	GET_CA_BLOCKER_LIST	DOMAIN	29	44
lookupGetDeletedDomains	GET_DELETED_DOMAINS	DOMAIN	33	48
lookupGetDomain	GET	DOMAIN	40	55
lookupGetDomainByExpiry	GET_DOMAINS_BY_EXPIREDATE	DOMAIN	88	103
lookupGetDomainContacts	GET_DOMAIN_CONTACTS	DOMAIN	84	99
lookupGetNotes	GET_NOTES	DOMAIN	93	108
lookupGetOrderInfo	GET_ORDER_INFO	DOMAIN	97	112
lookupGetOrdersByDomain	GET_ORDERS_BY_DOMAIN	DOMAIN	104	119
lookupGetPrice	GET_PRICE	DOMAIN	109	124
nsAdvancedUpdt	ADVANCED_UPDATE_NAMESERVERS	DOMAIN	420	435
nsCreate	REGISTRY_ADD_NS	NAMESERVER	425	440
nsDelete	DELETE	NAMESERVER	432	447
nsGet	GET	NAMESERVER	435	450
nsModify	MODIFY	NAMESERVER	440	455
nsRegistryAdd	REGISTRY_ADD_NS	NAMESERVER	443	458
nsRegistryCheck	REGISTRY_CHECK_NAMESERVER	NAMESERVER	449	464
persDelete	DELETE	SURNAME	336	351
persNameSuggest	NAME_SUGGEST	SURNAME	307	322
persQuery	QUERY	SURNAME	324	339
persSUregister	SU_REGISTER	SURNAME	313	328
persUpdate	UPDATE	SURNAME	329	344
provActivate	ACTIVATE	DOMAIN	147	162
provCancelActivate	CANCEL_ACTIVE_PROCESS	DOMAIN	150	165
provCancelPending	CANCEL_PENDING_ORDERS	ORDER	153	168
provModify	MODIFY	DOMAIN	157	172
provProcessPending	PROCESS_PENDING	DOMAIN	197	212
provQueryQueuedRequest	QUERY_QUEUED_REQUEST	DOMAIN	202	217
provRenew	RENEW	DOMAIN	205	220
provRevoke	REVOKE	DOMAIN	211	226
provSendCIRAapproval	SEND_CIRA_APPROVAL_EMAIL	DOMAIN	215	230
provSWregister	SW_REGISTER	DOMAIN	218	233
provUpdateAllInfo	UPDATE_ALL_INFO	DOMAIN	274	289
provUpdateContacts	UPDATE_CONTACTS	DOMAIN	278	293
subresCreate	CREATE	SUBRESELLER	287	302
subresGet	GET	SUBRESELLER	296	311
subresModify	MODIFY	SUBRESELLER	292	307
subresPay	PAY	SUBRESELLER	303	318
subuserAdd	ADD	SUBUSER	514	529
subuserDelete	DELETE	SUBUSER	517	532
subuserGet	GET	SUBUSER	520	535
subuserGetInfo	GET	USERINFO	523	538
subuserModify	MODIFY	SUBUSER	529	544
transCancel	CANCEL_TRANSFER	TRANSFER	340	355
transCheck	CHECK_TRANSFER	DOMAIN	344	359
transGetAway	GET_TRANSFERS_AWAY	DOMAIN	350	365
transGetIn	GET_TRANSFERS_IN	DOMAIN	360	375
transProcess	PROCESS_TRANSFER	TRANSFER	369	384
transRsp2Rsp	RSP2RSP_PUSH_TRANSFER	DOMAIN	373	388
transSendPass	SEND_PASSWORD	TRANSFER	377	392
transTradeDomain	TRADE_DOMAIN	DOMAIN	380	395

====================================================================== 9.2 - Mail Function list and corresponding Command in OpenSRS Mail APP

PHP Function Name	APP Command	APP Doc Page	PDF Page
mailAuthentication	LOGIN	7	17
mailChangeDomain	CHANGE_DOMAIN	18	28
mailCreateDomain	CREATE_DOMAIN	9	19
mailCreateDomainAlias	CREATE_DOMAIN_ALIAS	10	20
mailCreateDomainWelcomeEmail	CREATE_DOMAIN_WELCOME_EMAIL	12	22
mailCreateMailbox	CREATE_MAILBOX	32	42
mailDeleteDomain	DELETE_DOMAIN	11	21
mailDeleteDomainAlias	DELETE_DOMAIN_ALIAS	11	21
mailDeleteDomainWelcomeEmail	DELETE_DOMAIN_WELCOME_EMAIL	15	25
mailDeleteMailbox	DELETE_MAILBOX	47	57
mailGetCompanyDomains	GET_COMPANY_DOMAINS	14	24
mailGetDomain	GET_DOMAIN	16	26
mailGetDomainAllowList	GET_DOMAIN_ALLOW_LIST	26	36
mailGetDomainBlockList	GET_DOMAIN_BLOCK_LIST	27	37
mailGetDomainMailboxes	GET_DOMAIN_MAILBOXES	23	33
mailGetDomainMailboxLimits	GET_DOMAIN_MAILBOX_LIMITS	24	34
mailGetNumDomainMailboxes	GET_NUM_DOMAIN_MAILBOXES	22	32
mailSetDomainAdmin	SET_DOMAIN_ADMIN	19	29
mailSetDomainAllowList	SET_DOMAIN_ALLOW_LIST	25	35
mailSetDomainBlockList	SET_DOMAIN_BLOCK_LIST	26	36
mailSetDomainDisabledStatus	SET_DOMAIN_DISABLED_STATUS	22	32
mailSetDomainMailboxLimits	SET_DOMAIN_MAILBOX_LIMITS	24	34