Jump to: navigation, search

GetStandardResponses

Purpose

This method is intended for downloading of all the versions of a Standard Response content for a standard response ID from server to client. No attachment content is returned, only Name, MimeType, Description, and Size.

URL

  • GET /OMResponse/GetStandardResponses/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
StandardResponseId String StandardResponseId field. Returns all historical versions that exist. true true
Attachments String true or false Return the attachment summaries (without content), if any, with the revisions. (Added in 8.1.4) false true

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
StdResp KVList A collection of versions of Standard Response for a Standard Response ID. true true
Attachments KVList A collection of Documents with Id as the key and: TheName, TheSize, MimeType and Description as values. false true


Versions KVList

Key ValueType Value Description Mandatory Unique Default
(version number) KVList A collection of Standard Response attributes for a version. true false NO


Standard Response KVList

Key ValueType Value Description Mandatory Unique Default
Id String Id field of a SR true true
StandardResponseId String StandardResponseId field of a SR true true
Body String false true
TheName String true true
Description String false true
IsActive String true true
Version Integer true true
OwnerId Integer true true
ModifiedDate String (in format "yyyy-MM-ddTHH:mm:ss.SSSZ") true true
Status String "Approved", "NotApproved" true true
ExpirationDate String (in format "yyyy-MM-ddTHH:mm:ss.SSSZ") true true
Lang String true true
AckUsageType String Values are

- "Automatic", - "Manual", - "Not Used"

true true
AgentDesktopUsageType String Values are

- "Automatic", - "Manual", - "Not Used"

true true
AutoRespUsageType String Values are

- "Automatic", - "Manual", - "Not Used"

The auto response usage type of the Standard Response true true
EmailOutUsageType String Values are

- "Automatic", - "Manual", - "Not Used"

The email-out usage type of the Standard Response. Available only if Version was provided. true true
VoiceAutoRespUsageType String Values are

- "Automatic", - "Manual", - "Not Used"

The voice auto response usage type of the Standard Response. Available only if Version was provided. true true
WSSUsageType String Values are

- "Automatic", - "Manual", - "Not Used"

The WSS usage type of the Standard Response. Available only if Version was provided. true true
Subject String false true
StartDate String (in format "yyyy-MM-ddTHH:mm:ss.SSSZ") true true
MimeType String false true
CustomFieldCodes String false true
StructuredBody String false true
Attachments KVList false true


Attachments KVList

Key ValueType Value Description Mandatory Unique Default
(DocumentId) KVList DocumentId is the unique identifier of a Document false true


KVList

Key ValueType Value Description Mandatory Unique Default
MimeType String Attachment Mime Type true true
TheName String Attachment name true true
Description String Attachment description false true
TheSize Integer Attachment size true true


Error

FaultCode FaultString Description
204 Incorrect value for parameter {0}, expected {1} but was {2} Incorrect value for parameter
510 {0} not found in database Record is not found in database

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.