|
XML Tag |
Definition |
Rules |
|
comcorp |
5 digit field |
Five digit system number assigned to each corp. The corp number is unique only within one Tandem system. |
|
house |
6 character field |
House number. Numeric only |
|
cust |
2 character field |
Customer number. Numeric values only. |
|
opr |
3 character field |
3 character operator id, must be in Opreator Id table. |
|
custlevelpin |
4 character field |
Four digit customer level pin |
|
lockacct_pid |
5 character field |
5 digit unique locking pid (1,001 - 65, 535) (05-23-2001) |
|
jobtype |
3 character field |
WIP, T/C, SRO |
|
chgwipdata |
1 character field |
Valid values: Y = changing wip data, N = not changing WIP data (see Usage section of Reschedule document) |
|
chgschedule |
1 character field |
Valid values: Y = changing schedule data, N = not changing schedule data (see Usage section of Reschedule document) |
|
c_rareacd |
3 digit field |
Residence/home phone area code.. Valid Values |
|
c_rphon |
7 character field |
Customer's residence phone number. Valid Values: |
|
c_rphonarea |
1 character field |
Code36 table (111) tied to the residence phone number. (used to be 8th digit of phone). Valid Values: 0-9, A-Z |
|
c_bphone |
10 character field |
Customer's business phone number. Valid Values: If CREDITCHKTRANS, AAAPPPSSSS where aaa=area codeppp=prefix, ssss=suffix. |
|
c_ssn |
9 character field |
Customer's Social Security number. Numeric values only. |
|
wipinfogroup |
wipinfogroup beginning delimiter | |
|
disc_reason |
1 character field |
Code 36 (117) |
|
c_badr |
1 character field |
If blank (or anything but "1" or "2") = no billing address; If "1" or "2" = billing address and designates billing address format: 1=Billing address only-add'l mail to svc addrs 2=Mailing address - all mail to this address |
|
cba_bil1 |
26 character field |
The 'in care of' line of the billing address. |
|
cba_bil2 |
26 character field |
Street address. |
|
cba_bil3 |
17 character field |
City and state. Formatting for this field to conform to DDP/SQL standards require that the City be in characters 1 - 14, followed by a "space" in character 15, with the State in characters 16 - 17 |
|
cba_bil4 |
6 character field |
Billing zip code. |
|
cmnt_commt |
350 character field |
Text of a free form comment. Maximum size = 350; variable storage determined by max length parameter, cp_ccom1maxln field in GetControlParams API transaction. |
|
w_wchrsn |
1 character field |
Code 36 (140) Reason for the change of service. |
|
w_cmpg |
1 character field |
Campaign code on this job. Code36 table (112). Check op.oebpcamp to bypass this field. |
|
w_salrn |
1 character field |
Sales reason on this job. Code36 table (113). Check op.oebpsalesrsn to bypass this field. |
|
w_slsrep |
3 character field |
Sales rep who sold this account. Use GetSalesperson transaction to check for valid salesman. |
|
h_dwell |
1 character field |
Code36 (106) This field is only needed if op_wipinfo = 2 (GetOrderParams API transaction) |
|
h_ovug |
1 character field |
Indicates how the drop enters the house . Valid Values: O =overhead,U=underground This field is only needed if op_wipinfo = 1 (GetOrderParams API transaction) |
|
h_fibernode |
20 character field |
Used by HSDS to store the node information from the head end. Valid Values: alpha/numeric |
|
h_network_id |
20 character field |
Used by HSDS to store nodes information out in the plant. Valid Values: alpha/numeric |
|
outletgroup |
outletgroup beginning delimiter | |
|
outlet |
outlet beginning delimiter | |
|
wo_outlet |
2 digit field |
Outlet number. Valid Values: 1-60 |
|
pt_pkg |
2 character field |
Package code. Will not update the table. Read only |
|
wo_boxloc |
1 character field |
Outlet location code. Code36 (120) |
|
ratecode group |
ratecodegroup beginning delimiter | |
|
ratecode |
ratecode beginning delimiter | |
|
wor_ratecd |
2 character field |
Rate code associated with this charge level. |
|
wor_cnt |
short |
Rate code count for the service on this outlet. Valid Values: |
|
non_std_amt |
6 digit field |
This is the non standard amount associated with a nonstandard rate code |
|
/ratecode |
ratecode ending delimiter | |
|
/ratecode group |
ratecodegroup ending delimiter | |
|
taskcodegroup |
taskcodegroup beginning delimiter | |
|
wo_taskcode |
2 character field |
Task/problem code depending on job type. There has to be at least one task code present in the API and there could up to 8 task codes associated with one outlet. Code95 table (201). The CSR can also enter a non standard task code in this field. There can only be one non standard task code, these task codes are defined as 90 and above. |
|
wo_taskcount |
2 digit numeric |
This field is only populated if there is a custom task code in the task field |
|
/taskcodegroup |
taskcodegroup ending delimiter | |
|
wo_pts |
short |
This field is only populated if there is a non standard task code in the task field. |
|
dss_username |
30 character field |
User name if data service subscription, user name for access. Valid Values: If data service subscription, alphanumeric character string |
|
dss_password |
30 character field |
The password a subscriber would use to access the data service subscription. Valid Values: Alphanumeric character string |
|
/outlet |
outlet ending delimiter | |
|
/outletgroup |
outletgroup ending delimiter | |
|
/wipinfogroup |
wipinfogroup ending delimiter | |
| ScheduleActionGroup (See ScheduleActionGroup document) | ||
|
W_wspcl |
3 character field |
Alpha-numeric; All schedule types; code 36 (131);up to 3 codes possible |
|
w_wbdate |
datetime |
Start/stop bill date for the order. Valid Values: YYYY-MM-DD |
|
w_wrem |
1 character field |
Code36 table (122) |
|
w_wdiscnt |
1 character field |
Code36 table (121) |
|
w_wform |
1 character field |
Code36 table (124) |
|
w_wmsg |
1 character field |
|
|
w_wpro |
1 character field |
Code36 (123) |
|
w_wmode |
1 character field |
Billing mode. Valid Values: Code36 (125) |
|
w_wcod |
1 character field |
User defined COD code. Valid Values: any valid value in the table retrieved through GetCODTable transaction. |
|
w_annivday |
2 digit numeric |
Day of the month specified as the customer's anniversary day. Valid Values: 1-31 |
|
cte_taxcode |
10 character field |
Tax code exempt. 10 character field with positional Ys and Ns for legal values in the Code36 table (165). Any value sent that is not a "Y" will be treated as an "N". |
|
woc_commt |
350 characters maximum |
Alpha-numeric, maximum charters = 350; amount of data stored dependent on cp_wipcommaxln field from GetControlParams transaction. |
|
w_wordrsn |
1 character order code |
Alpha-numeric; code36 (139) |
|
cmnt_comnt |
350 characters maximum |
Alpha-numeric, maximum charters = 350; amount of data stored dependent on cp_ordcommaxln field in GetControlParams transaction (See Usage Area) |
|
cdwf_dflash |
350 characters maximum |
Alpha-numeric, maximum charters = 350; amount of data stored dependent on cp_wipcommaxln field in GetControlParams transaction. |
|
XML Tag |
Definition |
|
errorcode |
short |
|
errormessage |
char |
|
5/7/01 |
Added formatting description to cba_bil3 field |
|
5/9/01 |
Moved ScheduleActionGroup to separate document spreadsheet |
|
5/11/01 |
Added h_fibernode, h_networkid, dss_username and dss_password |
|
Removed c_driverslcnum field (not used) | |
|
Add h_dwell and h_ovug | |
|
5/23/01 |
Added lockacct_pid data field for locking functionality |
|
6/7/01 |
Added w_wordrsn and cmnt_comnt (Order Reason and Order Comment) tags to XML document |
|
6/29/01 |
Added usage description for the inclusion of the disconnect taskcode field. |
|
Added usage information concerning tags that are not being used in the XML document at this time. | |
|
Added usage information concerning the cte_taxexempt field usage. | |
|
7/3/01 |
Updated description/rules for cte_taxexempt field. |
|
7/5/01 |
Added chgwipdata field and item 5 to usage section of document. |
|
7/11/01 |
Added chgschedule field and item 6 to usage section of document |
|
Modified Usage section for item 5 | |
|
Added wipinfogroup tag | |
|
Modified Usage section for item 3 – removed w_wmode from list of tags. | |
|
7/16/01 |
Added Item 7 to Usage section |
|
7/20/01 |
Modified Item 7 in Usage Section |
|
8/25/01 |
Updated description/rules for cdwfl_dflash, cmnt_comnt, woc_comnt, h_ovug, h_dwell, w_slsrep, cmnt_comnt. |
1. The w_ordrsn and cmnt_comnt tags in the main part of the document are provided for all Reschedule types and will overwrite any data provided in the fields of the same name within the "noschedule" section of the Scheduling Action Group.
2. The Reschedule API is generically used for all types of jobs that can be "rescheuduled". A task code is required when doing a Disconnect. Instead of creating a new field for this value, it should be placed in the document under outletgroup, outlet, wo_outlet = 1, tascodegroup, wo_taskcode = "Disconnect taskcode".
3. The following tags are not being used by the Reschedule API and values within them will be ignored. (w_wrem, w_wdiscnt, w_wform, w_wmsg, w_wpro, w_wmode)
4. The cte_taxexempt field is only valid for those "jobs" where the field could be populated when the information was originally taken. Not valid for Change Of Service, Disconnect, Trouble Call or Special Request Order transactions.
5. If the chgwipdata flag is set to "Y", then the wipinfogroup (beginning and ending delimeters) and its tags must be present. If the chgwipdata flag is set to "N", only the wipinfogroup, beginning and ending delimeters, need be present. If neither a "Y" or an "N" is sent in the chgwipdata field, the transaction will be rejected.
6. If the chgschedule flag is set to "Y", then the scheduleaction tag and schedulegroup with its tags need to be present [these are part of the ScheduleActionGroup, documented on a separate sheet within this spreadsheet.] If the chgschedule flag is set to "N", the scheduleaction tag and schedulegroup tag must be present, though the values within them will be ignored. If neither a "Y" or an "N" is sent in the chgschedule field, the transaction will be rejected.
7. If Changing WIP data and rescheduling a WIP: send all outlets desired on order; No change to outlet --> send outlet with blank (single space, not null) pt_pkg to keep existing data for that outlet, Add outlet --> send outlet with valid pt_pkg, Delete outlet --> not sending outlet means removing outlet altogether from pending order. If Changing WIP data and rescheduling a T/C or SRO: send all outlets on order ; "No change to outlet", "Adding outlet" and "Deleting outlet" all handled by "total replacement" of old pending T/C or SRO with new T/C or SRO.