Update Person
put
https://server:port/spl/rest/apis/customer/v-model/persons/{personId}
Request
Path Parameters
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
characteristics: object
characteristics
Configured additional attributes for any additional information that needs to be maintained for persons.
-
contactDetails: object
contactDetails
-
emailAddress: string
Maximum Length:
254
Email Address -
identifiers: object
identifiers
Identifiers are used for validating the identity of a customer based on their provided form of identification.
-
language: object
language
Language in which the person prefers their bills and correspondences.
-
lifeSupportSensitiveLoad: string
Allowed Values:
[ "N ", "Y " ]
Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. * `N ` - None, * `Y ` - LS/SLExample:N
-
lifeSupportSensitiveLoadDescription: string
Maximum Length:
1000
Life Support or Sensitive Load Description supports additional notes for life support information or equipment associated with the person. -
names: object
names
-
overrideMailingAddress: object
overrideMailingAddress
Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.
-
overrideMailingName1: string
Maximum Length:
254
Override Mailing Name for addressee on the person's correspondence and bills. -
overrideMailingName2: string
Maximum Length:
254
Override Mailing Name Line 2 for addressee on the person's correspondence and bills. -
overrideMailingName3: string
Maximum Length:
254
Override Mailing Name Line 3 for addressee on the person's correspondence and bills. -
paymentOptions: object
paymentOptions
-
personId: string
Maximum Length:
10
Person ID is a system-assigned random number that stays with a person for the life of the system.Example:5775933103
-
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Defines the person entity as a person or business which controls validation of the person entity's primary name. * `B ` - Business, * `P ` - Person -
relationships: object
relationships
-
seasonalAddresses: object
seasonalAddresses
Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.
-
timeZone: object
timeZone
Defines the person's Time Zone preference if it is different from the system installation's time zone.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristics
Type:
object
Configured additional attributes for any additional information that needs to be maintained for persons.
Show Source
Nested Schema : identifiers
Type:
object
Identifiers are used for validating the identity of a customer based on their provided form of identification.
Show Source
Nested Schema : language
Type:
object
Language in which the person prefers their bills and correspondences.
Show Source
-
language: string
Maximum Length:
3
Language in which the person prefers their bills and correspondences.Example:ENG
Nested Schema : overrideMailingAddress
Type:
object
Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.
Show Source
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits.
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2 -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographical Code is used to apply proper taxation rules to the physical address location.
Nested Schema : seasonalAddresses
Type:
object
Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.
Show Source
Nested Schema : timeZone
Type:
object
Defines the person's Time Zone preference if it is different from the system installation's time zone.
Show Source
-
timeZone: string
Maximum Length:
10
Defines the person's Time Zone preference if it is different from the system installation's time zone.
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
contactDetailActiveInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - InactiveExample:Active/Inactive: C1AC - Active, C1IN - Inactive
-
contactDetailId: string
Maximum Length:
10
Person Contact -
contactDetailPrimary: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - YesExample:Primary: C1NO - No, C1YS - Yes
-
contactDetailStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. The initial status can be defined from the Person Contact Type and manually maintained, or configured to be controlled by a process such as an Opt-In process. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPendingExample:Contact Status: C1AP - Approved, C1PN - Pending, C1RJ - Rejected
-
contactDetailValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as, the phone number or email address in the associated format.Example:krish11@yahoo.com, (415) 987-1298
-
contactDetailValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.) -
contactNickname: string
Maximum Length:
100
Contact Nickname can be assigned by self-service users. -
doNotDisturbEndDate: string
Do Not Disturb (To)
-
doNotDisturbStartDate: string
Do Not Disturb (From)
-
personContactType: object
personContactType
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : personContactType
Type:
Show Source
object
-
personContactType: string
Maximum Length:
30
Person Contact Type
Nested Schema : items
Type:
Show Source
object
-
idNumber: string
Maximum Length:
100
ID Number -
idType: object
idType
-
isPrimaryId: boolean
Primary ID switch is true if this is the primary means of identification for the customer.Example:
false
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : idType
Type:
Show Source
object
-
idType: string
Maximum Length:
8
ID Type indicates the type of identification and receives a default value from the Installation Record based on the Person Type.
Nested Schema : items
Type:
Show Source
object
-
isPrimaryName: boolean
Primary Name is defined as true if this is the primary name for the customer.Example:
true
-
nameType: string
Allowed Values:
[ "AL ", "ALT ", "DBA ", "FORM", "LGAL", "PRIM" ]
Name Type indicates if the name is an Alias, Alternate Representation, Doing Business As, Legal, or Primary name. Note, for new persons, a value of Primary is the default value. The values for the name type field are customizable using the applicable lookup table. * `AL ` - Alias, * `ALT ` - Alternate Representation, * `DBA ` - Doing Business As, * `FORM` - Former, * `LGAL` - Legal, * `PRIM` - PrimaryExample:PRIM (Primary)
-
personName: string
Maximum Length:
254
Person Name captures the person's name. The name is case-sensitive. -
sequence: number
Minimum Value:
-999
Maximum Value:999
A sequence is used to define the order of the records. -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : items
Type:
Show Source
object
-
bankAccountInfo: object
bankAccountInfo
-
creditCardInfo: object
creditCardInfo
-
paymentType: string
Allowed Values:
[ "27 ", "28 ", "37 ", "38 ", "47 " ]
Payment type is a two-digit code that indicates the banking transaction as a debit or credit and type of financial account. * `27 ` - Checking Withdrawal, * `28 ` - Checking Debit Prenotification, * `37 ` - Savings Withdrawal, * `38 ` - Savings Debit Prenotification, * `47 ` - Credit Card WithdrawalExample:47 (Credit Card Withdrawal)
-
selfServicePaymentOptionId: string
Maximum Length:
12
Payment Option ID is a system-assigned random number for the record.
Nested Schema : bankAccountInfo
Type:
Show Source
object
-
accountNumber: string
Maximum Length:
50
The account number to be used for payment transactions.Example:1223428263
-
autoPaySource: string
Maximum Length:
12
Auto Pay Source -
routingNumber: string
Maximum Length:
30
The routing number identifies the bank or financial institution for payment transactions.
Nested Schema : creditCardInfo
Type:
Show Source
object
-
addressLine1: string
Maximum Length:
254
Address -
addressLine2: string
Maximum Length:
254
Address 2 -
addressLine3: string
Maximum Length:
254
Address 3 -
addressLine4: string
Maximum Length:
254
Address 4 -
cardHolderFirstName: string
Maximum Length:
50
Cardholder First Name -
cardHolderLastName: string
Maximum Length:
50
Credit card holder last name. -
cardNumber: string
Maximum Length:
60
Number of the credit card. -
cardType: string
Allowed Values:
[ "C1AM", "C1DV", "C1MC", "C1VS" ]
Card type indicates the credit card processing network such as American Express, Discover, MasterCard, or Visa. * `C1AM` - American Express, * `C1DV` - Discover, * `C1MC` - MasterCard, * `C1VS` - VisaExample:C1AM
-
city: string
Maximum Length:
90
City -
county: string
Maximum Length:
90
County -
expiryMonth: string
Maximum Length:
2
Credit card expiration month. -
expiryYear: string
Maximum Length:
4
Credit card expiration year -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2
Nested Schema : items
Type:
Show Source
object
-
childPersonId: string
Maximum Length:
10
Person ID -
endDate: string
(date)
End Date indicates the relationship expires, indicate the date the relationship stops.Example:
1950-01-01
-
hasFinancialRelationship: boolean
Financial Relationship indicates if the child person is related to accounts which should be displayed in the parent person's hierarchy.Example:
false
-
personRelationshipType: object
personRelationshipType
-
startDate: string
(date)
Start Date indicates the date on which this relationship began.Example:
1950-01-01
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : personRelationshipType
Type:
Show Source
object
-
personRelationshipType: string
Maximum Length:
8
Relationship Type
Nested Schema : items
Type:
Show Source
object
-
address: object
address
-
effectiveStatus: string
Allowed Values:
[ "A ", "I " ]
Status of the address must be Active to be used. The status can be set to Inactive for the seasonal address to be ignored. * `A ` - Active, * `I ` - InactiveExample:Status: A - Active, I - Inactive
-
endMonthDay: string
Maximum Length:
4
End Month Day contains the day and month when the season ends.Example:1231
-
sequence: number
Minimum Value:
-999
Maximum Value:999
A sequence is used to define the order of the records. -
startMonthDay: string
Maximum Length:
4
Start Month Day contains the day and month when the season starts.Example:0201
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits.
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2 -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographical Code is used to apply proper taxation rules to the physical address location.
Root Schema : schema
Type:
Show Source
object
-
characteristics: object
characteristics
Configured additional attributes for any additional information that needs to be maintained for persons.
-
contactDetails: object
contactDetails
-
emailAddress: string
Maximum Length:
254
Email Address -
identifiers: object
identifiers
Identifiers are used for validating the identity of a customer based on their provided form of identification.
-
language: object
language
Language in which the person prefers their bills and correspondences.
-
lifeSupportSensitiveLoad: string
Allowed Values:
[ "N ", "Y " ]
Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. * `N ` - None, * `Y ` - LS/SLExample:N
-
lifeSupportSensitiveLoadDescription: string
Maximum Length:
1000
Life Support or Sensitive Load Description supports additional notes for life support information or equipment associated with the person. -
names: object
names
-
overrideMailingAddress: object
overrideMailingAddress
Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.
-
overrideMailingName1: string
Maximum Length:
254
Override Mailing Name for addressee on the person's correspondence and bills. -
overrideMailingName2: string
Maximum Length:
254
Override Mailing Name Line 2 for addressee on the person's correspondence and bills. -
overrideMailingName3: string
Maximum Length:
254
Override Mailing Name Line 3 for addressee on the person's correspondence and bills. -
paymentOptions: object
paymentOptions
-
personId: string
Maximum Length:
10
Person ID is a system-assigned random number that stays with a person for the life of the system.Example:5775933103
-
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Defines the person entity as a person or business which controls validation of the person entity's primary name. * `B ` - Business, * `P ` - Person -
relationships: object
relationships
-
seasonalAddresses: object
seasonalAddresses
Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.
-
timeZone: object
timeZone
Defines the person's Time Zone preference if it is different from the system installation's time zone.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristics
Type:
object
Configured additional attributes for any additional information that needs to be maintained for persons.
Show Source
Nested Schema : identifiers
Type:
object
Identifiers are used for validating the identity of a customer based on their provided form of identification.
Show Source
Nested Schema : language
Type:
object
Language in which the person prefers their bills and correspondences.
Show Source
-
language: string
Maximum Length:
3
Language in which the person prefers their bills and correspondences.Example:ENG
Nested Schema : overrideMailingAddress
Type:
object
Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.
Show Source
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits.
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2 -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographical Code is used to apply proper taxation rules to the physical address location.
Nested Schema : seasonalAddresses
Type:
object
Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.
Show Source
Nested Schema : timeZone
Type:
object
Defines the person's Time Zone preference if it is different from the system installation's time zone.
Show Source
-
timeZone: string
Maximum Length:
10
Defines the person's Time Zone preference if it is different from the system installation's time zone.
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
contactDetailActiveInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - InactiveExample:Active/Inactive: C1AC - Active, C1IN - Inactive
-
contactDetailId: string
Maximum Length:
10
Person Contact -
contactDetailPrimary: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - YesExample:Primary: C1NO - No, C1YS - Yes
-
contactDetailStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. The initial status can be defined from the Person Contact Type and manually maintained, or configured to be controlled by a process such as an Opt-In process. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPendingExample:Contact Status: C1AP - Approved, C1PN - Pending, C1RJ - Rejected
-
contactDetailValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as, the phone number or email address in the associated format.Example:krish11@yahoo.com, (415) 987-1298
-
contactDetailValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.) -
contactNickname: string
Maximum Length:
100
Contact Nickname can be assigned by self-service users. -
doNotDisturbEndDate: string
Do Not Disturb (To)
-
doNotDisturbStartDate: string
Do Not Disturb (From)
-
personContactType: object
personContactType
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : personContactType
Type:
Show Source
object
-
personContactType: string
Maximum Length:
30
Person Contact Type
Nested Schema : items
Type:
Show Source
object
-
idNumber: string
Maximum Length:
100
ID Number -
idType: object
idType
-
isPrimaryId: boolean
Primary ID switch is true if this is the primary means of identification for the customer.Example:
false
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : idType
Type:
Show Source
object
-
idType: string
Maximum Length:
8
ID Type indicates the type of identification and receives a default value from the Installation Record based on the Person Type.
Nested Schema : items
Type:
Show Source
object
-
isPrimaryName: boolean
Primary Name is defined as true if this is the primary name for the customer.Example:
true
-
nameType: string
Allowed Values:
[ "AL ", "ALT ", "DBA ", "FORM", "LGAL", "PRIM" ]
Name Type indicates if the name is an Alias, Alternate Representation, Doing Business As, Legal, or Primary name. Note, for new persons, a value of Primary is the default value. The values for the name type field are customizable using the applicable lookup table. * `AL ` - Alias, * `ALT ` - Alternate Representation, * `DBA ` - Doing Business As, * `FORM` - Former, * `LGAL` - Legal, * `PRIM` - PrimaryExample:PRIM (Primary)
-
personName: string
Maximum Length:
254
Person Name captures the person's name. The name is case-sensitive. -
sequence: number
Minimum Value:
-999
Maximum Value:999
A sequence is used to define the order of the records. -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : items
Type:
Show Source
object
-
bankAccountInfo: object
bankAccountInfo
-
creditCardInfo: object
creditCardInfo
-
paymentType: string
Allowed Values:
[ "27 ", "28 ", "37 ", "38 ", "47 " ]
Payment type is a two-digit code that indicates the banking transaction as a debit or credit and type of financial account. * `27 ` - Checking Withdrawal, * `28 ` - Checking Debit Prenotification, * `37 ` - Savings Withdrawal, * `38 ` - Savings Debit Prenotification, * `47 ` - Credit Card WithdrawalExample:47 (Credit Card Withdrawal)
-
selfServicePaymentOptionId: string
Maximum Length:
12
Payment Option ID is a system-assigned random number for the record.
Nested Schema : bankAccountInfo
Type:
Show Source
object
-
accountNumber: string
Maximum Length:
50
The account number to be used for payment transactions.Example:1223428263
-
autoPaySource: string
Maximum Length:
12
Auto Pay Source -
routingNumber: string
Maximum Length:
30
The routing number identifies the bank or financial institution for payment transactions.
Nested Schema : creditCardInfo
Type:
Show Source
object
-
addressLine1: string
Maximum Length:
254
Address -
addressLine2: string
Maximum Length:
254
Address 2 -
addressLine3: string
Maximum Length:
254
Address 3 -
addressLine4: string
Maximum Length:
254
Address 4 -
cardHolderFirstName: string
Maximum Length:
50
Cardholder First Name -
cardHolderLastName: string
Maximum Length:
50
Credit card holder last name. -
cardNumber: string
Maximum Length:
60
Number of the credit card. -
cardType: string
Allowed Values:
[ "C1AM", "C1DV", "C1MC", "C1VS" ]
Card type indicates the credit card processing network such as American Express, Discover, MasterCard, or Visa. * `C1AM` - American Express, * `C1DV` - Discover, * `C1MC` - MasterCard, * `C1VS` - VisaExample:C1AM
-
city: string
Maximum Length:
90
City -
county: string
Maximum Length:
90
County -
expiryMonth: string
Maximum Length:
2
Credit card expiration month. -
expiryYear: string
Maximum Length:
4
Credit card expiration year -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2
Nested Schema : items
Type:
Show Source
object
-
childPersonId: string
Maximum Length:
10
Person ID -
endDate: string
(date)
End Date indicates the relationship expires, indicate the date the relationship stops.Example:
1950-01-01
-
hasFinancialRelationship: boolean
Financial Relationship indicates if the child person is related to accounts which should be displayed in the parent person's hierarchy.Example:
false
-
personRelationshipType: object
personRelationshipType
-
startDate: string
(date)
Start Date indicates the date on which this relationship began.Example:
1950-01-01
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : personRelationshipType
Type:
Show Source
object
-
personRelationshipType: string
Maximum Length:
8
Relationship Type
Nested Schema : items
Type:
Show Source
object
-
address: object
address
-
effectiveStatus: string
Allowed Values:
[ "A ", "I " ]
Status of the address must be Active to be used. The status can be set to Inactive for the seasonal address to be ignored. * `A ` - Active, * `I ` - InactiveExample:Status: A - Active, I - Inactive
-
endMonthDay: string
Maximum Length:
4
End Month Day contains the day and month when the season ends.Example:1231
-
sequence: number
Minimum Value:
-999
Maximum Value:999
A sequence is used to define the order of the records. -
startMonthDay: string
Maximum Length:
4
Start Month Day contains the day and month when the season starts.Example:0201
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits.
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2 -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographical Code is used to apply proper taxation rules to the physical address location.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1-Person
Type:
Show Source
object
-
_self: string
_self
-
characteristics: object
characteristics
Configured additional attributes for any additional information that needs to be maintained for persons.
-
contactDetails: object
contactDetails
-
emailAddress: string
Maximum Length:
254
Email Address -
identifiers: object
identifiers
Identifiers are used for validating the identity of a customer based on their provided form of identification.
-
language: object
language
Language in which the person prefers their bills and correspondences.
-
lifeSupportSensitiveLoad: string
Allowed Values:
[ "N ", "Y " ]
Life Support / Sensitive Load indicates if the person has life support or sensitive load equipment. * `N ` - None, * `Y ` - LS/SLExample:N
-
lifeSupportSensitiveLoadDescription: string
Maximum Length:
1000
Life Support or Sensitive Load Description supports additional notes for life support information or equipment associated with the person. -
names: object
names
-
overrideMailingAddress: object
overrideMailingAddress
Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.
-
overrideMailingName1: string
Maximum Length:
254
Override Mailing Name for addressee on the person's correspondence and bills. -
overrideMailingName2: string
Maximum Length:
254
Override Mailing Name Line 2 for addressee on the person's correspondence and bills. -
overrideMailingName3: string
Maximum Length:
254
Override Mailing Name Line 3 for addressee on the person's correspondence and bills. -
paymentOptions: object
paymentOptions
-
personId: string
Maximum Length:
10
Person ID is a system-assigned random number that stays with a person for the life of the system.Example:5775933103
-
personOrBusiness: string
Allowed Values:
[ "B ", "P " ]
Defines the person entity as a person or business which controls validation of the person entity's primary name. * `B ` - Business, * `P ` - Person -
relationships: object
relationships
-
seasonalAddresses: object
seasonalAddresses
Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.
-
timeZone: object
timeZone
Defines the person's Time Zone preference if it is different from the system installation's time zone.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristics
Type:
object
Configured additional attributes for any additional information that needs to be maintained for persons.
Show Source
Nested Schema : identifiers
Type:
object
Identifiers are used for validating the identity of a customer based on their provided form of identification.
Show Source
Nested Schema : language
Type:
object
Language in which the person prefers their bills and correspondences.
Show Source
-
_link: string
_link
-
language: string
Maximum Length:
3
Language in which the person prefers their bills and correspondences.Example:ENG
Nested Schema : overrideMailingAddress
Type:
object
Override Mailing Address if the person wants their bills, letters, quotes, and statements sent to an address other than their service addresses. For example, a post office box. The address constituents may differ depending on the Country.
Show Source
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits.
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2 -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographical Code is used to apply proper taxation rules to the physical address location.
Nested Schema : seasonalAddresses
Type:
object
Seasonal Addresses are used if the person wants their correspondence sent to an alternate address during predefined seasonal periods.
Show Source
Nested Schema : timeZone
Type:
object
Defines the person's Time Zone preference if it is different from the system installation's time zone.
Show Source
-
_link: string
_link
-
timeZone: string
Maximum Length:
10
Defines the person's Time Zone preference if it is different from the system installation's time zone.
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective.
-
typeOfCharacteristicValue: string
Maximum Length:
4
Type of Char Value -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
contactDetailActiveInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - InactiveExample:Active/Inactive: C1AC - Active, C1IN - Inactive
-
contactDetailId: string
Maximum Length:
10
Person Contact -
contactDetailPrimary: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - YesExample:Primary: C1NO - No, C1YS - Yes
-
contactDetailStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
Contact Status indicates the option contact's status. The initial status can be defined from the Person Contact Type and manually maintained, or configured to be controlled by a process such as an Opt-In process. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected, * `ZZBN` - ZZBounced, * `ZZPE` - ZZPendingExample:Contact Status: C1AP - Approved, C1PN - Pending, C1RJ - Rejected
-
contactDetailValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as, the phone number or email address in the associated format.Example:krish11@yahoo.com, (415) 987-1298
-
contactDetailValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.) -
contactNickname: string
Maximum Length:
100
Contact Nickname can be assigned by self-service users. -
doNotDisturbEndDate: string
Do Not Disturb (To)
-
doNotDisturbStartDate: string
Do Not Disturb (From)
-
personContactType: object
personContactType
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : personContactType
Type:
Show Source
object
-
_link: string
_link
-
personContactType: string
Maximum Length:
30
Person Contact Type
Nested Schema : items
Type:
Show Source
object
-
idNumber: string
Maximum Length:
100
ID Number -
idType: object
idType
-
isPrimaryId: boolean
Primary ID switch is true if this is the primary means of identification for the customer.Example:
false
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : idType
Type:
Show Source
object
-
_link: string
_link
-
idType: string
Maximum Length:
8
ID Type indicates the type of identification and receives a default value from the Installation Record based on the Person Type.
Nested Schema : items
Type:
Show Source
object
-
isPrimaryName: boolean
Primary Name is defined as true if this is the primary name for the customer.Example:
true
-
nameType: string
Allowed Values:
[ "AL ", "ALT ", "DBA ", "FORM", "LGAL", "PRIM" ]
Name Type indicates if the name is an Alias, Alternate Representation, Doing Business As, Legal, or Primary name. Note, for new persons, a value of Primary is the default value. The values for the name type field are customizable using the applicable lookup table. * `AL ` - Alias, * `ALT ` - Alternate Representation, * `DBA ` - Doing Business As, * `FORM` - Former, * `LGAL` - Legal, * `PRIM` - PrimaryExample:PRIM (Primary)
-
personName: string
Maximum Length:
254
Person Name captures the person's name. The name is case-sensitive. -
sequence: number
Minimum Value:
-999
Maximum Value:999
A sequence is used to define the order of the records. -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : country
Type:
Show Source
object
-
_link: string
_link
-
country: string
Maximum Length:
3
Country
Nested Schema : items
Type:
Show Source
object
-
bankAccountInfo: object
bankAccountInfo
-
creditCardInfo: object
creditCardInfo
-
paymentType: string
Allowed Values:
[ "27 ", "28 ", "37 ", "38 ", "47 " ]
Payment type is a two-digit code that indicates the banking transaction as a debit or credit and type of financial account. * `27 ` - Checking Withdrawal, * `28 ` - Checking Debit Prenotification, * `37 ` - Savings Withdrawal, * `38 ` - Savings Debit Prenotification, * `47 ` - Credit Card WithdrawalExample:47 (Credit Card Withdrawal)
-
selfServicePaymentOptionId: string
Maximum Length:
12
Payment Option ID is a system-assigned random number for the record.
Nested Schema : bankAccountInfo
Type:
Show Source
object
-
accountNumber: string
Maximum Length:
50
The account number to be used for payment transactions.Example:1223428263
-
autoPaySource: string
Maximum Length:
12
Auto Pay Source -
routingNumber: string
Maximum Length:
30
The routing number identifies the bank or financial institution for payment transactions.
Nested Schema : creditCardInfo
Type:
Show Source
object
-
addressLine1: string
Maximum Length:
254
Address -
addressLine2: string
Maximum Length:
254
Address 2 -
addressLine3: string
Maximum Length:
254
Address 3 -
addressLine4: string
Maximum Length:
254
Address 4 -
cardHolderFirstName: string
Maximum Length:
50
Cardholder First Name -
cardHolderLastName: string
Maximum Length:
50
Credit card holder Last Name -
cardNumber: string
Maximum Length:
60
Number of the credit card. -
cardType: string
Allowed Values:
[ "C1AM", "C1DV", "C1MC", "C1VS" ]
Card type indicates the credit card processing network such as American Express, Discover, MasterCard, or Visa. * `C1AM` - American Express, * `C1DV` - Discover, * `C1MC` - MasterCard, * `C1VS` - VisaExample:C1AM
-
city: string
Maximum Length:
90
City -
county: string
Maximum Length:
90
County -
expiryMonth: string
Maximum Length:
2
Credit card expiration month. -
expiryYear: string
Maximum Length:
4
Credit card expiration year -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2
Nested Schema : items
Type:
Show Source
object
-
childPersonId: string
Maximum Length:
10
Person ID -
endDate: string
(date)
End Date indicates the relationship expires, indicate the date the relationship stops.Example:
1950-01-01
-
hasFinancialRelationship: boolean
Financial Relationship indicates if the child person is related to accounts which should be displayed in the parent person's hierarchy.Example:
false
-
personRelationshipType: object
personRelationshipType
-
startDate: string
(date)
Start Date indicates the date on which this relationship began.Example:
1950-01-01
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : personRelationshipType
Type:
Show Source
object
-
_link: string
_link
-
personRelationshipType: string
Maximum Length:
8
Relationship Type
Nested Schema : items
Type:
Show Source
object
-
address: object
address
-
effectiveStatus: string
Allowed Values:
[ "A ", "I " ]
Status of the address must be Active to be used. The status can be set to Inactive for the seasonal address to be ignored. * `A ` - Active, * `I ` - InactiveExample:Status: A - Active, I - Inactive
-
endMonthDay: string
Maximum Length:
4
End Month Day contains the day and month when the season ends.Example:1231
-
sequence: number
Minimum Value:
-999
Maximum Value:999
A sequence is used to define the order of the records. -
startMonthDay: string
Maximum Length:
4
Start Month Day contains the day and month when the season starts.Example:0201
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Address -
address2: string
Maximum Length:
254
Address 2 -
address3: string
Maximum Length:
254
Address 3 -
address4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: object
country
-
county: string
Maximum Length:
90
County -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
isInCityLimit: boolean
In City Limit indicates if the address is considered within the physical city limits. A value of true indicates within city limits.
-
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State -
streetNumber1: string
Maximum Length:
6
Number 1 -
streetNumber2: string
Maximum Length:
4
Number 2 -
taxVendorGeographicalCode: string
Maximum Length:
11
Geographical Code is used to apply proper taxation rules to the physical address location.
Nested Schema : country
Type:
Show Source
object
-
_link: string
_link
-
country: string
Maximum Length:
3
Country
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.