GetCurrencies

Guida SDK › Open API › Open API Interface Methods › Repository Interface › Currency Methods › GetCurrencies

GetCurrencies

Description

This method gets a list of all currencies in the system for which the name matches the search string.

Syntax

EntityListData GetCurrencies (string searchText);

Parameters

Name	Type	Description
searchText	string	The text to search for. The search string is optional and may be left empty. If used, it may contain an asterisk as a wildcard for the search.

Name

Type

Description

searchText

string

The text to search for.

The search string is optional and may be left empty. If used, it may contain an asterisk as a wildcard for the search.

Return Value

The currencies, as type EntityListData.

Remarks

An EntityListData object is returned as a collection of EntityListItemData items, which contains both the name and ID of every object.

ContractPartyMethods

CreateContractParty

Description

This method creates a contract party from the input data.

Syntax

long CreateContractParty(ContractPartyData ContractPartyData);

Parameters

Name	Type	Description
ContractPartyData	ContractPartyData	The data used to create the Contract Party.

Return Value

The ID of the new contract party, as type long.

Remarks

None.

UpdateContractParty

Description

This method updates all of the details of the contract party.

Syntax

void UpdateContractParty(ContractPartyData ContractPartyData);

Parameters

Name	Type	Description
ContractPartyData	ContractPartyData	The data used to update the contract party.

Return Value

None.

Remarks

The contract party which is updated is specified by the ID field of ContractPartyData.

GetContractPartyDetails

Description

This method gets the details of the specified contract party.

Syntax

ContractPartyData GetContractPartyDetails(long ContractPartyId);

Parameters

Name	Type	Description
ContractPartyID	long	The Contract Party ID.

Return Value

The contract party details, as type ContractPartyData.

Remarks

None.

DeleteContractParty

Description

This method deletes the specified contract party from.

Syntax

void DeleteContractParty(long ContractPartyId);

Parameters

Name	Type	Description
ContractPartyID	long	The ID of the Contract Party

Return Value

None.

Remarks

None.

Customer Attribute Methods

GetCustomAttributes

Description

This method gets a list of all customer attributes in the system for which the name matches the search string.

Syntax

EntityListData GetCustomAttributes(string searchText);

Parameters

Name	Type	Description
searchText	string	The text to search for. The search string is optional and can be left empty. If used, it can contain an asterisk as a wildcard for the search.

Return Value

The details of the customer attributes, as type CustomAttributeDefinitionData.

Remarks

None.

GetCustomAttributeDetails

Description

This method gets the details of the specified customer attribute.

Syntax

CustomAttributeDefinitionData GetCustomAttributeDetails(long customAttributeId);

Parameters

Name	Type	Description
customAttributeID	long	The ID of the customer attributes.

Return Value

The details of the customer attributes, as type CustomAttributeDefinitionData.

Remarks

None.

UpdateCustomAttribute

Description

This method updates the details of the specified customer attribute.

Syntax

void UpdateCustomAttribute(CustomAttributeDefinitionData customAttributeDefinitionData);

Parameters

Name	Type	Description
customAttributeDefinitionData	CustomAttributeDefinitionData	The ID of the customer attributes.

Return Value

The data used to update the contract customer attribute.

Remarks

The customer attribute which is updated is specified by the filed ID of CustomAttributeDefinitionData.

Service Component Methods

ServiceComponentDetails

Description

This method gets the details of the specified service component.

Syntax

ServiceComponentData GetServiceComponentDetails(long serviceComponentID);

Parameters

Name	Type	Description
serviceComponentID	long	The ID of the service component.

Return Value

The details of service component, as type ServiceComponentData.

Remarks

None.

UpdateServiceComponentDetails

Description

This method updates the details of the specified service component.

Syntax

ServiceComponentData GetServiceComponentDetails(long serviceComponentID);

Parameters

Name	Type	Description
serviceComponentData	serviceComponentData	The data used to update the service component.

Return Value

The details of service component, as type ServiceComponentData.

Remarks

The service component which is updated is specified by the field id of ServiceComponentData.

DeleteServiceComponent

Description

This method deletes the specified service component.

Syntax

void DeleteServiceComponent(long serviceComponentID);

Parameters

Name	Type	Description
serviceComponentID	long	The ID of the service component.

Return Value

None.

Remarks

None.

Contatta CA Technologies