GetOutletInfo

Input XML Tags

XML Tag

Definition

comcorp

Five digit system number assigned to each corp.

house

Six digit house number

cust

Two digit customer number

outlet

Optional tag - currently API returns information for all outlets (in future may use optional "outlet" values of 1-60)

 

Output XML Tags

XML Tag

Column Name

Data Type

Nullable

Definition

co_corp

CORP

INT UNSIGNED

N

Two digit system number assigned to each corp.Thecorp # is unique only within one Tandem system..

co_partition

PARTITION

CHAR(2)

N

Data hashing value for database management - equals the last 2 digits of the house #.

co_house

HOUSE

CHAR(6)

N

House number. Valid Values: Alpha/Numeric

co_cust

CUST

CHAR(2)

N

Customer number.

outletgroup

     

Beginning outletgroup delimiter

outlet

     

Beginning outlet delimiter

co_outlet

OUTLET

SMALLINT SIGNED

N

Outlet number. Valid Values: 1-60

co_bnumb

BNUMB

CHAR(14)

N

Box serial number. Valid Values: Alpha/Numeric

co_loc

     

Beginning co_loc delimiter

code

LOC

CHAR(1)

N

Indicates the location of the box (house or inventory).

shortdescription

 

CHAR(8)

 

Location short description

longdescription

 

CHAR(30)

 

Location long description

/co_loc

     

Ending co_loc delimiter

co_addleq

ADDLEQ

CHAR(8)

N

Any additional equipment information pertaining tothis box, such as remote control number.

outletservice

     

Beginning outletservice delimiter

code

SERVICE

CHAR(2)

N

Rate code for service provided at this outlet.

shortdescription

 

CHAR(8)

 

Rate code short description

longdescription

 

CHAR(30)

 

Rate code long description

os_cnt

CNT

SMALLINT UNSIGNED

N

Rate code count for the service on this outlet *OR* collection forecast step count.

/outletservice

     

Ending outletservice delimiter

/outlet

     

Ending outlet delimiter

/outletgroup

     

Ending outletgroup delimiter

 

Source Tables

 

Description

 

Change Log

08/07/01

Modified the input XML doc - opr is needed instead of the outlet number.

9/4/01

Modified the input XML doc - replaced opr "input" tag with outlet "input" tag (noted that tag is currently not being used by API)

 

Usage