POST api/V3/CueCardsMetrics/PostExtMetric

External Api for CueCards

Request Information

URI Parameters

None.

Body Parameters

ExternalMetrics
NameDescriptionTypeAdditional information
MetricErpId

string

None.
EntityType

Enum (1 for outlet, 2 for user)

 CueCardEntityType

None.
EntityErpId

string

None.
MetricValue

string

None.
Guid

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "MetricErpId": "sample string 1",
  "EntityType": "Outlet",
  "EntityErpId": "sample string 2",
  "MetricValue": "sample string 3",
  "Guid": "sample string 4"
}

application/xml, text/xml

Sample: 
<ExternalMetrics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <EntityErpId>sample string 2</EntityErpId>
  <EntityType>Outlet</EntityType>
  <Guid>sample string 4</Guid>
  <MetricErpId>sample string 1</MetricErpId>
  <MetricValue>sample string 3</MetricValue>
</ExternalMetrics>

Response Information

Resource Description

ApiResponseMessage
NameDescriptionTypeAdditional information
ERPId

ERPID of the Requested insertion/updation

 string

None.
Message

Error Message for the indicated ERPID

 string

None.
ResponseStatus

Status of the action requested from Api

 ResponseStatus

None.
GUID

GUID of the database Entry with respect to the ERP Id Provided

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ERPId": "sample string 1",
  "Message": "sample string 2",
  "ResponseStatus": "Failure",
  "GUID": "sample string 3"
}

application/xml, text/xml

Sample: 
<ApiResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <ERPId>sample string 1</ERPId>
  <GUID>sample string 3</GUID>
  <Message>sample string 2</Message>
  <ResponseStatus>Failure</ResponseStatus>
</ApiResponseMessage>