POST api/SystemInformation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
SiteCode	string	None.
VerificationKey	string	None.
TimestampUTC	string	None.
APIUsername	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteCode": "sample string 1",
  "VerificationKey": "sample string 2",
  "TimestampUTC": "sample string 3",
  "APIUsername": "sample string 4"
}

application/xml, text/xml

Sample:

<BaseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <APIUsername>sample string 4</APIUsername>
  <SiteCode>sample string 1</SiteCode>
  <TimestampUTC>sample string 3</TimestampUTC>
  <VerificationKey>sample string 2</VerificationKey>
</BaseMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SystemInformationResponse

Name	Type	Additional Information
Scopes	Collection of SystemInformationScopeResponse	None.
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Scopes": [
    {
      "Name": "sample string 1",
      "Specifications": null
    },
    {
      "Name": "sample string 1",
      "Specifications": null
    }
  ],
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<SystemInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Model">
  <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 2</CorrelationId>
  <Message xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 1</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">Success</ResponseCode>
  <Scopes>
    <SystemInformationScopeResponse>
      <Name>sample string 1</Name>
      <Specifications i:nil="true" />
    </SystemInformationScopeResponse>
    <SystemInformationScopeResponse>
      <Name>sample string 1</Name>
      <Specifications i:nil="true" />
    </SystemInformationScopeResponse>
  </Scopes>
</SystemInformationResponse>