GET api/ServiceTemplate/GetServiceTemplate?ApiToken={ApiToken}&TemplateID={TemplateID}&TemplateName={TemplateName}&IsActive={IsActive}&PageNumber={PageNumber}&PageSize={PageSize}&CustomerID={CustomerID}
Get Service Template
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ApiToken | string |
None. |
|
| TemplateID | integer |
None. |
|
| TemplateName | string |
None. |
|
| IsActive | integer |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| CustomerID | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ServiceTemplateReponseDataModel| Name | Description | Type | Additional information |
|---|---|---|---|
| _objServiceTemplate | Collection of ServiceTemplateDataModel |
None. |
|
| ReturnID | integer |
Required |
|
| Message | string |
Required |
|
| Successful | boolean |
Required |
|
| Code | integer |
None. |
|
| TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{
"_objServiceTemplate": [
{
"templateID": 1,
"templateName": "sample string 1",
"description": "sample string 2",
"isActive": 1,
"isDeleted": 1,
"addedBy": 1,
"addedDate": "2025-07-17T05:14:31.9268255+00:00",
"modifiedBy": 1,
"modifiedDate": "2025-07-17T05:14:31.9268255+00:00",
"totalRecord": 3,
"lstParts": [
{
"templateServicePartsID": 1,
"templateID": 2,
"partsID": 3,
"partsCode": "sample string 4",
"partsName": "sample string 5",
"quantity": 6.0,
"uomid": 7,
"unit": "sample string 8",
"unitPrice": 9.0,
"totalPrice": 10.0,
"taxRateID": 11,
"taxPercentage": 12.0,
"taxAmount": 13.0,
"taxRate": 14.0,
"discountPercentage": 15.0,
"description": "sample string 16",
"uom": "sample string 17",
"warranty": "sample string 18"
},
{
"templateServicePartsID": 1,
"templateID": 2,
"partsID": 3,
"partsCode": "sample string 4",
"partsName": "sample string 5",
"quantity": 6.0,
"uomid": 7,
"unit": "sample string 8",
"unitPrice": 9.0,
"totalPrice": 10.0,
"taxRateID": 11,
"taxPercentage": 12.0,
"taxAmount": 13.0,
"taxRate": 14.0,
"discountPercentage": 15.0,
"description": "sample string 16",
"uom": "sample string 17",
"warranty": "sample string 18"
}
],
"lstCustomers": [
{
"templateCustomerMappingID": 1,
"templateID": 2,
"customerID": 3,
"customerName": "sample string 4",
"customerEmail": "sample string 5"
},
{
"templateCustomerMappingID": 1,
"templateID": 2,
"customerID": 3,
"customerName": "sample string 4",
"customerEmail": "sample string 5"
}
]
},
{
"templateID": 1,
"templateName": "sample string 1",
"description": "sample string 2",
"isActive": 1,
"isDeleted": 1,
"addedBy": 1,
"addedDate": "2025-07-17T05:14:31.9268255+00:00",
"modifiedBy": 1,
"modifiedDate": "2025-07-17T05:14:31.9268255+00:00",
"totalRecord": 3,
"lstParts": [
{
"templateServicePartsID": 1,
"templateID": 2,
"partsID": 3,
"partsCode": "sample string 4",
"partsName": "sample string 5",
"quantity": 6.0,
"uomid": 7,
"unit": "sample string 8",
"unitPrice": 9.0,
"totalPrice": 10.0,
"taxRateID": 11,
"taxPercentage": 12.0,
"taxAmount": 13.0,
"taxRate": 14.0,
"discountPercentage": 15.0,
"description": "sample string 16",
"uom": "sample string 17",
"warranty": "sample string 18"
},
{
"templateServicePartsID": 1,
"templateID": 2,
"partsID": 3,
"partsCode": "sample string 4",
"partsName": "sample string 5",
"quantity": 6.0,
"uomid": 7,
"unit": "sample string 8",
"unitPrice": 9.0,
"totalPrice": 10.0,
"taxRateID": 11,
"taxPercentage": 12.0,
"taxAmount": 13.0,
"taxRate": 14.0,
"discountPercentage": 15.0,
"description": "sample string 16",
"uom": "sample string 17",
"warranty": "sample string 18"
}
],
"lstCustomers": [
{
"templateCustomerMappingID": 1,
"templateID": 2,
"customerID": 3,
"customerName": "sample string 4",
"customerEmail": "sample string 5"
},
{
"templateCustomerMappingID": 1,
"templateID": 2,
"customerID": 3,
"customerName": "sample string 4",
"customerEmail": "sample string 5"
}
]
}
],
"returnID": 1,
"message": "sample string 2",
"successful": true,
"code": 4,
"totalRecord": 5
}
application/xml, text/xml
Sample:
<ServiceTemplateReponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel">
<Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</Code>
<Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message>
<ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</ReturnID>
<Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
<TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</TotalRecord>
<_objServiceTemplate>
<ServiceTemplateDataModel>
<AddedBy>1</AddedBy>
<AddedDate>2025-07-17T05:14:31.9268255+00:00</AddedDate>
<Description>sample string 2</Description>
<IsActive>1</IsActive>
<IsDeleted>1</IsDeleted>
<ModifiedBy>1</ModifiedBy>
<ModifiedDate>2025-07-17T05:14:31.9268255+00:00</ModifiedDate>
<TemplateID>1</TemplateID>
<TemplateName>sample string 1</TemplateName>
<TotalRecord>3</TotalRecord>
<lstCustomers>
<ServiceTemplateCustomersDataModel>
<CustomerEmail>sample string 5</CustomerEmail>
<CustomerID>3</CustomerID>
<CustomerName>sample string 4</CustomerName>
<TemplateCustomerMappingID>1</TemplateCustomerMappingID>
<TemplateID>2</TemplateID>
</ServiceTemplateCustomersDataModel>
<ServiceTemplateCustomersDataModel>
<CustomerEmail>sample string 5</CustomerEmail>
<CustomerID>3</CustomerID>
<CustomerName>sample string 4</CustomerName>
<TemplateCustomerMappingID>1</TemplateCustomerMappingID>
<TemplateID>2</TemplateID>
</ServiceTemplateCustomersDataModel>
</lstCustomers>
<lstParts>
<ServiceTemplatePartsDataModel>
<Description>sample string 16</Description>
<DiscountPercentage>15</DiscountPercentage>
<PartsCode>sample string 4</PartsCode>
<PartsID>3</PartsID>
<PartsName>sample string 5</PartsName>
<Quantity>6</Quantity>
<TaxAmount>13</TaxAmount>
<TaxPercentage>12</TaxPercentage>
<TaxRate>14</TaxRate>
<TaxRateID>11</TaxRateID>
<TemplateID>2</TemplateID>
<TemplateServicePartsID>1</TemplateServicePartsID>
<TotalPrice>10</TotalPrice>
<UOM>sample string 17</UOM>
<UOMID>7</UOMID>
<Unit>sample string 8</Unit>
<UnitPrice>9</UnitPrice>
<Warranty>sample string 18</Warranty>
</ServiceTemplatePartsDataModel>
<ServiceTemplatePartsDataModel>
<Description>sample string 16</Description>
<DiscountPercentage>15</DiscountPercentage>
<PartsCode>sample string 4</PartsCode>
<PartsID>3</PartsID>
<PartsName>sample string 5</PartsName>
<Quantity>6</Quantity>
<TaxAmount>13</TaxAmount>
<TaxPercentage>12</TaxPercentage>
<TaxRate>14</TaxRate>
<TaxRateID>11</TaxRateID>
<TemplateID>2</TemplateID>
<TemplateServicePartsID>1</TemplateServicePartsID>
<TotalPrice>10</TotalPrice>
<UOM>sample string 17</UOM>
<UOMID>7</UOMID>
<Unit>sample string 8</Unit>
<UnitPrice>9</UnitPrice>
<Warranty>sample string 18</Warranty>
</ServiceTemplatePartsDataModel>
</lstParts>
</ServiceTemplateDataModel>
<ServiceTemplateDataModel>
<AddedBy>1</AddedBy>
<AddedDate>2025-07-17T05:14:31.9268255+00:00</AddedDate>
<Description>sample string 2</Description>
<IsActive>1</IsActive>
<IsDeleted>1</IsDeleted>
<ModifiedBy>1</ModifiedBy>
<ModifiedDate>2025-07-17T05:14:31.9268255+00:00</ModifiedDate>
<TemplateID>1</TemplateID>
<TemplateName>sample string 1</TemplateName>
<TotalRecord>3</TotalRecord>
<lstCustomers>
<ServiceTemplateCustomersDataModel>
<CustomerEmail>sample string 5</CustomerEmail>
<CustomerID>3</CustomerID>
<CustomerName>sample string 4</CustomerName>
<TemplateCustomerMappingID>1</TemplateCustomerMappingID>
<TemplateID>2</TemplateID>
</ServiceTemplateCustomersDataModel>
<ServiceTemplateCustomersDataModel>
<CustomerEmail>sample string 5</CustomerEmail>
<CustomerID>3</CustomerID>
<CustomerName>sample string 4</CustomerName>
<TemplateCustomerMappingID>1</TemplateCustomerMappingID>
<TemplateID>2</TemplateID>
</ServiceTemplateCustomersDataModel>
</lstCustomers>
<lstParts>
<ServiceTemplatePartsDataModel>
<Description>sample string 16</Description>
<DiscountPercentage>15</DiscountPercentage>
<PartsCode>sample string 4</PartsCode>
<PartsID>3</PartsID>
<PartsName>sample string 5</PartsName>
<Quantity>6</Quantity>
<TaxAmount>13</TaxAmount>
<TaxPercentage>12</TaxPercentage>
<TaxRate>14</TaxRate>
<TaxRateID>11</TaxRateID>
<TemplateID>2</TemplateID>
<TemplateServicePartsID>1</TemplateServicePartsID>
<TotalPrice>10</TotalPrice>
<UOM>sample string 17</UOM>
<UOMID>7</UOMID>
<Unit>sample string 8</Unit>
<UnitPrice>9</UnitPrice>
<Warranty>sample string 18</Warranty>
</ServiceTemplatePartsDataModel>
<ServiceTemplatePartsDataModel>
<Description>sample string 16</Description>
<DiscountPercentage>15</DiscountPercentage>
<PartsCode>sample string 4</PartsCode>
<PartsID>3</PartsID>
<PartsName>sample string 5</PartsName>
<Quantity>6</Quantity>
<TaxAmount>13</TaxAmount>
<TaxPercentage>12</TaxPercentage>
<TaxRate>14</TaxRate>
<TaxRateID>11</TaxRateID>
<TemplateID>2</TemplateID>
<TemplateServicePartsID>1</TemplateServicePartsID>
<TotalPrice>10</TotalPrice>
<UOM>sample string 17</UOM>
<UOMID>7</UOMID>
<Unit>sample string 8</Unit>
<UnitPrice>9</UnitPrice>
<Warranty>sample string 18</Warranty>
</ServiceTemplatePartsDataModel>
</lstParts>
</ServiceTemplateDataModel>
</_objServiceTemplate>
</ServiceTemplateReponseDataModel>
multipart/form-data
Sample:
<ServiceTemplateReponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</TotalRecord><_objServiceTemplate><ServiceTemplateDataModel><AddedBy>1</AddedBy><AddedDate>2025-07-17T05:14:31.9268255+00:00</AddedDate><Description>sample string 2</Description><IsActive>1</IsActive><IsDeleted>1</IsDeleted><ModifiedBy>1</ModifiedBy><ModifiedDate>2025-07-17T05:14:31.9268255+00:00</ModifiedDate><TemplateID>1</TemplateID><TemplateName>sample string 1</TemplateName><TotalRecord>3</TotalRecord><lstCustomers><ServiceTemplateCustomersDataModel><CustomerEmail>sample string 5</CustomerEmail><CustomerID>3</CustomerID><CustomerName>sample string 4</CustomerName><TemplateCustomerMappingID>1</TemplateCustomerMappingID><TemplateID>2</TemplateID></ServiceTemplateCustomersDataModel><ServiceTemplateCustomersDataModel><CustomerEmail>sample string 5</CustomerEmail><CustomerID>3</CustomerID><CustomerName>sample string 4</CustomerName><TemplateCustomerMappingID>1</TemplateCustomerMappingID><TemplateID>2</TemplateID></ServiceTemplateCustomersDataModel></lstCustomers><lstParts><ServiceTemplatePartsDataModel><Description>sample string 16</Description><DiscountPercentage>15</DiscountPercentage><PartsCode>sample string 4</PartsCode><PartsID>3</PartsID><PartsName>sample string 5</PartsName><Quantity>6</Quantity><TaxAmount>13</TaxAmount><TaxPercentage>12</TaxPercentage><TaxRate>14</TaxRate><TaxRateID>11</TaxRateID><TemplateID>2</TemplateID><TemplateServicePartsID>1</TemplateServicePartsID><TotalPrice>10</TotalPrice><UOM>sample string 17</UOM><UOMID>7</UOMID><Unit>sample string 8</Unit><UnitPrice>9</UnitPrice><Warranty>sample string 18</Warranty></ServiceTemplatePartsDataModel><ServiceTemplatePartsDataModel><Description>sample string 16</Description><DiscountPercentage>15</DiscountPercentage><PartsCode>sample string 4</PartsCode><PartsID>3</PartsID><PartsName>sample string 5</PartsName><Quantity>6</Quantity><TaxAmount>13</TaxAmount><TaxPercentage>12</TaxPercentage><TaxRate>14</TaxRate><TaxRateID>11</TaxRateID><TemplateID>2</TemplateID><TemplateServicePartsID>1</TemplateServicePartsID><TotalPrice>10</TotalPrice><UOM>sample string 17</UOM><UOMID>7</UOMID><Unit>sample string 8</Unit><UnitPrice>9</UnitPrice><Warranty>sample string 18</Warranty></ServiceTemplatePartsDataModel></lstParts></ServiceTemplateDataModel><ServiceTemplateDataModel><AddedBy>1</AddedBy><AddedDate>2025-07-17T05:14:31.9268255+00:00</AddedDate><Description>sample string 2</Description><IsActive>1</IsActive><IsDeleted>1</IsDeleted><ModifiedBy>1</ModifiedBy><ModifiedDate>2025-07-17T05:14:31.9268255+00:00</ModifiedDate><TemplateID>1</TemplateID><TemplateName>sample string 1</TemplateName><TotalRecord>3</TotalRecord><lstCustomers><ServiceTemplateCustomersDataModel><CustomerEmail>sample string 5</CustomerEmail><CustomerID>3</CustomerID><CustomerName>sample string 4</CustomerName><TemplateCustomerMappingID>1</TemplateCustomerMappingID><TemplateID>2</TemplateID></ServiceTemplateCustomersDataModel><ServiceTemplateCustomersDataModel><CustomerEmail>sample string 5</CustomerEmail><CustomerID>3</CustomerID><CustomerName>sample string 4</CustomerName><TemplateCustomerMappingID>1</TemplateCustomerMappingID><TemplateID>2</TemplateID></ServiceTemplateCustomersDataModel></lstCustomers><lstParts><ServiceTemplatePartsDataModel><Description>sample string 16</Description><DiscountPercentage>15</DiscountPercentage><PartsCode>sample string 4</PartsCode><PartsID>3</PartsID><PartsName>sample string 5</PartsName><Quantity>6</Quantity><TaxAmount>13</TaxAmount><TaxPercentage>12</TaxPercentage><TaxRate>14</TaxRate><TaxRateID>11</TaxRateID><TemplateID>2</TemplateID><TemplateServicePartsID>1</TemplateServicePartsID><TotalPrice>10</TotalPrice><UOM>sample string 17</UOM><UOMID>7</UOMID><Unit>sample string 8</Unit><UnitPrice>9</UnitPrice><Warranty>sample string 18</Warranty></ServiceTemplatePartsDataModel><ServiceTemplatePartsDataModel><Description>sample string 16</Description><DiscountPercentage>15</DiscountPercentage><PartsCode>sample string 4</PartsCode><PartsID>3</PartsID><PartsName>sample string 5</PartsName><Quantity>6</Quantity><TaxAmount>13</TaxAmount><TaxPercentage>12</TaxPercentage><TaxRate>14</TaxRate><TaxRateID>11</TaxRateID><TemplateID>2</TemplateID><TemplateServicePartsID>1</TemplateServicePartsID><TotalPrice>10</TotalPrice><UOM>sample string 17</UOM><UOMID>7</UOMID><Unit>sample string 8</Unit><UnitPrice>9</UnitPrice><Warranty>sample string 18</Warranty></ServiceTemplatePartsDataModel></lstParts></ServiceTemplateDataModel></_objServiceTemplate></ServiceTemplateReponseDataModel>