Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Current »

Inputs (Array of AllocationProfiles) inherits from EntityBase

Name
Type
Description
MandatoryAvailable from version
BrickIdGuidNot used.  
KeyStringThe key of the allocation profile, this can be any string and is only used for your referenceTrue 
NameString

The name of the allocation profile

True 
OwnerGuidThe owner associated with the allocation profileTrue 
AllocationItemsAllocationItem[]

Array of AllocationItem

  

Outputs

Name
Type
Description
Available from version
EntitiesArray

All allocation profiles in the request is returned along with each allocation profiles's BrickId and array of Errors per allocation profile

 
XML request example
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
 <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 	<GetAllocationProfiles xmlns="http://tempuri.org/">
 		<req>
 			<Credentials>
 				<UserName>yourusername</UserName>
 				<Password>yourpassword</Password>
 			</Credentials>
 			<identify>youridentifier</identify>
 			<Args>
 				<BrickId xsi:nil="true" />
 				<Owner xsi:nil="true" />
 				<Key>AllocationProfile1</Key>
 			</Args>
 			<Fields>
 				<BrickId>true</BrickId>
				 <Name>true</Name>
 				<Key>true</Key>
 				<AllocationItems>false</AllocationItems>
 				<Owner>true</Owner>
 			</Fields>
 		</req>
 	</GetAllocationProfiles>
 </s:Body>
</s:Envelope>
C# - CreateAllocationProfiles
//Create an allocation profile with the CreateAllocationProfiles methodvar 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 AI1 = new AllocationItem() //The only allocation item
{
    Asset = new Guid("138e92a5-f1d6-4473-9ca4-45f511881676"),
    AllocationPercentage = 1M
};
 
var response = client.CreateAllocationProfiles(new BFSServiceReference.CreateAllocationProfileRequest()
{
    Credentials = credentials,
 
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS       
 
    Entities = new[]
    {
        new AllocationProfile()
        {     
            Key = "Alloc1",
            Name = "My allocation",
            Owner = new Guid("0a39dc30-9e75-4261-920a-1398fb87c952"),
            AllocationItems = new []
            {
                AI1               
            },           
        },
 
    }
 
});
 
foreach (var c in response.Entities)
{
    Console.WriteLine(c.BrickId + "," + c.Errors);
}

 

Blog Posts

  • No labels