Needio.Services

GetTicketListRequest

**Requires Authentication**
Required role:	Approved

The following routes are available for this service:
All Verbs	/HelpDesk/GetTicketList/

**GetTicketListRequest** Parameters:
Name	Parameter	Data Type	Required
Status	query	TicketStatuses	No
AllYn	query	bool	No
Count	query	int	No
Page	query	int	No
SearchText	query	string	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
start	form	DateTime	No
DeviceUUID	form	string	No
APIKey	form	string	No
isAdmin	form	bool	No
Cmd	form	string	No

**GetTicketListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
TicketList	form	List<TicketDetailDTO>	No
TotalCount	form	int	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Result	form	bool	No
ResMessage	form	string	No
Error	form	Error	No
PageInfo	form	BasePageInfo	No

**Error** Parameters:
Name	Parameter	Data Type	Required
ErrorYn	form	bool	No
ExYn	form	bool	No
ErrorCode	form	string	No
ErrorDescription	form	string	No

**BasePageInfo** Parameters:
Name	Parameter	Data Type	Required
TotalRecordCount	form	int	No
TotalPageCount	form	int	No
CurrentPage	form	int	No

**TicketDetailDTO** Parameters:
Name	Parameter	Data Type	Required
AssignedTo	form	string	No
LastUpdateBy	form	string	No
CurrentStatusSetBy	form	string	No
Owner	form	string	No
CreatedBy	form	string	No
CreatedDate	form	DateTimeOffset	No
CurrentStatusDate	form	DateTimeOffset	No
LastUpdateDate	form	DateTimeOffset	No
Events	form	List<TicketEventDTO>	No
TicketTags	form	List<TicketTagDTO>	No
ShowAlert	form	bool	No

**TicketDTO** Parameters:
Name	Parameter	Data Type	Required
TicketId	form	int	No
TicketType	form	TicketTypes	No
Category	form	TicketCategories	No
Title	form	string	No
Details	form	string	No
IsHtml	form	bool	No
TagList	form	string	No
Status	form	TicketStatuses	No
Priority	form	TicketPriorities	No
AffectsCustomer	form	bool	No
PostId	form	int?	No
TransId	form	int?	No
StoreId	form	int?	No
SessionId	form	string	No
UserId	form	int	No
ReturnId	form	int?	No
TicketEvent	form	TicketEventDTO	No
Phone	form	string	No

**TicketTypes** Enum:
Name	Value
Problem	0
Question	1
Request	2
Proposal	3

**TicketCategories** Enum:
Name	Value
General	0
Profile	1
Post	2
Store	3
Transaction	4
Payment	5
Delivery	6
Refund	7
Chat	8
Campaigns	9
SSS	10
Information	11
CloseStore	21

**TicketStatuses** Enum:
Name	Value
Active	0
MoreInfo	1
Resolved	2
Closed	3

**TicketPriorities** Enum:
Name	Value
High	0
Medium	1
Low	2

**TicketEventDTO** Parameters:
Name	Parameter	Data Type	Required
EventId	form	int	No
TicketId	form	int	No
EventDescription	form	string	No
Comment	form	string	No
IsHtml	form	bool	No
EventBy	form	string	No
EventById	form	int	No
EventDate	form	DateTime	No
Medias	form	List<MediaDTO>	No

**MediaDTO** Parameters:
Name	Parameter	Data Type	Required
PostId	form	int	No
MediaId	form	int?	No
UsageType	form	UsageTypes	No
MediaType	form	MediaTypes	No
Source	form	string	No
MediaFileName	form	string	No
MediaMime	form	string	No
IsMain	form	bool	No
RefId	form	int?	No
OrderNum	form	int	No
Action	form	DBAction	No
IsDeleted	form	bool	No
FriendlyURL	form	string	No
PostVariantA1Key	form	string	No
SourceUrl	form	string	No
ActiveYn	form	bool	No

**UsageTypes** Enum:
Name	Value
StoreMedias	1
StoreFiles	2

**MediaTypes** Enum:
Name	Value
icon	0
Image	1
Video	2
Youtube	3
Pdf	8
File	9
ThreeD	10
Custom	99

**DBAction** Enum:
Name	Value
None	0
Insert	1
Update	2
Delete	3

**TicketTagDTO** Parameters:
Name	Parameter	Data Type	Required
TicketTagId	form	int	No
TagName	form	string	No
TicketId	form	int	No

**GetTicketListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
TicketList	form	List<TicketDetailDTO>	No
TotalCount	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /HelpDesk/GetTicketList/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetTicketListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <AllYn>false</AllYn>
  <Count>0</Count>
  <Page>0</Page>
  <SearchText>String</SearchText>
  <Status>Active</Status>
</GetTicketListRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTicketListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <TicketList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:TicketDetailDTO>
      <d2p1:AffectsCustomer>false</d2p1:AffectsCustomer>
      <d2p1:Category>General</d2p1:Category>
      <d2p1:Details>String</d2p1:Details>
      <d2p1:IsHtml>false</d2p1:IsHtml>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PostId>0</d2p1:PostId>
      <d2p1:Priority>High</d2p1:Priority>
      <d2p1:ReturnId>0</d2p1:ReturnId>
      <d2p1:SessionId>String</d2p1:SessionId>
      <d2p1:Status>Active</d2p1:Status>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:TagList>String</d2p1:TagList>
      <d2p1:TicketEvent>
        <d2p1:Comment>String</d2p1:Comment>
        <d2p1:EventBy>String</d2p1:EventBy>
        <d2p1:EventById>0</d2p1:EventById>
        <d2p1:EventDate>0001-01-01T00:00:00</d2p1:EventDate>
        <d2p1:EventDescription>String</d2p1:EventDescription>
        <d2p1:EventId>0</d2p1:EventId>
        <d2p1:IsHtml>false</d2p1:IsHtml>
        <d2p1:Medias>
          <d2p1:MediaDTO>
            <d2p1:Action>None</d2p1:Action>
            <d2p1:ActiveYn>false</d2p1:ActiveYn>
            <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
            <d2p1:IsDeleted>false</d2p1:IsDeleted>
            <d2p1:IsMain>false</d2p1:IsMain>
            <d2p1:MediaFileName>String</d2p1:MediaFileName>
            <d2p1:MediaId>0</d2p1:MediaId>
            <d2p1:MediaMime>String</d2p1:MediaMime>
            <d2p1:MediaType>icon</d2p1:MediaType>
            <d2p1:OrderNum>0</d2p1:OrderNum>
            <d2p1:PostId>0</d2p1:PostId>
            <d2p1:PostVariantA1Key>String</d2p1:PostVariantA1Key>
            <d2p1:RefId>0</d2p1:RefId>
            <d2p1:Source>String</d2p1:Source>
            <d2p1:SourceUrl>String</d2p1:SourceUrl>
            <d2p1:UsageType>StoreMedias</d2p1:UsageType>
          </d2p1:MediaDTO>
        </d2p1:Medias>
        <d2p1:TicketId>0</d2p1:TicketId>
      </d2p1:TicketEvent>
      <d2p1:TicketId>0</d2p1:TicketId>
      <d2p1:TicketType>Problem</d2p1:TicketType>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:TransId>0</d2p1:TransId>
      <d2p1:UserId>0</d2p1:UserId>
      <d2p1:AssignedTo>String</d2p1:AssignedTo>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:CreatedDate>
      <d2p1:CurrentStatusDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:CurrentStatusDate>
      <d2p1:CurrentStatusSetBy>String</d2p1:CurrentStatusSetBy>
      <d2p1:Events>
        <d2p1:TicketEventDTO>
          <d2p1:Comment>String</d2p1:Comment>
          <d2p1:EventBy>String</d2p1:EventBy>
          <d2p1:EventById>0</d2p1:EventById>
          <d2p1:EventDate>0001-01-01T00:00:00</d2p1:EventDate>
          <d2p1:EventDescription>String</d2p1:EventDescription>
          <d2p1:EventId>0</d2p1:EventId>
          <d2p1:IsHtml>false</d2p1:IsHtml>
          <d2p1:Medias>
            <d2p1:MediaDTO>
              <d2p1:Action>None</d2p1:Action>
              <d2p1:ActiveYn>false</d2p1:ActiveYn>
              <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
              <d2p1:IsDeleted>false</d2p1:IsDeleted>
              <d2p1:IsMain>false</d2p1:IsMain>
              <d2p1:MediaFileName>String</d2p1:MediaFileName>
              <d2p1:MediaId>0</d2p1:MediaId>
              <d2p1:MediaMime>String</d2p1:MediaMime>
              <d2p1:MediaType>icon</d2p1:MediaType>
              <d2p1:OrderNum>0</d2p1:OrderNum>
              <d2p1:PostId>0</d2p1:PostId>
              <d2p1:PostVariantA1Key>String</d2p1:PostVariantA1Key>
              <d2p1:RefId>0</d2p1:RefId>
              <d2p1:Source>String</d2p1:Source>
              <d2p1:SourceUrl>String</d2p1:SourceUrl>
              <d2p1:UsageType>StoreMedias</d2p1:UsageType>
            </d2p1:MediaDTO>
          </d2p1:Medias>
          <d2p1:TicketId>0</d2p1:TicketId>
        </d2p1:TicketEventDTO>
      </d2p1:Events>
      <d2p1:LastUpdateBy>String</d2p1:LastUpdateBy>
      <d2p1:LastUpdateDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:LastUpdateDate>
      <d2p1:Owner>String</d2p1:Owner>
      <d2p1:ShowAlert>false</d2p1:ShowAlert>
      <d2p1:TicketTags>
        <d2p1:TicketTagDTO>
          <d2p1:TagName>String</d2p1:TagName>
          <d2p1:TicketId>0</d2p1:TicketId>
          <d2p1:TicketTagId>0</d2p1:TicketTagId>
        </d2p1:TicketTagDTO>
      </d2p1:TicketTags>
    </d2p1:TicketDetailDTO>
  </TicketList>
  <TotalCount>0</TotalCount>
</GetTicketListResponse>