POST api/templates/selectProgrammatic

Retrieves a list of templates that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter templates by.

Name	Type	Additional information
TenantId	globally unique identifier	None.
TemplateCode	globally unique identifier	None.
WorkflowDefinitionCode	globally unique identifier	None.
IsDeleted	boolean	None.
IsPublished	boolean	None.
IsExpired	boolean	None.
TemplateType	TemplateTypeDto	None.
FolderId	globally unique identifier	None.
BudgetCodes	Collection of string	None.
HasAssociatedSchema	boolean	None.
ProductCodes	Collection of string	None.
IsProgrammatic	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "TenantId": "245a2f8d-54ec-4fa5-bb31-c9864e9acf6a",
  "TemplateCode": "bc1229a8-3366-433b-8737-a072fadd473c",
  "WorkflowDefinitionCode": "b0be0f50-095d-4362-9fd7-762b6760c1ed",
  "IsDeleted": true,
  "IsPublished": true,
  "IsExpired": true,
  "TemplateType": 1,
  "FolderId": "bad02be0-ba0d-44b2-80b6-bf3f913f845c",
  "BudgetCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "HasAssociatedSchema": true,
  "ProductCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "IsProgrammatic": true
}

application/xml, text/xml

Sample:

<TemplatesFilterCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Template.Models.FilterCriteria">
  <BudgetCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BudgetCodes>
  <FolderId>bad02be0-ba0d-44b2-80b6-bf3f913f845c</FolderId>
  <HasAssociatedSchema>true</HasAssociatedSchema>
  <IsDeleted>true</IsDeleted>
  <IsExpired>true</IsExpired>
  <IsProgrammatic>true</IsProgrammatic>
  <IsPublished>true</IsPublished>
  <ProductCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ProductCodes>
  <TemplateCode>bc1229a8-3366-433b-8737-a072fadd473c</TemplateCode>
  <TemplateType>DirectMail</TemplateType>
  <TenantId>245a2f8d-54ec-4fa5-bb31-c9864e9acf6a</TenantId>
  <WorkflowDefinitionCode>b0be0f50-095d-4362-9fd7-762b6760c1ed</WorkflowDefinitionCode>
</TemplatesFilterCriteria>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TemplatesFilterCriteria'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.