addresslistGet
Returns address information.
The AddressList request returns information about the specified address.
/addresslist
Usage and SDK Samples
curl -X GET -H "Authorization: Basic [[basicHash]]" "http://api.datapel.net/ JSON/addresslist?AddressID=&AddressListID=&CardRecordID=&ContactName=&Location=&City=&Country=&Email=&Fax=&Phone1=&Phone2=&Phone3=&postcode=&street=&streetline1=&streetline2=&streetline3="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GETOperationsApi;
import java.io.File;
import java.util.*;
public class GETOperationsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
GETOperationsApi apiInstance = new GETOperationsApi();
Integer addressID = 56; // Integer | the primary key value of the address record.
Integer addressListID = 56; // Integer | The primary key value of the address list record.
Integer cardRecordID = 56; // Integer | The primary key value of the card record.
String contactName = contactName_example; // String | The name on the contact card
String location = location_example; // String | The location details of the address record.
String city = city_example; // String | The city or ship to city of a customer card.
String country = country_example; // String | Country of the location address.
String email = email_example; // String | Email address of a card record.
String fax = fax_example; // String | The fax number of a card record.
String phone1 = phone1_example; // String | Phone number 1 of a card record.
String phone2 = phone2_example; // String | Phone number 2 of a card record.
String phone3 = phone3_example; // String | Phone number 3 of a card record.
String postcode = postcode_example; // String | State of a card record.
String street = street_example; // String | Full contents of the ship to address field.
String streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
String streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
String streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.
try {
addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GETOperationsApi#addresslistGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.GETOperationsApi;
public class GETOperationsApiExample {
public static void main(String[] args) {
GETOperationsApi apiInstance = new GETOperationsApi();
Integer addressID = 56; // Integer | the primary key value of the address record.
Integer addressListID = 56; // Integer | The primary key value of the address list record.
Integer cardRecordID = 56; // Integer | The primary key value of the card record.
String contactName = contactName_example; // String | The name on the contact card
String location = location_example; // String | The location details of the address record.
String city = city_example; // String | The city or ship to city of a customer card.
String country = country_example; // String | Country of the location address.
String email = email_example; // String | Email address of a card record.
String fax = fax_example; // String | The fax number of a card record.
String phone1 = phone1_example; // String | Phone number 1 of a card record.
String phone2 = phone2_example; // String | Phone number 2 of a card record.
String phone3 = phone3_example; // String | Phone number 3 of a card record.
String postcode = postcode_example; // String | State of a card record.
String street = street_example; // String | Full contents of the ship to address field.
String streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
String streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
String streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.
try {
addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GETOperationsApi#addresslistGet");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *addressID = 56; // the primary key value of the address record. (optional)
Integer *addressListID = 56; // The primary key value of the address list record. (optional)
Integer *cardRecordID = 56; // The primary key value of the card record. (optional)
String *contactName = contactName_example; // The name on the contact card (optional)
String *location = location_example; // The location details of the address record. (optional)
String *city = city_example; // The city or ship to city of a customer card. (optional)
String *country = country_example; // Country of the location address. (optional)
String *email = email_example; // Email address of a card record. (optional)
String *fax = fax_example; // The fax number of a card record. (optional)
String *phone1 = phone1_example; // Phone number 1 of a card record. (optional)
String *phone2 = phone2_example; // Phone number 2 of a card record. (optional)
String *phone3 = phone3_example; // Phone number 3 of a card record. (optional)
String *postcode = postcode_example; // State of a card record. (optional)
String *street = street_example; // Full contents of the ship to address field. (optional)
String *streetline1 = streetline1_example; // First line of cards Address or Ship To address. (optional)
String *streetline2 = streetline2_example; // Second line of cards Address or Ship To address. (optional)
String *streetline3 = streetline3_example; // Third line of cards Address or Ship To address. (optional)
GETOperationsApi *apiInstance = [[GETOperationsApi alloc] init];
// Returns address information.
[apiInstance addresslistGetWith:addressID
addressListID:addressListID
cardRecordID:cardRecordID
contactName:contactName
location:location
city:city
country:country
email:email
fax:fax
phone1:phone1
phone2:phone2
phone3:phone3
postcode:postcode
street:street
streetline1:streetline1
streetline2:streetline2
streetline3:streetline3
completionHandler: ^(addresslist output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var ApiDocsHowItWorks = require('api_docs___how_it_works');
var defaultClient = ApiDocsHowItWorks.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
var api = new ApiDocsHowItWorks.GETOperationsApi()
var opts = {
'addressID': 56, // {{Integer}} the primary key value of the address record.
'addressListID': 56, // {{Integer}} The primary key value of the address list record.
'cardRecordID': 56, // {{Integer}} The primary key value of the card record.
'contactName': contactName_example, // {{String}} The name on the contact card
'location': location_example, // {{String}} The location details of the address record.
'city': city_example, // {{String}} The city or ship to city of a customer card.
'country': country_example, // {{String}} Country of the location address.
'email': email_example, // {{String}} Email address of a card record.
'fax': fax_example, // {{String}} The fax number of a card record.
'phone1': phone1_example, // {{String}} Phone number 1 of a card record.
'phone2': phone2_example, // {{String}} Phone number 2 of a card record.
'phone3': phone3_example, // {{String}} Phone number 3 of a card record.
'postcode': postcode_example, // {{String}} State of a card record.
'street': street_example, // {{String}} Full contents of the ship to address field.
'streetline1': streetline1_example, // {{String}} First line of cards Address or Ship To address.
'streetline2': streetline2_example, // {{String}} Second line of cards Address or Ship To address.
'streetline3': streetline3_example // {{String}} Third line of cards Address or Ship To address.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.addresslistGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class addresslistGetExample
{
public void main()
{
// Configure HTTP basic authorization: basicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new GETOperationsApi();
var addressID = 56; // Integer | the primary key value of the address record. (optional)
var addressListID = 56; // Integer | The primary key value of the address list record. (optional)
var cardRecordID = 56; // Integer | The primary key value of the card record. (optional)
var contactName = contactName_example; // String | The name on the contact card (optional)
var location = location_example; // String | The location details of the address record. (optional)
var city = city_example; // String | The city or ship to city of a customer card. (optional)
var country = country_example; // String | Country of the location address. (optional)
var email = email_example; // String | Email address of a card record. (optional)
var fax = fax_example; // String | The fax number of a card record. (optional)
var phone1 = phone1_example; // String | Phone number 1 of a card record. (optional)
var phone2 = phone2_example; // String | Phone number 2 of a card record. (optional)
var phone3 = phone3_example; // String | Phone number 3 of a card record. (optional)
var postcode = postcode_example; // String | State of a card record. (optional)
var street = street_example; // String | Full contents of the ship to address field. (optional)
var streetline1 = streetline1_example; // String | First line of cards Address or Ship To address. (optional)
var streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address. (optional)
var streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address. (optional)
try
{
// Returns address information.
addresslist result = apiInstance.addresslistGet(addressID, addressListID, cardRecordID, contactName, location, city, country, email, fax, phone1, phone2, phone3, postcode, street, streetline1, streetline2, streetline3);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling GETOperationsApi.addresslistGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Swagger\Client\ApiGETOperationsApi();
$addressID = 56; // Integer | the primary key value of the address record.
$addressListID = 56; // Integer | The primary key value of the address list record.
$cardRecordID = 56; // Integer | The primary key value of the card record.
$contactName = contactName_example; // String | The name on the contact card
$location = location_example; // String | The location details of the address record.
$city = city_example; // String | The city or ship to city of a customer card.
$country = country_example; // String | Country of the location address.
$email = email_example; // String | Email address of a card record.
$fax = fax_example; // String | The fax number of a card record.
$phone1 = phone1_example; // String | Phone number 1 of a card record.
$phone2 = phone2_example; // String | Phone number 2 of a card record.
$phone3 = phone3_example; // String | Phone number 3 of a card record.
$postcode = postcode_example; // String | State of a card record.
$street = street_example; // String | Full contents of the ship to address field.
$streetline1 = streetline1_example; // String | First line of cards Address or Ship To address.
$streetline2 = streetline2_example; // String | Second line of cards Address or Ship To address.
$streetline3 = streetline3_example; // String | Third line of cards Address or Ship To address.
try {
$result = $api_instance->addresslistGet($addressID, $addressListID, $cardRecordID, $contactName, $location, $city, $country, $email, $fax, $phone1, $phone2, $phone3, $postcode, $street, $streetline1, $streetline2, $streetline3);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling GETOperationsApi->addresslistGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GETOperationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
my $api_instance = WWW::SwaggerClient::GETOperationsApi->new();
my $addressID = 56; # Integer | the primary key value of the address record.
my $addressListID = 56; # Integer | The primary key value of the address list record.
my $cardRecordID = 56; # Integer | The primary key value of the card record.
my $contactName = contactName_example; # String | The name on the contact card
my $location = location_example; # String | The location details of the address record.
my $city = city_example; # String | The city or ship to city of a customer card.
my $country = country_example; # String | Country of the location address.
my $email = email_example; # String | Email address of a card record.
my $fax = fax_example; # String | The fax number of a card record.
my $phone1 = phone1_example; # String | Phone number 1 of a card record.
my $phone2 = phone2_example; # String | Phone number 2 of a card record.
my $phone3 = phone3_example; # String | Phone number 3 of a card record.
my $postcode = postcode_example; # String | State of a card record.
my $street = street_example; # String | Full contents of the ship to address field.
my $streetline1 = streetline1_example; # String | First line of cards Address or Ship To address.
my $streetline2 = streetline2_example; # String | Second line of cards Address or Ship To address.
my $streetline3 = streetline3_example; # String | Third line of cards Address or Ship To address.
eval {
my $result = $api_instance->addresslistGet(addressID => $addressID, addressListID => $addressListID, cardRecordID => $cardRecordID, contactName => $contactName, location => $location, city => $city, country => $country, email => $email, fax => $fax, phone1 => $phone1, phone2 => $phone2, phone3 => $phone3, postcode => $postcode, street => $street, streetline1 => $streetline1, streetline2 => $streetline2, streetline3 => $streetline3);
print Dumper($result);
};
if ($@) {
warn "Exception when calling GETOperationsApi->addresslistGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.GETOperationsApi()
addressID = 56 # Integer | the primary key value of the address record. (optional)
addressListID = 56 # Integer | The primary key value of the address list record. (optional)
cardRecordID = 56 # Integer | The primary key value of the card record. (optional)
contactName = contactName_example # String | The name on the contact card (optional)
location = location_example # String | The location details of the address record. (optional)
city = city_example # String | The city or ship to city of a customer card. (optional)
country = country_example # String | Country of the location address. (optional)
email = email_example # String | Email address of a card record. (optional)
fax = fax_example # String | The fax number of a card record. (optional)
phone1 = phone1_example # String | Phone number 1 of a card record. (optional)
phone2 = phone2_example # String | Phone number 2 of a card record. (optional)
phone3 = phone3_example # String | Phone number 3 of a card record. (optional)
postcode = postcode_example # String | State of a card record. (optional)
street = street_example # String | Full contents of the ship to address field. (optional)
streetline1 = streetline1_example # String | First line of cards Address or Ship To address. (optional)
streetline2 = streetline2_example # String | Second line of cards Address or Ship To address. (optional)
streetline3 = streetline3_example # String | Third line of cards Address or Ship To address. (optional)
try:
# Returns address information.
api_response = api_instance.addresslist_get(addressID=addressID, addressListID=addressListID, cardRecordID=cardRecordID, contactName=contactName, location=location, city=city, country=country, email=email, fax=fax, phone1=phone1, phone2=phone2, phone3=phone3, postcode=postcode, street=street, streetline1=streetline1, streetline2=streetline2, streetline3=streetline3)
pprint(api_response)
except ApiException as e:
print("Exception when calling GETOperationsApi->addresslistGet: %s\n" % e)
Parameters
Name | Description |
---|---|
AddressID |
Integer
the primary key value of the address record.
|
AddressListID |
Integer
The primary key value of the address list record.
|
CardRecordID |
Integer
The primary key value of the card record.
|
ContactName |
String
The name on the contact card
|
Location |
String
The location details of the address record.
|
City |
String
The city or ship to city of a customer card.
|
Country |
String
Country of the location address.
|
String
Email address of a card record.
|
|
Fax |
String
The fax number of a card record.
|
Phone1 |
String
Phone number 1 of a card record.
|
Phone2 |
String
Phone number 2 of a card record.
|
Phone3 |
String
Phone number 3 of a card record.
|
postcode |
String
State of a card record.
|
street |
String
Full contents of the ship to address field.
|
streetline1 |
String
First line of cards Address or Ship To address.
|
streetline2 |
String
Second line of cards Address or Ship To address.
|
streetline3 |
String
Third line of cards Address or Ship To address.
|