Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Properties

Type

Description

Page

integer

The page number to be retrieved

PageSize

integer

Number of entries on a page

UserId

integer

User who has created the service request

ServiceId

integer

The service where the service request belongs

SearchValue

string

A string that will be used to list service request by matching metadata

SearchOptionStructureColumnKeyName

string

A string that represents the KeyName in metadata structure used to determine which structure column will be filtered.

...

  1. SearchValue can be partial and should be minimum two characters in length after trimming.

  2. SearchOption StructureColumnKeyName determines the column structure to use for filtering metadata (i.e for Service 60, we want to filter by "project name" or "nom du projet"). It can be spedified in English or French.

Code Block
//This is an exemple to search a service request by filtering metadata with partial search value.
//It will filter metadata of service requests for service id 11.
/*Note: 
  - Service id 11 has metadata structure defined.
  - SearchValue and SearchOptionStructureColumnKeyName are case insensitive
  - Both langauge is accepted for SearchOption
  - Always retrieve service request with metadata
*/   

var serviceRequestSearchDTO = new ServiceRequestSearchDTO{
    ServiceId = ServiceId,
    Page = 1,
    PageSize = 10,
    UserId = 3919,
    SearchValue "CONF", //using partial value
    SearchOption StructureColumnKeyName= "name"
};
            
// Get ServiceRequestCollectionDTO including all service requests with metadata using partial value "CONF".
// and the key name used to filter structure column is "NAME". All KeyName:name value: should contain "CONF"

var serviceRequestCollectionDTO = await serviceRequestManager.SearchServiceRequest(serviceRequestSearchDTO );

...

Code Block
//This is an exemple to search a service request by filtering metadata with full search value.
//It will filter metadata of service requests for service id 11.
/*Note: 
  - Service id 11 has metadata structure defined.
  - SearchValue and SearchOptionStructureColumnKeyName are case insensitive
  - Both langauge is accepted for SearchValue and SearchOptionStructureColumnKeyName
  - Always retrieve service request with metadata
*/   

var serviceRequestSearchDTO = new ServiceRequestSearchDTO{
    ServiceId = ServiceId,
    Page = 1,
    PageSize = 10,
    UserId = 3919,
    SearchValue "TC CONF ON Ottawa - 330 Sparks - 08 - 803 CONF TC",  //using full value
    SearchOptionStructureColumnKeyName = "name"
};
            
// Get ServiceRequestCollectionDTO including all service requests with metadata using full value "TC CONF ON Ottawa - 330 Sparks - 08 - 803 CONF TC".
// and the key name used to filter structure column is "NAME". All KeyName:name value: should match "TC CONF ON Ottawa - 330 Sparks - 08 - 803 CONF TC"

var serviceRequestCollectionDTO = await serviceRequestManager.SearchServiceRequest(serviceRequestSearchDTO );