End Google Tag Manager (noscript) -->
USA +1 866 806 2068 | UK +44 203 1292 513 | JAPAN +81 3 45208991 担当:萩原 info@openlm.com

Scope

This document describes the changes made to the OpenLM SOAP API set in OpenLM version 3.

Changes Made in 3.0

converting EnableFileFetching to bool

the type EnableFileFetching property was changed to bool in FileFetchConfig class

The class is used in:

GetFileFetchConfigResponse in GetFileFetchConfig method

UpdateFileFetchConfigRequest in UpdateFileFetchConfig method

New API Added – Supporting User Filtering in CCL

The request of GetCurrentlyConsumedLicenses was changed to CurrentlyConsumedLicensesRequest instead of LicenseInfoRequest

The structure of the class is:

public class CurrentlyConsumedLicensesRequest : BaseRequest

{

[DataMember]

public string ServerName { get; set; }

[DataMember]

public string VendorName { get; set; }

[DataMember]

public List<FeatureProductVersion> Features { get; set; }

[DataMember]

public List<FeatureProductVersion> Products { get; set; }

[DataMember]

public List<int> UserIDs { get; set; }

[DataMember]

public List<int> GroupIDS { get; set; }

[DataMember]

public List<LicenseTypes> LicenseTypes { get; set; }

[DataMember]

public List<string> AdditionalKey { get; set; }

}

New API Added –  Supporting “include Current Usage” Option in License Usage

The following property added to LicenseUsageReportRequest class in GetLicenseUsageReport method:

public bool IncludeCurrentUsage { get; set; }

New API Added –  Supporting SetFullLogging API Method

public BaseResponse SetFullLogging(SetFullLoggingRequest request)

The structure of class is:

public class SetFullLoggingRequest : BaseRequest

{

public int LoggingPeriodInMinutes { get; set; }

}

New API Added – Supporting GetLicenseTypes API

LicenseTypesResponse GetLicenseTypes(BaseRequest request);

The structure of class is:

public class LicenseTypesResponse : BaseResponse

{

public List<LicenseTypes> Types { get; set; }

}

New API Added – Supporting Get Option File Content API Method

BaseResponse GetOptFileContent(OptFileContentRequest request);

The structure of class is:

public class OptFileContentRequest : BaseRequest

{

public int OptFileID { get; set; }

}

New API Added – Supporting GetOptFileFeatureValidKeywords API

OptFileFeatureValidKeywordsResponse GetOptFileFeatureValidKeywords(OptFileFeatureValidKeywordsRequest request);

The structures of classes are:

public class OptFileFeatureValidKeywordsRequest : BaseRequest

{

public int OptionFileID { get; set; }

public string Feature { get; set; }

}

public class OptFileFeatureValidKeywordsResponse : BaseResponse

{

public Dictionary<string, HashSet<string>> Keywords { get; set; }

public bool IsCustomValuesEnabled { get; set; }

}

Change in FeatureProductVersion Class – Supporting License Types and Additional Key

new properties added:

public LicenseTypes? LicenseType { get; set; }

public string AdditionalKey { get; set; }

The class is used in Request and Response classes of GetLicenseUsageReport method

It is used as dictionary key of the following:

LicenseUsageReportRequest.Features

LicenseUsageReportResponse.AggregateSessionsDictionary

LicenseUsageReportResponse.DateQuantitiesSessionsDictionary

LicenseUsageReportResponse.Totals

Changes Made in Version 3.2

New API Added – SetLMServerFullLogging – Set Full Logging for a Particular License Manager

The following is an example request Xml body:

<SetLMServerFullLoggingRequest xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.Services.DataContracts”>
<BaseInfo>
<SessionData>
<Refresh xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>true</Refresh>
<SessionID xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</SessionID>
</SessionData>
<PagingData>
<Direction xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</Direction>
<NumOfRecord xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>2147483647</NumOfRecord>
<Search xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</Search>
<SearchColumns xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
</SearchColumns>
<Sort xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
</Sort>
<StartRecord xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>2147483647</StartRecord>
</PagingData>
<UserLocalSettings>
<DecimalSeparator>String content</DecimalSeparator>
<ThousandsSeparator>String content</ThousandsSeparator>
<TimeFormat>String content</TimeFormat>
<TimezoneStandardName>String content</TimezoneStandardName>
</UserLocalSettings>
<IsExport>true</IsExport>
<CustomerId>String content</CustomerId>
</BaseInfo>
<SaasToken>String content</SaasToken>
<LoggingPeriodInMinutes>2147483647</LoggingPeriodInMinutes>
<ServerId>2147483647</ServerId>
</SetLMServerFullLoggingRequest>

The following is an example response Xml body:

<BaseResponse xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.Services.DataContracts”>
<Error>
<Code>2147483647</Code>
<Message>String content</Message>
<Parameters>
<KeyValueStringPair>
<Key>String content</Key>
<Value>String content</Value>
</KeyValueStringPair>
<KeyValueStringPair>
<Key>String content</Key>
<Value>String content</Value>
</KeyValueStringPair>
</Parameters>
</Error>
<ExportContentType>Text</ExportContentType>
<ExportString>String content</ExportString>
<SaasToken>String content</SaasToken>
</BaseResponse>

New API Added – UpdateCheckoutPolicy – set checkout policy for a list of licenses or vendor

The following is an example request Xml body:

