Filter Inputs

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Available from version
BrickId	Guid[]	Filter by AllocationOrderId
Account	Guid?	Filter by AccountId
ReBalanceInstance	Guid?	Filter by ReBalanceInstanceId
CreatedDateFrom	DateTime?	When used, both from date and to date should be provided in the request
CreatedDateTo	DateTime?
AllocationItems	AllocationItems[]	Filter by AllocationItems
ReservationItems	ReservationItems[]	Filter by ReservationItems
OrderNos	string[]	Filter by order numbers
CreatedById	Guid?	Filter by created user
States	string[]	Filter by states (AllocationOrder_Created,AllocationOrder_OngoingAllocation,AllocationOrder_Finished,AllocationOrder_Canceled)	2.17

Response rows (Array) inherits from EntityBase

Name	Type	Description	Available from version

Name	Type	Description
BrickId	Guid	Id of the allocation order
Account	Guid?	Id of the account to which the order belongs
ReBalanceInstance	Guid?	Id of the pre trade report from an allocation profile (for those allocation orders that belongs to a pre trade report)
CreatedDate	DateTime	Date when allocation order was created
AllocationItems	AllocationItems[]	List of AllocationItem
ReservationItems	ReservationItems[]	List of ReservationItem
OrderNo	string	Order number of the order
CreatedById	Guid?	Id of user that created the order
State	string	State of order

Code example

C# - Get Allocation Orders 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 GetAllocationOrderRequest
{
    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 GetAllocationOrderFields
    {
        Account = true,
		AllocationItems = true,
        BrickId = true,
        CreatedById = true,
        CreatedDate = true,
        OrderNo = true,
        ReBalanceInstance = true,
        ReservationItems = true
    },
 
    //Empty filter gets all allocation orders from the system    
    Args = new GetAllocationOrderArgs()
};
 
 
var response = client.GetAllocationOrders(request); //result from the BFS instance

Blog stream

Create a blog post to share news and announcements with your team and company.