CorrigoServiceRetrieve Method |
Retrieves an instance of an entity. Takes two parameters:
first of them specifies an entity by identifier and entity type (instance of EntitySpecifier class should be passed);
second parameter specifies the set of properties to retrieve (to retrieve all properties, pass a new instance of the AllProperties class).
Returns an instance of the CorrigoEntity requested or null if no entity was found.
The CorrigoEntity class contains only the properties specified by the input parameter.
Use this method to retrieve an instance of the CorrigoNet entity.
Your client application must be logged in with sufficient access rights to retrieve a specified object and to retrieve the properties in the specified property list.
Namespace: CorrigoServiceAssembly: ClientXMLDoc (in ClientXMLDoc.exe) Version: 1.0.0.0 (1.0.0.0)
Syntaxpublic CorrigoEntity Retrieve(
EntitySpecifier entitySpecifier,
PropertySetBase propertySet
)
Parameters
- entitySpecifier
- Type: CorrigoServiceEntitySpecifier
Specifies an entity by identifier and entity type. - propertySet
- Type: CorrigoServicePropertySetBase
Specifies the set of properties to retrieve. To retrieve all properties, pass a new instance of the AllProperties class.
Return Value
Type:
CorrigoEntityReturns an instance of the CorrigoEntity requested or null if no entity was found. The CorrigoEntity class contains only the properties specified by the propertySet parameter.
See Also