GET api/ArgusAPI/GetUPSKeys

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Login	string	None.
Password	string	None.
Region	string	None.
ApplicationName	string	None.
SessionId	string	None.
Mode	string	None.
UPSDate	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",
  "Mode": "sample string 6",
  "UPSDate": "sample string 7"
}

application/xml, text/xml

Sample:

<GetUPSKeysRequest 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>
  <Mode>sample string 6</Mode>
  <Password>sample string 2</Password>
  <Region>sample string 3</Region>
  <SessionId>sample string 5</SessionId>
  <UPSDate>sample string 7</UPSDate>
</GetUPSKeysRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetUPSKeysResponse

Name	Type	Additional information
Report	Collection of WS_UPSPair	None.
StatusCode	string	None.
StatusDescription	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Report": [
    {
      "UPSKey": "sample string 1",
      "ShipFrom": "sample string 2"
    },
    {
      "UPSKey": "sample string 1",
      "ShipFrom": "sample string 2"
    }
  ],
  "StatusCode": "sample string 1",
  "StatusDescription": "sample string 2"
}

application/xml, text/xml

Sample:

<GetUPSKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArgusWebApi2">
  <Report>
    <WS_UPSPair>
      <ShipFrom>sample string 2</ShipFrom>
      <UPSKey>sample string 1</UPSKey>
    </WS_UPSPair>
    <WS_UPSPair>
      <ShipFrom>sample string 2</ShipFrom>
      <UPSKey>sample string 1</UPSKey>
    </WS_UPSPair>
  </Report>
  <StatusCode>sample string 1</StatusCode>
  <StatusDescription>sample string 2</StatusDescription>
</GetUPSKeysResponse>