GET api/modules/supportdesk/configurations?ticketEntityDefinitionId={ticketEntityDefinitionId}

Gets a SupportDeskConfiguration collection related to a specific EntityDefinition that acts as a SupportDesk Ticket.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
ticketEntityDefinitionId

The id of the EntityDefinition.

integer

Required



Body Parameters

None.



Response Information

Resource Description

A ReadSupportDeskConfigurationViewModel collection, representing the requested SupportDeskConfiguration collection, if no errors occurred; an HTTP exception, otherwise.

Collection of ReadSupportDeskConfigurationViewModel

NameDescriptionTypeAdditional information
Description

string

None.

Id

integer

None.

MailAccounts

Collection of ReadSupportDeskMailAccountViewModel

None.

MailTemplates

Collection of ReadSupportDeskMailTemplateViewModel

None.

RelationDossierId

integer

None.

RelationEmailAttributeId

integer

None.

RelationSupportInstanceListId

integer

None.

RelationSupportInstanceListObjectAttributeId

integer

None.

SupportInstanceAmbiguousRelationStatus

string

None.

SupportInstanceAssignedToAttributeId

integer

None.

SupportInstanceDescriptionAttributeId

integer

None.

SupportInstanceDossierId

integer

None.

SupportInstanceNewStatus

string

None.

SupportInstanceNoRelationFoundStatus

string

None.

SupportInstanceStatusAttributeId

integer

None.

