| GET | /api/customerMaster/{OwnerGln}/{CustomerMasterIdentification} | Get specific customer by customerMasterIdentification Id |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Customer Master
*/
@Api(Description="Customer Master")
@ApiResponse(Description="Customer Master data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType=IReturnVoid.class, StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType=ArgumentOutOfRangeException.class, StatusCode=400)
public static class GetCustomerMasterByIdentification
{
/**
* Owner GLN
*/
@ApiMember(Description="Owner GLN", ExcludeInSchema=true, ParameterType="path")
public String ownerGln = null;
/**
* Customer Master Identification
*/
@ApiMember(Description="Customer Master Identification", ExcludeInSchema=true, ParameterType="path")
public String customerMasterIdentification = null;
public String getOwnerGln() { return ownerGln; }
public GetCustomerMasterByIdentification setOwnerGln(String value) { this.ownerGln = value; return this; }
public String getCustomerMasterIdentification() { return customerMasterIdentification; }
public GetCustomerMasterByIdentification setCustomerMasterIdentification(String value) { this.customerMasterIdentification = value; return this; }
}
public static class CustomerMasterMessage
{
public TransactionalParty dataSource = null;
public TransactionalParty dataRecipient = null;
public String customerMasterIdentification = null;
public ArrayList<CustomerMasterType> customer = new ArrayList<CustomerMasterType>();
public String documentStatusCode = null;
public String documentActionCode = null;
public Date creationDateTime = null;
public Date lastUpdateDateTime = null;
public TransactionalParty getDataSource() { return dataSource; }
public CustomerMasterMessage setDataSource(TransactionalParty value) { this.dataSource = value; return this; }
public TransactionalParty getDataRecipient() { return dataRecipient; }
public CustomerMasterMessage setDataRecipient(TransactionalParty value) { this.dataRecipient = value; return this; }
public String getCustomerMasterIdentification() { return customerMasterIdentification; }
public CustomerMasterMessage setCustomerMasterIdentification(String value) { this.customerMasterIdentification = value; return this; }
public ArrayList<CustomerMasterType> getCustomer() { return customer; }
public CustomerMasterMessage setCustomer(ArrayList<CustomerMasterType> value) { this.customer = value; return this; }
public String getDocumentStatusCode() { return documentStatusCode; }
public CustomerMasterMessage setDocumentStatusCode(String value) { this.documentStatusCode = value; return this; }
public String getDocumentActionCode() { return documentActionCode; }
public CustomerMasterMessage setDocumentActionCode(String value) { this.documentActionCode = value; return this; }
public Date getCreationDateTime() { return creationDateTime; }
public CustomerMasterMessage setCreationDateTime(Date value) { this.creationDateTime = value; return this; }
public Date getLastUpdateDateTime() { return lastUpdateDateTime; }
public CustomerMasterMessage setLastUpdateDateTime(Date value) { this.lastUpdateDateTime = value; return this; }
}
public static class TransactionalParty extends Ecom_PartyIdentificationType
{
public ArrayList<Contact> contact = new ArrayList<Contact>();
public Address address = null;
public ArrayList<AvpList> communicationChannel = new ArrayList<AvpList>();
public FinancialInstitutionInformation financialInstitutionInformation = null;
public String dutyFeeTaxRegistration = null;
public String entityIdentification = null;
public ArrayList<Contact> getContact() { return contact; }
public TransactionalParty setContact(ArrayList<Contact> value) { this.contact = value; return this; }
public Address getAddress() { return address; }
public TransactionalParty setAddress(Address value) { this.address = value; return this; }
public ArrayList<AvpList> getCommunicationChannel() { return communicationChannel; }
public TransactionalParty setCommunicationChannel(ArrayList<AvpList> value) { this.communicationChannel = value; return this; }
public FinancialInstitutionInformation getFinancialInstitutionInformation() { return financialInstitutionInformation; }
public TransactionalParty setFinancialInstitutionInformation(FinancialInstitutionInformation value) { this.financialInstitutionInformation = value; return this; }
public String getDutyFeeTaxRegistration() { return dutyFeeTaxRegistration; }
public TransactionalParty setDutyFeeTaxRegistration(String value) { this.dutyFeeTaxRegistration = value; return this; }
public String getEntityIdentification() { return entityIdentification; }
public TransactionalParty setEntityIdentification(String value) { this.entityIdentification = value; return this; }
}
public static class Ecom_PartyIdentificationType
{
public String gln = null;
public String name = null;
public ArrayList<AvpList> additionalPartyIdentification = new ArrayList<AvpList>();
public String getGln() { return gln; }
public Ecom_PartyIdentificationType setGln(String value) { this.gln = value; return this; }
public String getName() { return name; }
public Ecom_PartyIdentificationType setName(String value) { this.name = value; return this; }
public ArrayList<AvpList> getAdditionalPartyIdentification() { return additionalPartyIdentification; }
public Ecom_PartyIdentificationType setAdditionalPartyIdentification(ArrayList<AvpList> value) { this.additionalPartyIdentification = value; return this; }
}
public static class AvpList
{
public String code = null;
public String value = null;
public String getCode() { return code; }
public AvpList setCode(String value) { this.code = value; return this; }
public String getValue() { return value; }
public AvpList setValue(String value) { this.value = value; return this; }
}
public static class Contact
{
public String contactTypeCode = null;
public String personName = null;
public String departmentName = null;
public String jobTitle = null;
public String responsibility = null;
public ArrayList<CommunicationChannel> communicationChannel = new ArrayList<CommunicationChannel>();
public String getContactTypeCode() { return contactTypeCode; }
public Contact setContactTypeCode(String value) { this.contactTypeCode = value; return this; }
public String getPersonName() { return personName; }
public Contact setPersonName(String value) { this.personName = value; return this; }
public String getDepartmentName() { return departmentName; }
public Contact setDepartmentName(String value) { this.departmentName = value; return this; }
public String getJobTitle() { return jobTitle; }
public Contact setJobTitle(String value) { this.jobTitle = value; return this; }
public String getResponsibility() { return responsibility; }
public Contact setResponsibility(String value) { this.responsibility = value; return this; }
public ArrayList<CommunicationChannel> getCommunicationChannel() { return communicationChannel; }
public Contact setCommunicationChannel(ArrayList<CommunicationChannel> value) { this.communicationChannel = value; return this; }
}
public static class CommunicationChannel
{
public String communicationChannelCode = null;
public String communicationChannelName = null;
public String communicationValue = null;
public String getCommunicationChannelCode() { return communicationChannelCode; }
public CommunicationChannel setCommunicationChannelCode(String value) { this.communicationChannelCode = value; return this; }
public String getCommunicationChannelName() { return communicationChannelName; }
public CommunicationChannel setCommunicationChannelName(String value) { this.communicationChannelName = value; return this; }
public String getCommunicationValue() { return communicationValue; }
public CommunicationChannel setCommunicationValue(String value) { this.communicationValue = value; return this; }
}
public static class Address
{
public String streetAddressOne = null;
public String streetAddressTwo = null;
public String streetAddressThree = null;
public String city = null;
public String postalCode = null;
public String provinceCode = null;
public String countryCode = null;
public String getStreetAddressOne() { return streetAddressOne; }
public Address setStreetAddressOne(String value) { this.streetAddressOne = value; return this; }
public String getStreetAddressTwo() { return streetAddressTwo; }
public Address setStreetAddressTwo(String value) { this.streetAddressTwo = value; return this; }
public String getStreetAddressThree() { return streetAddressThree; }
public Address setStreetAddressThree(String value) { this.streetAddressThree = value; return this; }
public String getCity() { return city; }
public Address setCity(String value) { this.city = value; return this; }
public String getPostalCode() { return postalCode; }
public Address setPostalCode(String value) { this.postalCode = value; return this; }
public String getProvinceCode() { return provinceCode; }
public Address setProvinceCode(String value) { this.provinceCode = value; return this; }
public String getCountryCode() { return countryCode; }
public Address setCountryCode(String value) { this.countryCode = value; return this; }
}
public static class FinancialInstitutionInformation
{
public String financialInstitutionBranchName = null;
public String financialInstitutionName = null;
public FinancialRoutingNumber financialRoutingNumber = null;
public FinancialAccount financialAccount = null;
public String swiftCode = null;
public String exportersCode = null;
public String getFinancialInstitutionBranchName() { return financialInstitutionBranchName; }
public FinancialInstitutionInformation setFinancialInstitutionBranchName(String value) { this.financialInstitutionBranchName = value; return this; }
public String getFinancialInstitutionName() { return financialInstitutionName; }
public FinancialInstitutionInformation setFinancialInstitutionName(String value) { this.financialInstitutionName = value; return this; }
public FinancialRoutingNumber getFinancialRoutingNumber() { return financialRoutingNumber; }
public FinancialInstitutionInformation setFinancialRoutingNumber(FinancialRoutingNumber value) { this.financialRoutingNumber = value; return this; }
public FinancialAccount getFinancialAccount() { return financialAccount; }
public FinancialInstitutionInformation setFinancialAccount(FinancialAccount value) { this.financialAccount = value; return this; }
public String getSwiftCode() { return swiftCode; }
public FinancialInstitutionInformation setSwiftCode(String value) { this.swiftCode = value; return this; }
public String getExportersCode() { return exportersCode; }
public FinancialInstitutionInformation setExportersCode(String value) { this.exportersCode = value; return this; }
}
public static class FinancialRoutingNumber
{
public String number = null;
public String numberTypeCode = null;
public String getNumber() { return number; }
public FinancialRoutingNumber setNumber(String value) { this.number = value; return this; }
public String getNumberTypeCode() { return numberTypeCode; }
public FinancialRoutingNumber setNumberTypeCode(String value) { this.numberTypeCode = value; return this; }
}
public static class FinancialAccount
{
public String number = null;
public String numberTypeCode = null;
public String name = null;
public String getNumber() { return number; }
public FinancialAccount setNumber(String value) { this.number = value; return this; }
public String getNumberTypeCode() { return numberTypeCode; }
public FinancialAccount setNumberTypeCode(String value) { this.numberTypeCode = value; return this; }
public String getName() { return name; }
public FinancialAccount setName(String value) { this.name = value; return this; }
}
public static class CustomerMasterType extends CustomerRecord
{
public CustomerRecord payByCustomer = null;
public CustomerRecord billToCustomer = null;
public String routingCode = null;
public String storeType = null;
public String currencyCode = null;
public String type = null;
public String group = null;
public String region = null;
public String zoneRate = null;
public String taxRule = null;
public String paymentTerm = null;
public String shipmentSite = null;
public String shipmentSiteName = null;
public String shipmentSiteGln = null;
public String accountingCode = null;
public String commercialRepresentative = null;
public String commercialTerritory = null;
public CreditLimit credit = null;
public ArrayList<String> nod = new ArrayList<String>();
public ArrayList<String> ndd = new ArrayList<String>();
public CustomerRecord getPayByCustomer() { return payByCustomer; }
public CustomerMasterType setPayByCustomer(CustomerRecord value) { this.payByCustomer = value; return this; }
public CustomerRecord getBillToCustomer() { return billToCustomer; }
public CustomerMasterType setBillToCustomer(CustomerRecord value) { this.billToCustomer = value; return this; }
public String getRoutingCode() { return routingCode; }
public CustomerMasterType setRoutingCode(String value) { this.routingCode = value; return this; }
public String getStoreType() { return storeType; }
public CustomerMasterType setStoreType(String value) { this.storeType = value; return this; }
public String getCurrencyCode() { return currencyCode; }
public CustomerMasterType setCurrencyCode(String value) { this.currencyCode = value; return this; }
public String getType() { return type; }
public CustomerMasterType setType(String value) { this.type = value; return this; }
public String getGroup() { return group; }
public CustomerMasterType setGroup(String value) { this.group = value; return this; }
public String getRegion() { return region; }
public CustomerMasterType setRegion(String value) { this.region = value; return this; }
public String getZoneRate() { return zoneRate; }
public CustomerMasterType setZoneRate(String value) { this.zoneRate = value; return this; }
public String getTaxRule() { return taxRule; }
public CustomerMasterType setTaxRule(String value) { this.taxRule = value; return this; }
public String getPaymentTerm() { return paymentTerm; }
public CustomerMasterType setPaymentTerm(String value) { this.paymentTerm = value; return this; }
public String getShipmentSite() { return shipmentSite; }
public CustomerMasterType setShipmentSite(String value) { this.shipmentSite = value; return this; }
public String getShipmentSiteName() { return shipmentSiteName; }
public CustomerMasterType setShipmentSiteName(String value) { this.shipmentSiteName = value; return this; }
public String getShipmentSiteGln() { return shipmentSiteGln; }
public CustomerMasterType setShipmentSiteGln(String value) { this.shipmentSiteGln = value; return this; }
public String getAccountingCode() { return accountingCode; }
public CustomerMasterType setAccountingCode(String value) { this.accountingCode = value; return this; }
public String getCommercialRepresentative() { return commercialRepresentative; }
public CustomerMasterType setCommercialRepresentative(String value) { this.commercialRepresentative = value; return this; }
public String getCommercialTerritory() { return commercialTerritory; }
public CustomerMasterType setCommercialTerritory(String value) { this.commercialTerritory = value; return this; }
public CreditLimit getCredit() { return credit; }
public CustomerMasterType setCredit(CreditLimit value) { this.credit = value; return this; }
public ArrayList<String> getNod() { return nod; }
public CustomerMasterType setNod(ArrayList<String> value) { this.nod = value; return this; }
public ArrayList<String> getNdd() { return ndd; }
public CustomerMasterType setNdd(ArrayList<String> value) { this.ndd = value; return this; }
}
public static class CustomerRecord
{
public String gln = null;
public String code = null;
public String name = null;
public String buyerAssignedVendorNo = null;
public String supplierAssignedVendorNo = null;
public String dutyFeeTaxRegistration = null;
public String entityIdentification = null;
public ArrayList<Contact> contact = new ArrayList<Contact>();
public CustomerMasterAddress address = null;
public ArrayList<AvpList> avpList = new ArrayList<AvpList>();
public String getGln() { return gln; }
public CustomerRecord setGln(String value) { this.gln = value; return this; }
public String getCode() { return code; }
public CustomerRecord setCode(String value) { this.code = value; return this; }
public String getName() { return name; }
public CustomerRecord setName(String value) { this.name = value; return this; }
public String getBuyerAssignedVendorNo() { return buyerAssignedVendorNo; }
public CustomerRecord setBuyerAssignedVendorNo(String value) { this.buyerAssignedVendorNo = value; return this; }
public String getSupplierAssignedVendorNo() { return supplierAssignedVendorNo; }
public CustomerRecord setSupplierAssignedVendorNo(String value) { this.supplierAssignedVendorNo = value; return this; }
public String getDutyFeeTaxRegistration() { return dutyFeeTaxRegistration; }
public CustomerRecord setDutyFeeTaxRegistration(String value) { this.dutyFeeTaxRegistration = value; return this; }
public String getEntityIdentification() { return entityIdentification; }
public CustomerRecord setEntityIdentification(String value) { this.entityIdentification = value; return this; }
public ArrayList<Contact> getContact() { return contact; }
public CustomerRecord setContact(ArrayList<Contact> value) { this.contact = value; return this; }
public CustomerMasterAddress getAddress() { return address; }
public CustomerRecord setAddress(CustomerMasterAddress value) { this.address = value; return this; }
public ArrayList<AvpList> getAvpList() { return avpList; }
public CustomerRecord setAvpList(ArrayList<AvpList> value) { this.avpList = value; return this; }
}
public static class CustomerMasterAddress extends Address
{
public String addressType = null;
public String getAddressType() { return addressType; }
public CustomerMasterAddress setAddressType(String value) { this.addressType = value; return this; }
}
public static class CreditLimit
{
public BigDecimal limit = null;
public BigDecimal balance = null;
public BigDecimal available = null;
public Date effectiveDateTime = null;
public BigDecimal getLimit() { return limit; }
public CreditLimit setLimit(BigDecimal value) { this.limit = value; return this; }
public BigDecimal getBalance() { return balance; }
public CreditLimit setBalance(BigDecimal value) { this.balance = value; return this; }
public BigDecimal getAvailable() { return available; }
public CreditLimit setAvailable(BigDecimal value) { this.available = value; return this; }
public Date getEffectiveDateTime() { return effectiveDateTime; }
public CreditLimit setEffectiveDateTime(Date value) { this.effectiveDateTime = value; return this; }
}
}
Java GetCustomerMasterByIdentification DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/customerMaster/{OwnerGln}/{CustomerMasterIdentification} HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
dataSource:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
dataRecipient:
{
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
communicationChannel:
[
{
code: String,
value: String
}
],
financialInstitutionInformation:
{
financialInstitutionBranchName: String,
financialInstitutionName: String,
financialRoutingNumber:
{
number: String,
numberTypeCode: String
},
financialAccount:
{
number: String,
numberTypeCode: String,
name: String
},
swiftCode: String,
exportersCode: String
},
dutyFeeTaxRegistration: String,
entityIdentification: String,
gln: String,
name: String,
additionalPartyIdentification:
[
{
code: String,
value: String
}
]
},
customerMasterIdentification: String,
customer:
[
{
payByCustomer:
{
gln: String,
code: String,
name: String,
buyerAssignedVendorNo: String,
supplierAssignedVendorNo: String,
dutyFeeTaxRegistration: String,
entityIdentification: String,
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
addressType: String,
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
avpList:
[
{
code: String,
value: String
}
]
},
billToCustomer:
{
gln: String,
code: String,
name: String,
buyerAssignedVendorNo: String,
supplierAssignedVendorNo: String,
dutyFeeTaxRegistration: String,
entityIdentification: String,
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
addressType: String,
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
avpList:
[
{
code: String,
value: String
}
]
},
routingCode: String,
storeType: String,
currencyCode: String,
type: String,
group: String,
region: String,
zoneRate: String,
taxRule: String,
paymentTerm: String,
shipmentSite: String,
shipmentSiteName: String,
shipmentSiteGln: String,
accountingCode: String,
commercialRepresentative: String,
commercialTerritory: String,
credit:
{
limit: 0,
balance: 0,
available: 0,
effectiveDateTime: 0001-01-01
},
nod:
[
String
],
ndd:
[
String
],
gln: String,
code: String,
name: String,
buyerAssignedVendorNo: String,
supplierAssignedVendorNo: String,
dutyFeeTaxRegistration: String,
entityIdentification: String,
contact:
[
{
contactTypeCode: String,
personName: String,
departmentName: String,
jobTitle: String,
responsibility: String,
communicationChannel:
[
{
communicationChannelCode: String,
communicationChannelName: String,
communicationValue: String
}
]
}
],
address:
{
addressType: String,
streetAddressOne: String,
streetAddressTwo: String,
streetAddressThree: String,
city: String,
postalCode: String,
provinceCode: String,
countryCode: String
},
avpList:
[
{
code: String,
value: String
}
]
}
],
documentStatusCode: String,
documentActionCode: String
}