EwsLabelService
Click here for a complete list of operations.
GetAccountStatusXML
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /LabelService/EwsLabelService.asmx HTTP/1.1
Host: labelserver.endicia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.envmgr.com/LabelService/GetAccountStatusXML"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetAccountStatusXML xmlns="www.envmgr.com/LabelService">
<AccountStatusRequestXML>string</AccountStatusRequestXML>
</GetAccountStatusXML>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetAccountStatusXMLResponse xmlns="www.envmgr.com/LabelService">
<AccountStatusResponse>
<Status>int</Status>
<ErrorMessage>string</ErrorMessage>
<RequesterID>string</RequesterID>
<RequestID>string</RequestID>
<CertifiedIntermediary>
<AccountID>string</AccountID>
<SerialNumber>int</SerialNumber>
<PostageBalance>decimal</PostageBalance>
<AscendingBalance>decimal</AscendingBalance>
<AccountStatus>string</AccountStatus>
<DeviceID>string</DeviceID>
<ReferenceID>string</ReferenceID>
</CertifiedIntermediary>
<Discounts>
<PriorityMail Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<PMExpress Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<FCPS Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<PMI Discount="ComBase or CPP or Custom" />
<EMI Discount="ComBase or CPP or Custom" />
<FCPIS Discount="ComBase or CPP or Custom" />
</Discounts>
<AccountType>USPS or Retail</AccountType>
<ApprovedShipper>boolean</ApprovedShipper>
<ConsolidatorServices>boolean</ConsolidatorServices>
<ConsolidatorServiceDetail>
<InternationalConsolidator>boolean</InternationalConsolidator>
<EnabledInternationalConsolidatorServices>
<EnabledInternationalConsolidatorService xsi:nil="true" />
<EnabledInternationalConsolidatorService xsi:nil="true" />
</EnabledInternationalConsolidatorServices>
<TypeCodes>
<TypeCode xsi:nil="true" />
<TypeCode xsi:nil="true" />
</TypeCodes>
<ServiceInfo>
<Services xsi:nil="true" />
</ServiceInfo>
</ConsolidatorServiceDetail>
<ContractID>
<DomesticCID>string</DomesticCID>
<InternationalCID>string</InternationalCID>
</ContractID>
<InsuranceAgreement>boolean</InsuranceAgreement>
<AccountStatus>
<Status>string</Status>
<ReturnCode>int</ReturnCode>
</AccountStatus>
<ControlRegister>decimal</ControlRegister>
<LicenseZip5>string</LicenseZip5>
<Address>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Address1>string</Address1>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<ZipCodeAddOn>string</ZipCodeAddOn>
<PhoneNumber>string</PhoneNumber>
</Address>
<AccountFeatures>
<Feature>
<Code>string</Code>
<Name>string</Name>
<IsEligible>boolean</IsEligible>
<IsActive>boolean</IsActive>
<TermsAndConditionsLink>string</TermsAndConditionsLink>
</Feature>
<Feature>
<Code>string</Code>
<Name>string</Name>
<IsEligible>boolean</IsEligible>
<IsActive>boolean</IsActive>
<TermsAndConditionsLink>string</TermsAndConditionsLink>
</Feature>
</AccountFeatures>
<PayOnUse>
<OutstandingLabelBalance>decimal</OutstandingLabelBalance>
<MaxOutstandingLabelBalance>decimal</MaxOutstandingLabelBalance>
<POURMailerID>boolean</POURMailerID>
</PayOnUse>
<ConfiguredCarriers>
<Carrier>
<Carrier>string</Carrier>
<UserOwnedAccount>boolean</UserOwnedAccount>
</Carrier>
<Carrier>
<Carrier>string</Carrier>
<UserOwnedAccount>boolean</UserOwnedAccount>
</Carrier>
</ConfiguredCarriers>
</AccountStatusResponse>
</GetAccountStatusXMLResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /LabelService/EwsLabelService.asmx HTTP/1.1
Host: labelserver.endicia.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetAccountStatusXML xmlns="www.envmgr.com/LabelService">
<AccountStatusRequestXML>string</AccountStatusRequestXML>
</GetAccountStatusXML>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetAccountStatusXMLResponse xmlns="www.envmgr.com/LabelService">
<AccountStatusResponse>
<Status>int</Status>
<ErrorMessage>string</ErrorMessage>
<RequesterID>string</RequesterID>
<RequestID>string</RequestID>
<CertifiedIntermediary>
<AccountID>string</AccountID>
<SerialNumber>int</SerialNumber>
<PostageBalance>decimal</PostageBalance>
<AscendingBalance>decimal</AscendingBalance>
<AccountStatus>string</AccountStatus>
<DeviceID>string</DeviceID>
<ReferenceID>string</ReferenceID>
</CertifiedIntermediary>
<Discounts>
<PriorityMail Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<PMExpress Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<FCPS Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<PMI Discount="ComBase or CPP or Custom" />
<EMI Discount="ComBase or CPP or Custom" />
<FCPIS Discount="ComBase or CPP or Custom" />
</Discounts>
<AccountType>USPS or Retail</AccountType>
<ApprovedShipper>boolean</ApprovedShipper>
<ConsolidatorServices>boolean</ConsolidatorServices>
<ConsolidatorServiceDetail>
<InternationalConsolidator>boolean</InternationalConsolidator>
<EnabledInternationalConsolidatorServices>
<EnabledInternationalConsolidatorService xsi:nil="true" />
<EnabledInternationalConsolidatorService xsi:nil="true" />
</EnabledInternationalConsolidatorServices>
<TypeCodes>
<TypeCode xsi:nil="true" />
<TypeCode xsi:nil="true" />
</TypeCodes>
<ServiceInfo>
<Services xsi:nil="true" />
</ServiceInfo>
</ConsolidatorServiceDetail>
<ContractID>
<DomesticCID>string</DomesticCID>
<InternationalCID>string</InternationalCID>
</ContractID>
<InsuranceAgreement>boolean</InsuranceAgreement>
<AccountStatus>
<Status>string</Status>
<ReturnCode>int</ReturnCode>
</AccountStatus>
<ControlRegister>decimal</ControlRegister>
<LicenseZip5>string</LicenseZip5>
<Address>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Address1>string</Address1>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<ZipCodeAddOn>string</ZipCodeAddOn>
<PhoneNumber>string</PhoneNumber>
</Address>
<AccountFeatures>
<Feature>
<Code>string</Code>
<Name>string</Name>
<IsEligible>boolean</IsEligible>
<IsActive>boolean</IsActive>
<TermsAndConditionsLink>string</TermsAndConditionsLink>
</Feature>
<Feature>
<Code>string</Code>
<Name>string</Name>
<IsEligible>boolean</IsEligible>
<IsActive>boolean</IsActive>
<TermsAndConditionsLink>string</TermsAndConditionsLink>
</Feature>
</AccountFeatures>
<PayOnUse>
<OutstandingLabelBalance>decimal</OutstandingLabelBalance>
<MaxOutstandingLabelBalance>decimal</MaxOutstandingLabelBalance>
<POURMailerID>boolean</POURMailerID>
</PayOnUse>
<ConfiguredCarriers>
<Carrier>
<Carrier>string</Carrier>
<UserOwnedAccount>boolean</UserOwnedAccount>
</Carrier>
<Carrier>
<Carrier>string</Carrier>
<UserOwnedAccount>boolean</UserOwnedAccount>
</Carrier>
</ConfiguredCarriers>
</AccountStatusResponse>
</GetAccountStatusXMLResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /LabelService/EwsLabelService.asmx/GetAccountStatusXML?accountStatusRequestXML=string HTTP/1.1 Host: labelserver.endicia.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<AccountStatusResponse xmlns="www.envmgr.com/LabelService">
<Status>int</Status>
<ErrorMessage>string</ErrorMessage>
<RequesterID>string</RequesterID>
<RequestID>string</RequestID>
<CertifiedIntermediary>
<AccountID>string</AccountID>
<SerialNumber>int</SerialNumber>
<PostageBalance>decimal</PostageBalance>
<AscendingBalance>decimal</AscendingBalance>
<AccountStatus>string</AccountStatus>
<DeviceID>string</DeviceID>
<ReferenceID>string</ReferenceID>
</CertifiedIntermediary>
<Discounts>
<PriorityMail Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<PMExpress Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<FCPS Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<PMI Discount="ComBase or CPP or Custom" />
<EMI Discount="ComBase or CPP or Custom" />
<FCPIS Discount="ComBase or CPP or Custom" />
</Discounts>
<AccountType>USPS or Retail</AccountType>
<ApprovedShipper>boolean</ApprovedShipper>
<ConsolidatorServices>boolean</ConsolidatorServices>
<ConsolidatorServiceDetail>
<InternationalConsolidator>boolean</InternationalConsolidator>
<EnabledInternationalConsolidatorServices>
<EnabledInternationalConsolidatorService>
<EnabledInternationalConsolidatorServiceID>string</EnabledInternationalConsolidatorServiceID>
<EnabledInternationalConsolidatorBrandedServiceName>string</EnabledInternationalConsolidatorBrandedServiceName>
<EnabledInternationalConsolidatorGenericServiceName>string</EnabledInternationalConsolidatorGenericServiceName>
</EnabledInternationalConsolidatorService>
<EnabledInternationalConsolidatorService>
<EnabledInternationalConsolidatorServiceID>string</EnabledInternationalConsolidatorServiceID>
<EnabledInternationalConsolidatorBrandedServiceName>string</EnabledInternationalConsolidatorBrandedServiceName>
<EnabledInternationalConsolidatorGenericServiceName>string</EnabledInternationalConsolidatorGenericServiceName>
</EnabledInternationalConsolidatorService>
</EnabledInternationalConsolidatorServices>
<TypeCodes>
<TypeCode>
<Name>string</Name>
<Code>string</Code>
</TypeCode>
<TypeCode>
<Name>string</Name>
<Code>string</Code>
</TypeCode>
</TypeCodes>
<ServiceInfo>
<Services>
<Service d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Service d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Services>
</ServiceInfo>
</ConsolidatorServiceDetail>
<ContractID>
<DomesticCID>string</DomesticCID>
<InternationalCID>string</InternationalCID>
</ContractID>
<InsuranceAgreement>boolean</InsuranceAgreement>
<AccountStatus>
<Status>string</Status>
<ReturnCode>int</ReturnCode>
</AccountStatus>
<ControlRegister>decimal</ControlRegister>
<LicenseZip5>string</LicenseZip5>
<Address>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Address1>string</Address1>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<ZipCodeAddOn>string</ZipCodeAddOn>
<PhoneNumber>string</PhoneNumber>
</Address>
<AccountFeatures>
<Feature>
<Code>string</Code>
<Name>string</Name>
<IsEligible>boolean</IsEligible>
<IsActive>boolean</IsActive>
<TermsAndConditionsLink>string</TermsAndConditionsLink>
</Feature>
<Feature>
<Code>string</Code>
<Name>string</Name>
<IsEligible>boolean</IsEligible>
<IsActive>boolean</IsActive>
<TermsAndConditionsLink>string</TermsAndConditionsLink>
</Feature>
</AccountFeatures>
<PayOnUse>
<OutstandingLabelBalance>decimal</OutstandingLabelBalance>
<MaxOutstandingLabelBalance>decimal</MaxOutstandingLabelBalance>
<POURMailerID>boolean</POURMailerID>
</PayOnUse>
<ConfiguredCarriers>
<Carrier>
<Carrier>string</Carrier>
<UserOwnedAccount>boolean</UserOwnedAccount>
</Carrier>
<Carrier>
<Carrier>string</Carrier>
<UserOwnedAccount>boolean</UserOwnedAccount>
</Carrier>
</ConfiguredCarriers>
</AccountStatusResponse>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /LabelService/EwsLabelService.asmx/GetAccountStatusXML HTTP/1.1 Host: labelserver.endicia.com Content-Type: application/x-www-form-urlencoded Content-Length: length accountStatusRequestXML=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<AccountStatusResponse xmlns="www.envmgr.com/LabelService">
<Status>int</Status>
<ErrorMessage>string</ErrorMessage>
<RequesterID>string</RequesterID>
<RequestID>string</RequestID>
<CertifiedIntermediary>
<AccountID>string</AccountID>
<SerialNumber>int</SerialNumber>
<PostageBalance>decimal</PostageBalance>
<AscendingBalance>decimal</AscendingBalance>
<AccountStatus>string</AccountStatus>
<DeviceID>string</DeviceID>
<ReferenceID>string</ReferenceID>
</CertifiedIntermediary>
<Discounts>
<PriorityMail Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<PMExpress Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<FCPS Discount="ComBase or CPP or Custom" CubicPricing="boolean" FlatRatePaddedEnvelope="boolean" HalfPoundRate="boolean" RegionalRateBox="boolean" OpenAndDistribute="boolean" />
<PMI Discount="ComBase or CPP or Custom" />
<EMI Discount="ComBase or CPP or Custom" />
<FCPIS Discount="ComBase or CPP or Custom" />
</Discounts>
<AccountType>USPS or Retail</AccountType>
<ApprovedShipper>boolean</ApprovedShipper>
<ConsolidatorServices>boolean</ConsolidatorServices>
<ConsolidatorServiceDetail>
<InternationalConsolidator>boolean</InternationalConsolidator>
<EnabledInternationalConsolidatorServices>
<EnabledInternationalConsolidatorService>
<EnabledInternationalConsolidatorServiceID>string</EnabledInternationalConsolidatorServiceID>
<EnabledInternationalConsolidatorBrandedServiceName>string</EnabledInternationalConsolidatorBrandedServiceName>
<EnabledInternationalConsolidatorGenericServiceName>string</EnabledInternationalConsolidatorGenericServiceName>
</EnabledInternationalConsolidatorService>
<EnabledInternationalConsolidatorService>
<EnabledInternationalConsolidatorServiceID>string</EnabledInternationalConsolidatorServiceID>
<EnabledInternationalConsolidatorBrandedServiceName>string</EnabledInternationalConsolidatorBrandedServiceName>
<EnabledInternationalConsolidatorGenericServiceName>string</EnabledInternationalConsolidatorGenericServiceName>
</EnabledInternationalConsolidatorService>
</EnabledInternationalConsolidatorServices>
<TypeCodes>
<TypeCode>
<Name>string</Name>
<Code>string</Code>
</TypeCode>
<TypeCode>
<Name>string</Name>
<Code>string</Code>
</TypeCode>
</TypeCodes>
<ServiceInfo>
<Services>
<Service d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Service d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Services>
</ServiceInfo>
</ConsolidatorServiceDetail>
<ContractID>
<DomesticCID>string</DomesticCID>
<InternationalCID>string</InternationalCID>
</ContractID>
<InsuranceAgreement>boolean</InsuranceAgreement>
<AccountStatus>
<Status>string</Status>
<ReturnCode>int</ReturnCode>
</AccountStatus>
<ControlRegister>decimal</ControlRegister>
<LicenseZip5>string</LicenseZip5>
<Address>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Address1>string</Address1>
<City>string</City>
<State>string</State>
<ZipCode>string</ZipCode>
<ZipCodeAddOn>string</ZipCodeAddOn>
<PhoneNumber>string</PhoneNumber>
</Address>
<AccountFeatures>
<Feature>
<Code>string</Code>
<Name>string</Name>
<IsEligible>boolean</IsEligible>
<IsActive>boolean</IsActive>
<TermsAndConditionsLink>string</TermsAndConditionsLink>
</Feature>
<Feature>
<Code>string</Code>
<Name>string</Name>
<IsEligible>boolean</IsEligible>
<IsActive>boolean</IsActive>
<TermsAndConditionsLink>string</TermsAndConditionsLink>
</Feature>
</AccountFeatures>
<PayOnUse>
<OutstandingLabelBalance>decimal</OutstandingLabelBalance>
<MaxOutstandingLabelBalance>decimal</MaxOutstandingLabelBalance>
<POURMailerID>boolean</POURMailerID>
</PayOnUse>
<ConfiguredCarriers>
<Carrier>
<Carrier>string</Carrier>
<UserOwnedAccount>boolean</UserOwnedAccount>
</Carrier>
<Carrier>
<Carrier>string</Carrier>
<UserOwnedAccount>boolean</UserOwnedAccount>
</Carrier>
</ConfiguredCarriers>
</AccountStatusResponse>