SupportInstanceSubjectAttributeId

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Description": "sample string 1",
    "Id": 2,
    "MailAccounts": [
      {
        "ApiTypeId": 1,
        "Description": "sample string 1",
        "EmailAddress": "sample string 2",
        "Id": 3,
        "IsConfigured": true,
        "SharedMailBox": "sample string 5",
        "Signature": "sample string 6",
        "SupportDeskConfigurationId": 7
      },
      {
        "ApiTypeId": 1,
        "Description": "sample string 1",
        "EmailAddress": "sample string 2",
        "Id": 3,
        "IsConfigured": true,
        "SharedMailBox": "sample string 5",
        "Signature": "sample string 6",
        "SupportDeskConfigurationId": 7
      }
    ],
    "MailTemplates": [
      {
        "Description": "sample string 1",
        "Id": 2,
        "MailText": "sample string 3"
      },
      {
        "Description": "sample string 1",
        "Id": 2,
        "MailText": "sample string 3"
      }
    ],
    "RelationDossierId": 1,
    "RelationEmailAttributeId": 1,
    "RelationSupportInstanceListId": 1,
    "RelationSupportInstanceListObjectAttributeId": 1,
    "SupportInstanceAmbiguousRelationStatus": "sample string 3",
    "SupportInstanceAssignedToAttributeId": 1,
    "SupportInstanceDescriptionAttributeId": 1,
    "SupportInstanceDossierId": 1,
    "SupportInstanceNewStatus": "sample string 4",
    "SupportInstanceNoRelationFoundStatus": "sample string 5",
    "SupportInstanceStatusAttributeId": 1,
    "SupportInstanceSubjectAttributeId": 1
  },
  {
    "Description": "sample string 1",
    "Id": 2,
    "MailAccounts": [
      {
        "ApiTypeId": 1,
        "Description": "sample string 1",
        "EmailAddress": "sample string 2",
        "Id": 3,
        "IsConfigured": true,
        "SharedMailBox": "sample string 5",
        "Signature": "sample string 6",
        "SupportDeskConfigurationId": 7
      },
      {
        "ApiTypeId": 1,
        "Description": "sample string 1",
        "EmailAddress": "sample string 2",
        "Id": 3,
        "IsConfigured": true,
        "SharedMailBox": "sample string 5",
        "Signature": "sample string 6",
        "SupportDeskConfigurationId": 7
      }
    ],
    "MailTemplates": [
      {
        "Description": "sample string 1",
        "Id": 2,
        "MailText": "sample string 3"
      },
      {
        "Description": "sample string 1",
        "Id": 2,
        "MailText": "sample string 3"
      }
    ],
    "RelationDossierId": 1,
    "RelationEmailAttributeId": 1,
    "RelationSupportInstanceListId": 1,
    "RelationSupportInstanceListObjectAttributeId": 1,
    "SupportInstanceAmbiguousRelationStatus": "sample string 3",
    "SupportInstanceAssignedToAttributeId": 1,
    "SupportInstanceDescriptionAttributeId": 1,
    "SupportInstanceDossierId": 1,
    "SupportInstanceNewStatus": "sample string 4",
    "SupportInstanceNoRelationFoundStatus": "sample string 5",
    "SupportInstanceStatusAttributeId": 1,
    "SupportInstanceSubjectAttributeId": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfReadSupportDeskConfigurationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels">
  <ReadSupportDeskConfigurationViewModel>
    <Description>sample string 1</Description>
    <Id>2</Id>
    <MailAccounts>
      <ReadSupportDeskMailAccountViewModel>
        <ApiTypeId>1</ApiTypeId>
        <Description>sample string 1</Description>
        <EmailAddress>sample string 2</EmailAddress>
        <Id>3</Id>
        <IsConfigured>true</IsConfigured>
        <SharedMailBox>sample string 5</SharedMailBox>
        <Signature>sample string 6</Signature>
        <SupportDeskConfigurationId>7</SupportDeskConfigurationId>
      </ReadSupportDeskMailAccountViewModel>
      <ReadSupportDeskMailAccountViewModel>
        <ApiTypeId>1</ApiTypeId>
        <Description>sample string 1</Description>
        <EmailAddress>sample string 2</EmailAddress>
        <Id>3</Id>
        <IsConfigured>true</IsConfigured>
        <SharedMailBox>sample string 5</SharedMailBox>
        <Signature>sample string 6</Signature>
        <SupportDeskConfigurationId>7</SupportDeskConfigurationId>
      </ReadSupportDeskMailAccountViewModel>
    </MailAccounts>
    <MailTemplates>
      <ReadSupportDeskMailTemplateViewModel>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <MailText>sample string 3</MailText>
      </ReadSupportDeskMailTemplateViewModel>
      <ReadSupportDeskMailTemplateViewModel>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <MailText>sample string 3</MailText>
      </ReadSupportDeskMailTemplateViewModel>
    </MailTemplates>
    <RelationDossierId>1</RelationDossierId>
    <RelationEmailAttributeId>1</RelationEmailAttributeId>
    <RelationSupportInstanceListId>1</RelationSupportInstanceListId>
    <RelationSupportInstanceListObjectAttributeId>1</RelationSupportInstanceListObjectAttributeId>
    <SupportInstanceAmbiguousRelationStatus>sample string 3</SupportInstanceAmbiguousRelationStatus>
    <SupportInstanceAssignedToAttributeId>1</SupportInstanceAssignedToAttributeId>
    <SupportInstanceDescriptionAttributeId>1</SupportInstanceDescriptionAttributeId>
    <SupportInstanceDossierId>1</SupportInstanceDossierId>
    <SupportInstanceNewStatus>sample string 4</SupportInstanceNewStatus>
    <SupportInstanceNoRelationFoundStatus>sample string 5</SupportInstanceNoRelationFoundStatus>
    <SupportInstanceStatusAttributeId>1</SupportInstanceStatusAttributeId>
    <SupportInstanceSubjectAttributeId>1</SupportInstanceSubjectAttributeId>
  </ReadSupportDeskConfigurationViewModel>
  <ReadSupportDeskConfigurationViewModel>
    <Description>sample string 1</Description>
    <Id>2</Id>
    <MailAccounts>
      <ReadSupportDeskMailAccountViewModel>
        <ApiTypeId>1</ApiTypeId>
        <Description>sample string 1</Description>
        <EmailAddress>sample string 2</EmailAddress>
        <Id>3</Id>
        <IsConfigured>true</IsConfigured>
        <SharedMailBox>sample string 5</SharedMailBox>
        <Signature>sample string 6</Signature>
        <SupportDeskConfigurationId>7</SupportDeskConfigurationId>
      </ReadSupportDeskMailAccountViewModel>
      <ReadSupportDeskMailAccountViewModel>
        <ApiTypeId>1</ApiTypeId>
        <Description>sample string 1</Description>
        <EmailAddress>sample string 2</EmailAddress>
        <Id>3</Id>
        <IsConfigured>true</IsConfigured>
        <SharedMailBox>sample string 5</SharedMailBox>
        <Signature>sample string 6</Signature>
        <SupportDeskConfigurationId>7</SupportDeskConfigurationId>
      </ReadSupportDeskMailAccountViewModel>
    </MailAccounts>
    <MailTemplates>
      <ReadSupportDeskMailTemplateViewModel>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <MailText>sample string 3</MailText>
      </ReadSupportDeskMailTemplateViewModel>
      <ReadSupportDeskMailTemplateViewModel>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <MailText>sample string 3</MailText>
      </ReadSupportDeskMailTemplateViewModel>
    </MailTemplates>
    <RelationDossierId>1</RelationDossierId>
    <RelationEmailAttributeId>1</RelationEmailAttributeId>
    <RelationSupportInstanceListId>1</RelationSupportInstanceListId>
    <RelationSupportInstanceListObjectAttributeId>1</RelationSupportInstanceListObjectAttributeId>
    <SupportInstanceAmbiguousRelationStatus>sample string 3</SupportInstanceAmbiguousRelationStatus>
    <SupportInstanceAssignedToAttributeId>1</SupportInstanceAssignedToAttributeId>
    <SupportInstanceDescriptionAttributeId>1</SupportInstanceDescriptionAttributeId>
    <SupportInstanceDossierId>1</SupportInstanceDossierId>
    <SupportInstanceNewStatus>sample string 4</SupportInstanceNewStatus>
    <SupportInstanceNoRelationFoundStatus>sample string 5</SupportInstanceNoRelationFoundStatus>
    <SupportInstanceStatusAttributeId>1</SupportInstanceStatusAttributeId>
    <SupportInstanceSubjectAttributeId>1</SupportInstanceSubjectAttributeId>
  </ReadSupportDeskConfigurationViewModel>
</ArrayOfReadSupportDeskConfigurationViewModel>