GET api/ArgusAPI/GetOMHoldStat

Request Information

URI Parameters

None.

Body Parameters

GetOMHoldStatRequest
NameDescriptionTypeAdditional information
Login

string

None.

Password

string

None.

Region

string

None.

ApplicationName

string

None.

SessionId

string

None.

OMkey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Login": "sample string 1",
  "Password": "sample string 2",
  "Region": "sample string 3",
  "ApplicationName": "sample string 4",
  "SessionId": "sample string 5",
  "OMkey": "sample string 6"
}

application/xml, text/xml

Sample:
<GetOMHoldStatRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <ApplicationName>sample string 4</ApplicationName>
  <Login>sample string 1</Login>
  <OMkey>sample string 6</OMkey>
  <Password>sample string 2</Password>
  <Region>sample string 3</Region>
  <SessionId>sample string 5</SessionId>
</GetOMHoldStatRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetOMHoldStatResponse
NameDescriptionTypeAdditional information
CustomerKey

string

None.

HoldFlag

string

None.

StatusCode

string

None.

StatusDescription

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerKey": "sample string 1",
  "HoldFlag": "sample string 2",
  "StatusCode": "sample string 3",
  "StatusDescription": "sample string 4"
}

application/xml, text/xml

Sample:
<GetOMHoldStatResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <CustomerKey>sample string 1</CustomerKey>
  <HoldFlag>sample string 2</HoldFlag>
  <StatusCode>sample string 3</StatusCode>
  <StatusDescription>sample string 4</StatusDescription>
</GetOMHoldStatResponse>