Ascio Web Service v3

NodeJS GetOrders

Search for orders.

GetOrdersResponse GetOrders(SecurityHeaderDetails securityHeader,GetOrdersRequest request)

Response codes

ResultCodeMessageValue
200OK
401Authorization failed
404Object not found
405Access denied
501Syntax error in parameters or arguments

GetOrders Request

Property
request

GetOrdersResponse

PropertyDescription
GetOrdersResult
TotalCountExample: 1
OrdersInfo
ResultCodeExample: 1
ResultMessage
Errors

Used in Classes

NodeJS example

var soap = require("soap");

var getOrdersExample = function(callback) {

	//PagingInfo
	pageInfo =  {};
	pageInfo.PageIndex=1;
	pageInfo.PageSize=1;

	//GetOrdersRequest
	request =  {};
	request.TransactionComment="TransactionCommentTest";
	request.Comments="RegistrarTag";
	request.FromDate="2024-10-14T07:12:08.009+02:00";
	request.ToDate="2024-10-14T07:12:08.009+02:00";
	request.OrderStatusTypes=[
		{"q3:OrderStatusType", "NotSet"}, 
		{"q3:OrderStatusType", "Received"}, 
		{"q3:OrderStatusType", "Validated"}, 
		{"q3:OrderStatusType", "Invalid"}, 
		{"q3:OrderStatusType", "PendingDocumentation"}, 
		{"q3:OrderStatusType", "PendingEndUserAction"}, 
		{"q3:OrderStatusType", "DocumentationReceived"}, 
		{"q3:OrderStatusType", "DocumentationApproved"}, 
		{"q3:OrderStatusType", "DocumentationNotApproved"}, 
		{"q3:OrderStatusType", "PendingNicProcessing"}, 
		{"q3:OrderStatusType", "PendingNicDocumentApproval"}, 
		{"q3:OrderStatusType", "PendingPostProcessing"}, 
		{"q3:OrderStatusType", "PendingInternalProcessing"}, 
		{"q3:OrderStatusType", "Completed"}, 
		{"q3:OrderStatusType", "Failed"}, 
		{"q3:OrderStatusType", "AuthenticationFailed"}];
	request.OrderTypes=[
		{"q3:OrderType", "NotSet"}, 
		{"q3:OrderType", "ContactUpdate"}, 
		{"q3:OrderType", "ChangeLocks"}, 
		{"q3:OrderType", "Delete"}, 
		{"q3:OrderType", "RegistrantDetailsUpdate"}, 
		{"q3:OrderType", "Expire"}, 
		{"q3:OrderType", "NameserverUpdate"}, 
		{"q3:OrderType", "OwnerChange"}, 
		{"q3:OrderType", "Queue"}, 
		{"q3:OrderType", "Register"}, 
		{"q3:OrderType", "Renew"}, 
		{"q3:OrderType", "Restore"}, 
		{"q3:OrderType", "Transfer"}, 
		{"q3:OrderType", "Unexpire"}, 
		{"q3:OrderType", "TransferAway"}, 
		{"q3:OrderType", "AutoRenew"}, 
		{"q3:OrderType", "AutoDelete"}, 
		{"q3:OrderType", "DetailsUpdate"}, 
		{"q3:OrderType", "Import"}, 
		{"q3:OrderType", "PartnerChange"}, 
		{"q3:OrderType", "DeQueue"}, 
		{"q3:OrderType", "UpdateAuthInfo"}, 
		{"q3:OrderType", "Support"}, 
		{"q3:OrderType", "WhoisDataReminder"}];
	request.ObjectTypes=[
		{"q3:ObjectType", "DomainType"}, 
		{"q3:ObjectType", "DefensiveType"}, 
		{"q3:ObjectType", "MarkType"}, 
		{"q3:ObjectType", "NameWatchType"}, 
		{"q3:ObjectType", "SslCertificateType"}, 
		{"q3:ObjectType", "LocalPresence"}, 
		{"q3:ObjectType", "PrivacyProxy"}, 
		{"q3:ObjectType", "MarkExtendedService"}, 
		{"q3:ObjectType", "SanSsl"}];
	request.OrderSort="CreatedAsc";
	request.PageInfo=pageInfo;
	request.ObjectNames=[];
	request.ObjectHandles=[];
	request.OrderIds=[];	
	soap.createClient("https://aws.demo.ascio.com/v3/aws.wsdl", function(err, client) {
		if(err) {
			callback(err);
		} 
		else {
			const ns="http://www.ascio.com/2013/02";
			const securityHeader = {
				SecurityHeaderDetails : {
					Account: "ascio-account",
					Password: "mypassword123"
				}			
			};			
			client.addSoapHeader(securityHeader, ns, "q1");
			const impersonationHeader = {
				ImpersonationHeaderDetails : {
					TransactionAccount: "sub-account"
				}
			}
			client.addSoapHeader(impersonationHeader, ns, "q1");
			client.GetOrders({request: request}, function(err,result) {
				if(err) {
					callback({error: err, request : result.request.body});
				} else {
					if(result.GetOrdersResult.ResultCode < 400) {
						callback(null,result);	
					} else {
						callback({error: result.GetOrdersResult,request : request});
					}
				}
			});
		};
	});
};
getOrdersExample(function(err,result) {
	if(err) {
		console.log("\n\n Request \n\n",err.request, "\n\n Response \n\n" ,err.error,"\n");
	}
	else {
		console.log(result);
	}
});
WSDL for AWS v3
https://aws.demo.ascio.com/v3/aws.wsdl (OTE)
https://aws.ascio.com/v3/aws.wsdl (Live)
Please configure the IP-Whitelisting in the portal/demo-portal.