Transfer

Input XML Tags

XML Tag

Definition

Rules

fromhouse

from house beginning identifier. For the fromhouse group either the Reschedule xml input or Disoconnect xml input will be required,or just the corp,house,cust and custlevelpin. Either one of these inputs will be required at any given time. This will depend upon the status of the account (cstat in the custmaster table).

disconnect

 

If the house is ACTV then perform a disconnect operation. Beginning identifier

See Disconnect API XML document

   

/disconnect

 

disconnect tag ending identifier

reschedule

Else if the house is P/DS then perform a reschedule operation on the from house.Beginning Identifier. Should be Reschedule

See Reschedule API XML document

   

/reschedule

 

reschedule tag ending identifier

Else if account/customer = X/IN or DISC send the corp,house,cust,opr,pin,lockacct_pid for the from house to perfom the transfer

apiname

API Name Name Tag to identify the operation that needs to be performed on the from house, should be blank in this case

comcorp

Five digit corp number

Five digit system number assigned to each corp.

house

Six digit house number

Up to six digit house number

cust

Two digit customer number

Two digit customer number

opr

Three digit operator id

3 characters, legal operator id

custlevelpin

Four character field

Five digit customer level pin

lockacct_pid

5 character field

5 digit unique locking pid (1,001 - 65, 535) (05-23-2001)

/fromhouse

   

tohouse

tohouse beginning identifier. For the tohouse group either the Reschedule xml input or install xml input will be required. If the house is active an autodisconnect operation will be performed. Either one of these inputs will be required at any given time. This will depend upon the status of the account (cstat in the custmaster table).

reschedule

if the house is P/Install then perform a reschedule operation on the from house.Beginning Identifier. Should be Reschedule

See Reschedule API XML document

   

/reschedule

 

reschedule tag ending identifier

install

 

Else do an install on the customer.install tag beginning identifier

See Install API XML document

   

/install

 

install tag ending identifier

/tohouse

 

tohouse ending identifier

 

Output XML Tags

XML Tag

Definition

errorcode

short

errormessage

char

 

Change Log

8/16/01

1. Added lockacct_pid tag after custlevelpin tag

 

Corrected second ELSE statement for "from" account portion of API

8/24/01

2. Added the following new tags to the "to" account section of the API: xferbillingaddr, xferefts, xfercustpin, xfercomments

9/6/01

Removed xferbillingaddr, xferefts, xfercustpin and xfercomments fields for Revision A API service.

 

Usage

 

Associated XML Documents