Needio.Services

<back to all web services

AddCommentTicketRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/HelpDesk/AddCommentTicket/
AddCommentTicketRequest Parameters:
NameParameterData TypeRequiredDescription
TicketIdqueryintNo
CommentquerystringNo
MediasqueryList<MediaDTO>No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
AddCommentTicketResponse Parameters:
NameParameterData TypeRequiredDescription
TicketformTicketDetailDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
TicketDetailDTO Parameters:
NameParameterData TypeRequiredDescription
AssignedToformstringNo
LastUpdateByformstringNo
CurrentStatusSetByformstringNo
OwnerformstringNo
CreatedByformstringNo
CreatedDateformDateTimeOffsetNo
CurrentStatusDateformDateTimeOffsetNo
LastUpdateDateformDateTimeOffsetNo
EventsformList<TicketEventDTO>No
TicketTagsformList<TicketTagDTO>No
ShowAlertformboolNo
TicketDTO Parameters:
NameParameterData TypeRequiredDescription
TicketIdformintNo
TicketTypeformTicketTypesNo
CategoryformTicketCategoriesNo
TitleformstringNo
DetailsformstringNo
IsHtmlformboolNo
TagListformstringNo
StatusformTicketStatusesNo
PriorityformTicketPrioritiesNo
AffectsCustomerformboolNo
PostIdformint?No
TransIdformint?No
StoreIdformint?No
SessionIdformstringNo
UserIdformintNo
ReturnIdformint?No
TicketEventformTicketEventDTONo
TicketTypes Enum:
NameValue
Problem0
Question1
Request2
Proposal3
TicketCategories Enum:
NameValue
General0
Profile1
Post2
Store3
Transaction4
Payment5
Delivery6
Refund7
Chat8
Campaigns9
SSS10
TicketStatuses Enum:
NameValue
Active0
MoreInfo1
Resolved2
Closed3
TicketPriorities Enum:
NameValue
High0
Medium1
Low2
TicketEventDTO Parameters:
NameParameterData TypeRequiredDescription
EventIdformintNo
TicketIdformintNo
EventDescriptionformstringNo
CommentformstringNo
IsHtmlformboolNo
EventByformstringNo
EventByIdformintNo
EventDateformDateTimeNo
MediasformList<MediaDTO>No
MediaDTO Parameters:
NameParameterData TypeRequiredDescription
PostIdformintNo
MediaIdformint?No
UsageTypeformUsageTypesNo
MediaTypeformMediaTypesNo
SourceformstringNo
MediaFileNameformstringNo
MediaMimeformstringNo
IsMainformboolNo
RefIdformint?No
OrderNumformintNo
ActionformDBActionNo
IsDeletedformboolNo
FriendlyURLformstringNo
PostVariantA1KeyformstringNo
SourceUrlformstringNo
ActiveYnformboolNo
UsageTypes Enum:
NameValue
StoreMedias1
StoreFiles2
MediaTypes Enum:
NameValue
icon0
Image1
Video2
Youtube3
Pdf8
File9
ThreeD10
Custom99
DBAction Enum:
NameValue
None0
Insert1
Update2
Delete3
TicketTagDTO Parameters:
NameParameterData TypeRequiredDescription
TicketTagIdformintNo
TagNameformstringNo
TicketIdformintNo
AddCommentTicketResponse Parameters:
NameParameterData TypeRequiredDescription
TicketformTicketDetailDTONo

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/AddCommentTicket/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddCommentTicketRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <Comment>String</Comment>
  <Medias xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <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>
  </Medias>
  <TicketId>0</TicketId>
</AddCommentTicketRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddCommentTicketResponse 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>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Ticket xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:AffectsCustomer>false</d2p1:AffectsCustomer>
    <d2p1:Category>General</d2p1:Category>
    <d2p1:Details>String</d2p1:Details>
    <d2p1:IsHtml>false</d2p1:IsHtml>
    <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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:CurrentStatusDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1: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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1: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>
  </Ticket>
</AddCommentTicketResponse>