ElectronicSubscriptionGetCstListByIP
| Initial Build | 2013.01 |
| Response Type | XML Results |
The ElectronicSubscriptionGetCstListByIP web method returns a list of one or more organizations that have an IP Address or IP Address Range containing the IP address specified in the request. In most cases, one organization is returned. For more information, see the ElectronicSubscriptionGetPurchasedSubscriptionsByCustomer topic.
If more than one organization is returned, multiple organizations are associated with the same IP address. If no records are returned, the IP address is not associated with any organizations.
Parameters
The request contains the following parameters:
| Name | Type | Occurs | Description |
|---|---|---|---|
| oIPAddress | string | 1..1 | The complete, specific IP address. |
Response
This method returns the following XML Results.
| Name | Description | Type | Notes |
|---|---|---|---|
| cst_key | cstkey | string (guid) |
The Customer Key of the organization. |
| OrgName | OrgName | string | The name of the Organization. |
| ipr_key | iprkey | string (guid) | The unique identifier of the IP address setup record; generally you will not need to use this property except for diagnostics/troubleshooting issues. |
| startIP | startIP | string | The IP address. If the IP address is a range, then the start IP address will be included here. The dash character (-) signifies a range. The * character indicates a wildcard. |
| endIP | endIP | string | The end IP address, if any. |
| startdate | startdate | string |
The Start Date of the range, if any, in DateTime format. |
| enddate | enddate | string |
The End Date of the range, if any, in DateTime format. |
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>27c7d097-b560-4348-8938-655f12246394</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:ElectronicSubscriptionGetCstListByIP>
<ns:oIPAddress>111.11.11.111</ns:oIPAddress>
</ns:ElectronicSubscriptionGetCstListByIP>
</soapenv:Body>
</soapenv:Envelope>Sample Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>4fe62726-7011-4752-b243-873ec720c37f</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<ElectronicSubscriptionGetCstListByIPResponse xmlns="http://www.avectra.com/2005/">
<ElectronicSubscriptionGetCstListByIPResult>
<Results recordReturn="2">
<Result>
<cst_key>a58da3b2-8446-44fe-b66b-038f095e3628</cst_key>
<OrgName>Exhibitors of North America</OrgName>
<ipr_key>27c7d097-b560-4348-8938-655f12246394</ipr_key>
<startIP>111.11.11.111</startIP>
<endIP>111.11.11.112</endIP>
<startdate>2012-01-01T00:00:00-05:00</startdate>
<enddate>2012-12-31T00:00:00-05:00</enddate>
</Result>
<Result>
<cst_key>d58da3b2-8446-44fe-b66b-038f095e3628</cst_key>
<OrgName>Exhibitors of South America</OrgName>
<ipr_key>369408e9-f8db-4b43-a916-f27ae3d21566</ipr_key>
<startIP>111.11.11.111</startIP>
<endIP>111.11.11.112</endIP>
<startdate/>
<enddate/>
</Result>
</Results>
</ElectronicSubscriptionGetCstListByIPResult>
</ElectronicSubscriptionGetCstListByIPResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/ElectronicSubscriptionGetCstListByIP
DATA: JSON
{
"ElectronicSubscriptionGetCustomerListByIP": {
"oIPAddress": "{{startIPElectronicSubscriptionGetCustomerListByIP}}"
}
}SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"Results": {
"@recordReturn": "11",
"Result": [
{
"cst_key": "ec9e23a0-1b07-47a1-b94c-25865efa1e24",
"OrgName": "Ullrich Corp",
"ipr_key": "4c88b3a7-5ae4-4f1d-8cca-3ead0faed791",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "f620fcaa-80c9-4e1d-8efb-5a7c60e168eb",
"OrgName": "Sauer Corp",
"ipr_key": "be3fedb0-c84e-457f-b18e-4260ca01a0d8",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "f620fcaa-80c9-4e1d-8efb-5a7c60e168eb",
"OrgName": "Sauer Corp",
"ipr_key": "5e47108d-d5df-4e4b-88a1-f551ec86654f",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "6c870ecb-50e9-40a8-bab1-6de7fc980c25",
"OrgName": "Stiedemann Corp",
"ipr_key": "d8bac730-1bb9-480a-9c67-759f2093f5ba",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "350e9ee2-cacd-441a-947b-72333ca77f7b",
"OrgName": "Lang Corp",
"ipr_key": "9aeb07be-ef58-4134-8579-4e733ffa798f",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "350e9ee2-cacd-441a-947b-72333ca77f7b",
"OrgName": "Lang Corp",
"ipr_key": "4bdc2e4d-2e34-41b0-854d-c834d2146255",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "2c4d352e-6dec-4a61-8145-8f3d7ef49e4e",
"OrgName": "Lynch Corp",
"ipr_key": "47b8217b-7e4a-4c11-92b0-dea7f97d7fa4",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "da0c12f3-ab11-460e-885d-a309c41c1f30",
"OrgName": "Monahan Corp",
"ipr_key": "5ecf9d2c-52e1-4f49-a2df-f41ef8fbdd87",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "6ca46c66-5fea-4a39-bb03-afc11f860606",
"OrgName": "Stanton Corp",
"ipr_key": "4fa9d543-c7f3-42db-b5ac-2bb506ae0b5c",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "dd306a59-21cf-479c-a7b2-b82c33ff7f55",
"OrgName": "Stracke Corp",
"ipr_key": "543dc12c-ff60-4b1a-9a82-0a9a891adb59",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
},
{
"cst_key": "de2bcb83-e607-4fdc-bd5c-fc730f4489cb",
"OrgName": "Will Corp",
"ipr_key": "04d1d706-682a-4ff3-9eca-8dbac37b2541",
"startIP": "192.168.0.1",
"endIP": "192.168.0.22",
"startdate": null,
"enddate": null
}
]
}
}