Jump to: navigation, search

GetCategory

Purpose

This method is intended for downloading of the Category, and category sub-tree, from server to client. Only Id, StandardResponseId and TheName attributes are returned for each SRL. The GetStandardResponse method is used to get each SR detailed information.

URL

  • GET /OMResponse/GetCategory/


Request

Parameters

Key ValueType Value Description Mandatory Unique Default
CategoryId String Root Category to start from. Only sub-categories of this category will be returned. true true
ReturnChildrenCategories String true or false false true true
ReturnChildrenSRInfo String true or false Will return fields TheName and Id for children standard responses. false true true

Success

CategoryId KVList

Key ValueType Value Description Mandatory Unique Default
Name String true true
ModifiedDate String (in format "yyyy-MM-ddTHH:mm:ss.SSSZ") true true
Status String true true
Type Integer true true
Description String true true
ChildrenCategories KVList Is not returned if "ReturnChildrenCategories = false" false true
ChildrenStdResponses KVList Is not returned if "ReturnChildrenSRInfo = false" false true


ChildrenCategories KVList

Key ValueType Value Description Mandatory Unique Default
(CategoryId) KVList false true


ChildrenStdResponses KVList

Key ValueType Value Description Mandatory Unique Default
(StandardResponseId) KVList Id Field in StandardResponse table. false true


StandardResponseId

Key ValueType Value Description Mandatory Unique Default
StandardResponseId String StandardResponseId field in StandardResponse table. true true
TheName String true true


Error

FaultCode FaultString Description
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.