GET portal/{name}/statusandsubstatus/{secretKey}?CustomerId={CustomerId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

string

Required

secretKey

string

Required

CustomerId

integer

None.

Body Parameters

None.

Response Information

Resource Description

ReturnResultOfOmnicasaStatusAndSubStatus
NameDescriptionTypeAdditional information
Success

Value = true is successful (If this value = false, then we should see Code and Message to have more info about error.)

boolean

None.

Code

It's error code (If value = 0, it's successful)

integer

None.

Message

It's error message (If value = empty, it's successful).

string

None.

Value

Data which you need to get.

OmnicasaStatusAndSubStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Code": 2,
  "Message": "sample string 3",
  "Value": {
    "Status": [
      {
        "Id": 1,
        "Code": "sample string 2",
        "NameNL": "sample string 3",
        "NameFR": "sample string 4",
        "NameEN": "sample string 5",
        "NameDE": "sample string 6"
      },
      {
        "Id": 1,
        "Code": "sample string 2",
        "NameNL": "sample string 3",
        "NameFR": "sample string 4",
        "NameEN": "sample string 5",
        "NameDE": "sample string 6"
      }
    ],
    "SubStatus": [
      {
        "Id": 1,
        "Code": "sample string 2",
        "NameNL": "sample string 3",
        "NameFR": "sample string 4",
        "NameEN": "sample string 5",
        "NameDE": "sample string 6"
      },
      {
        "Id": 1,
        "Code": "sample string 2",
        "NameNL": "sample string 3",
        "NameFR": "sample string 4",
        "NameEN": "sample string 5",
        "NameDE": "sample string 6"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ReturnResultOfOmnicasaStatusAndSubStatusOpzxWdDH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmnicasaApiv3.Models">
  <Code>2</Code>
  <Message>sample string 3</Message>
  <Success>true</Success>
  <Value>
    <Status>
      <MediaLinkLookupStatus>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <NameDE>sample string 6</NameDE>
        <NameEN>sample string 5</NameEN>
        <NameFR>sample string 4</NameFR>
        <NameNL>sample string 3</NameNL>
      </MediaLinkLookupStatus>
      <MediaLinkLookupStatus>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <NameDE>sample string 6</NameDE>
        <NameEN>sample string 5</NameEN>
        <NameFR>sample string 4</NameFR>
        <NameNL>sample string 3</NameNL>
      </MediaLinkLookupStatus>
    </Status>
    <SubStatus>
      <MediaLinkLookupStatus>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <NameDE>sample string 6</NameDE>
        <NameEN>sample string 5</NameEN>
        <NameFR>sample string 4</NameFR>
        <NameNL>sample string 3</NameNL>
      </MediaLinkLookupStatus>
      <MediaLinkLookupStatus>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <NameDE>sample string 6</NameDE>
        <NameEN>sample string 5</NameEN>
        <NameFR>sample string 4</NameFR>
        <NameNL>sample string 3</NameNL>
      </MediaLinkLookupStatus>
    </SubStatus>
  </Value>
</ReturnResultOfOmnicasaStatusAndSubStatusOpzxWdDH>