<UpdateCheckoutPolicyRequest xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.Services.DataContracts”>
<BaseInfo>
<SessionData>
<Refresh xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>true</Refresh>
<SessionID xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</SessionID>
</SessionData>
<PagingData>
<Direction xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</Direction>
<NumOfRecord xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>2147483647</NumOfRecord>
<Search xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</Search>
<SearchColumns xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
</SearchColumns>
<Sort xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
</Sort>
<StartRecord xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>2147483647</StartRecord>
</PagingData>
<UserLocalSettings>
<DecimalSeparator>String content</DecimalSeparator>
<ThousandsSeparator>String content</ThousandsSeparator>
<TimeFormat>String content</TimeFormat>
<TimezoneStandardName>String content</TimezoneStandardName>
</UserLocalSettings>
<IsExport>true</IsExport>
<CustomerId>String content</CustomerId>
</BaseInfo>
<SaasToken>String content</SaasToken>
<LicenseCheckoutPolicies>
<LicenseCheckoutPolicy>
<CheckoutPolicy>None</CheckoutPolicy>
<LicenseID>2147483647</LicenseID>
</LicenseCheckoutPolicy>
<LicenseCheckoutPolicy>
<CheckoutPolicy>None</CheckoutPolicy>
<LicenseID>2147483647</LicenseID>
</LicenseCheckoutPolicy>
</LicenseCheckoutPolicies>
<VendorCheckoutPolicies>
<VendorCheckoutPolicy>
<CheckoutPolicy>None</CheckoutPolicy>
<Vendor>String content</Vendor>
</VendorCheckoutPolicy>
<VendorCheckoutPolicy>
<CheckoutPolicy>None</CheckoutPolicy>
<Vendor>String content</Vendor>
</VendorCheckoutPolicy>
</VendorCheckoutPolicies>
</UpdateCheckoutPolicyRequest>

The following is an example response Xml body:

<BaseResponse xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.Services.DataContracts”>
<Error>
<Code>2147483647</Code>
<Message>String content</Message>
<Parameters>
<KeyValueStringPair>
<Key>String content</Key>
<Value>String content</Value>
</KeyValueStringPair>
<KeyValueStringPair>
<Key>String content</Key>
<Value>String content</Value>
</KeyValueStringPair>
</Parameters>
</Error>
<ExportContentType>Text</ExportContentType>
<ExportString>String content</ExportString>
<SaasToken>String content</SaasToken>
</BaseResponse>

New API Added – GetProjectsUsage – Get Project Usage in a Particular Usage Session

The following is an example request Xml body:

<GetProjectsUsageRequest xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.Services.DataContracts”>
<BaseInfo>
<SessionData>
<Refresh xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>true</Refresh>
<SessionID xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</SessionID>
</SessionData>
<PagingData>
<Direction xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</Direction>
<NumOfRecord xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>2147483647</NumOfRecord>
<Search xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>String content</Search>
<SearchColumns xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
</SearchColumns>
<Sort xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
<string xmlns=”http://schemas.microsoft.com/2003/10/Serialization/Arrays”>String content</string>
</Sort>
<StartRecord xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.VO”>2147483647</StartRecord>
</PagingData>
<UserLocalSettings>
<DecimalSeparator>String content</DecimalSeparator>
<ThousandsSeparator>String content</ThousandsSeparator>
<TimeFormat>String content</TimeFormat>
<TimezoneStandardName>String content</TimezoneStandardName>
</UserLocalSettings>
<IsExport>true</IsExport>
<CustomerId>String content</CustomerId>
</BaseInfo>
<SaasToken>String content</SaasToken>
<IsCurrent>true</IsCurrent>
<UsageSessionID>2147483647</UsageSessionID>
</GetProjectsUsageRequest>

The following is an example response Xml body:

<GetProjectsUsageResponse xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Server.Services.DataContracts”>
<Error>
<Code>2147483647</Code>
<Message>String content</Message>
<Parameters>
<KeyValueStringPair>
<Key>String content</Key>
<Value>String content</Value>
</KeyValueStringPair>
<KeyValueStringPair>
<Key>String content</Key>
<Value>String content</Value>
</KeyValueStringPair>
</Parameters>
</Error>
<ExportContentType>Text</ExportContentType>
<ExportString>String content</ExportString>
<SaasToken>String content</SaasToken>
<ProjectsUsage>
<ProjectUsageDisplay>
<EndDateUTC>
<Year xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Year>
<Month xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Month>
<Day xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Day>
<Hour xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Hour>
<Minute xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Minute>
<Second xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Second>
<StringFormatted xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>String content</StringFormatted>
</EndDateUTC>
<Project>
<Id>2147483647</Id>
<Name>String content</Name>
</Project>
<StartDateUTC>
<Year xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Year>
<Month xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Month>
<Day xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Day>
<Hour xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Hour>
<Minute xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Minute>
<Second xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Second>
<StringFormatted xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>String content</StringFormatted>
</StartDateUTC>
</ProjectUsageDisplay>
<ProjectUsageDisplay>
<EndDateUTC>
<Year xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Year>
<Month xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Month>
<Day xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Day>
<Hour xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Hour>
<Minute xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Minute>
<Second xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Second>
<StringFormatted xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>String content</StringFormatted>
</EndDateUTC>
<Project>
<Id>2147483647</Id>
<Name>String content</Name>
</Project>
<StartDateUTC>
<Year xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Year>
<Month xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Month>
<Day xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Day>
<Hour xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Hour>
<Minute xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Minute>
<Second xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>2147483647</Second>
<StringFormatted xmlns=”http://schemas.datacontract.org/2004/07/OpenLM.Shared.VO”>String content</StringFormatted>
</StartDateUTC>
</ProjectUsageDisplay>
</ProjectsUsage>
</GetProjectsUsageResponse>