GetOrderTypes

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdsGuid[]Filter by array of BrickIds. BrickId is the internal id of an order.  
Keysstring[]Specific keys (OrderTypes) to look for.  

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidThe BrickId of an OrderType 
KeystringFor example "TransferInBatchOrder" or "ExternalFundOrderSell" 
LabelstringLanguage label of the OrderType, en-label or sv-label if exists, null otherwise. 

 

 

C# - Get Order Types from a BFS instance
var client = new BFSServiceReference.bfsapiSoapClient(); 


var credentials = new BFSServiceReference.Credentials()
{
    UserName = bfsusername, //Username of administrative user in your instance of BFS
    Password = bfspassword, //Password of the administrative user in your instance of BFS
};  
 
var request = new GetOrderTypeRequest
{
	Credentials = credentials,    
	identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
 
	//Select the fields you want the response to contain
	Fields = new GetOrderTypeFields
	{
		BrickId = true,
	  	Key = true,
	   	Label = true,
	},

	//Empty filter gets all order types from the system    
	Args = new GetOrderTypeArgs()
};


var response = client.GetOrderTypes(request); //result from the BFS instance
 

Blog Posts