1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. V-Model
  4. Person

Create Person

post

/rest/apis/customer/v-model/persons/

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : characteristics
Type: object
Configured additional attributes for any additional information that needs to be maintained for persons.
Show Source
Nested Schema : contactDetails
Type: object
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 correspondence printed. Note: The person's language defaults from Installation Options - Person.
Show Source
  • Maximum Length: 3
    Language in which the person prefers their bills and correspondence printed. Note: The person's language defaults from Installation Options - Person.
    Example: ENG
Nested Schema : names
Type: object
Show Source
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
Nested Schema : paymentOptions
Type: object
Show Source
Nested Schema : relationships
Type: object
Show Source
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
  • Maximum Length: 10
    Defines the person's Time Zone preference if it is different from the system installation's time zone.
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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` - Inactive
    Example: Active/Inactive: C1AC - Active, C1IN - Inactive
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
    Example: Primary: C1NO - No, C1YS - Yes
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
    Contact Status indicates the option contact's status. The initial status can be defaulted 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` - ZZPending
    Example: Contact Status: C1AP - Approved, C1PN - Pending, C1RJ - Rejected
  • 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
  • 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.)
  • Maximum Length: 100
    Contact Nickname can be assigned by self-service users.
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
  • personContactType
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : personContactType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : idType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Primary Name switch is true if this is the primary name for the customer.
    Example: true
  • 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 defaulted. The values for the name type field are customizable using the Lookup table. * `AL ` - Alias, * `ALT ` - Alternate Representation, * `DBA ` - Doing Business As, * `FORM` - Former, * `LGAL` - Legal, * `PRIM` - Primary
    Example: PRIM (Primary)
  • Maximum Length: 254
    Name
  • Minimum Value: -999
    Maximum Value: 999
    A sequence is used to define the order of the records.
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : country
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • bankAccountInfo
    For checking or savings payment option types, information contains the auto pay source and account number. The account number is masked if the system is configured to mask this information.
  • creditCardInfo
  • 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 Withdrawal
    Example: 47 (Credit Card Withdrawal)
Nested Schema : bankAccountInfo
Type: object
For checking or savings payment option types, information contains the auto pay source and account number. The account number is masked if the system is configured to mask this information.
Show Source
  • Maximum Length: 50
    The account number to be used for payment transactions.
    Example: 1223428263
  • Maximum Length: 12
    Code to reference the financial institution's transaction routing information in the system.
    Example: MASTERCARD
  • Maximum Length: 30
    The routing number identifies the bank or financial institution for payment transactions.
Nested Schema : creditCardInfo
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childPerson
Type: object
Show Source
Nested Schema : personRelationshipType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • address
  • 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 ` - Inactive
    Example: Status: A - Active, I - Inactive
  • Maximum Length: 4
    End Month Day contains the day and month when the season ends.
    Example: 1231
  • Minimum Value: -999
    Maximum Value: 999
    A sequence is used to define the order of the records.
  • Maximum Length: 4
    Start Month Day contains the day and month when the season starts.
    Example: 0201
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : address
Type: object
Show Source
Nested Schema : country
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : characteristics
Type: object
Configured additional attributes for any additional information that needs to be maintained for persons.
Show Source
Nested Schema : contactDetails
Type: object
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 correspondence printed. Note: The person's language defaults from Installation Options - Person.
Show Source
  • Maximum Length: 3
    Language in which the person prefers their bills and correspondence printed. Note: The person's language defaults from Installation Options - Person.
    Example: ENG
Nested Schema : names
Type: object
Show Source
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
Nested Schema : paymentOptions
Type: object
Show Source
Nested Schema : relationships
Type: object
Show Source
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
  • Maximum Length: 10
    Defines the person's Time Zone preference if it is different from the system installation's time zone.
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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` - Inactive
    Example: Active/Inactive: C1AC - Active, C1IN - Inactive
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
    Example: Primary: C1NO - No, C1YS - Yes
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
    Contact Status indicates the option contact's status. The initial status can be defaulted 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` - ZZPending
    Example: Contact Status: C1AP - Approved, C1PN - Pending, C1RJ - Rejected
  • 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
  • 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.)
  • Maximum Length: 100
    Contact Nickname can be assigned by self-service users.
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
  • personContactType
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : personContactType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : idType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Primary Name switch is true if this is the primary name for the customer.
    Example: true
  • 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 defaulted. The values for the name type field are customizable using the Lookup table. * `AL ` - Alias, * `ALT ` - Alternate Representation, * `DBA ` - Doing Business As, * `FORM` - Former, * `LGAL` - Legal, * `PRIM` - Primary
    Example: PRIM (Primary)
  • Maximum Length: 254
    Name
  • Minimum Value: -999
    Maximum Value: 999
    A sequence is used to define the order of the records.
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : country
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • bankAccountInfo
    For checking or savings payment option types, information contains the auto pay source and account number. The account number is masked if the system is configured to mask this information.
  • creditCardInfo
  • 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 Withdrawal
    Example: 47 (Credit Card Withdrawal)
Nested Schema : bankAccountInfo
Type: object
For checking or savings payment option types, information contains the auto pay source and account number. The account number is masked if the system is configured to mask this information.
Show Source
  • Maximum Length: 50
    The account number to be used for payment transactions.
    Example: 1223428263
  • Maximum Length: 12
    Code to reference the financial institution's transaction routing information in the system.
    Example: MASTERCARD
  • Maximum Length: 30
    The routing number identifies the bank or financial institution for payment transactions.
Nested Schema : creditCardInfo
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childPerson
Type: object
Show Source
Nested Schema : personRelationshipType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • address
  • 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 ` - Inactive
    Example: Status: A - Active, I - Inactive
  • Maximum Length: 4
    End Month Day contains the day and month when the season ends.
    Example: 1231
  • Minimum Value: -999
    Maximum Value: 999
    A sequence is used to define the order of the records.
  • Maximum Length: 4
    Start Month Day contains the day and month when the season starts.
    Example: 0201
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : address
Type: object
Show Source
Nested Schema : country
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : C1-Person
Type: object
Show Source
Nested Schema : characteristics
Type: object
Configured additional attributes for any additional information that needs to be maintained for persons.
Show Source
Nested Schema : contactDetails
Type: object
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 correspondence printed. Note: The person's language defaults from Installation Options - Person.
Show Source
  • _link
  • Maximum Length: 3
    Language in which the person prefers their bills and correspondence printed. Note: The person's language defaults from Installation Options - Person.
    Example: ENG
Nested Schema : names
Type: object
Show Source
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
Nested Schema : paymentOptions
Type: object
Show Source
Nested Schema : relationships
Type: object
Show Source
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
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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` - Inactive
    Example: Active/Inactive: C1AC - Active, C1IN - Inactive
  • Maximum Length: 10
    Person Contact
  • Allowed Values: [ "C1NO", "C1YS" ]
    Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
    Example: Primary: C1NO - No, C1YS - Yes
  • Allowed Values: [ "C1AP", "C1PN", "C1RJ", "ZZBN", "ZZPE" ]
    Contact Status indicates the option contact's status. The initial status can be defaulted 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` - ZZPending
    Example: Contact Status: C1AP - Approved, C1PN - Pending, C1RJ - Rejected
  • 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
  • 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.)
  • Maximum Length: 100
    Contact Nickname can be assigned by self-service users.
  • Do Not Disturb (To) indicates the end time when a person contact should not be used.
  • Do Not Disturb (From) indicates the start time when a person contact should not be used.
  • personContactType
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : personContactType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : idType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Primary Name switch is true if this is the primary name for the customer.
    Example: true
  • 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 defaulted. The values for the name type field are customizable using the Lookup table. * `AL ` - Alias, * `ALT ` - Alternate Representation, * `DBA ` - Doing Business As, * `FORM` - Former, * `LGAL` - Legal, * `PRIM` - Primary
    Example: PRIM (Primary)
  • Maximum Length: 254
    Name
  • Minimum Value: -999
    Maximum Value: 999
    A sequence is used to define the order of the records.
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : country
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • bankAccountInfo
    For checking or savings payment option types, information contains the auto pay source and account number. The account number is masked if the system is configured to mask this information.
  • creditCardInfo
  • 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 Withdrawal
    Example: 47 (Credit Card Withdrawal)
  • Maximum Length: 12
    Person Payment Option Id
Nested Schema : bankAccountInfo
Type: object
For checking or savings payment option types, information contains the auto pay source and account number. The account number is masked if the system is configured to mask this information.
Show Source
  • Maximum Length: 50
    The account number to be used for payment transactions.
    Example: 1223428263
  • Maximum Length: 12
    Code to reference the financial institution's transaction routing information in the system.
    Example: MASTERCARD
  • Maximum Length: 30
    The routing number identifies the bank or financial institution for payment transactions.
Nested Schema : creditCardInfo
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childPerson
Type: object
Show Source
Nested Schema : personRelationshipType
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • address
  • 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 ` - Inactive
    Example: Status: A - Active, I - Inactive
  • Maximum Length: 4
    End Month Day contains the day and month when the season ends.
    Example: 1231
  • Minimum Value: -999
    Maximum Value: 999
    A sequence is used to define the order of the records.
  • Maximum Length: 4
    Start Month Day contains the day and month when the season starts.
    Example: 0201
  • Minimum Value: -99999
    Maximum Value: 99999
    Version
Nested Schema : address
Type: object
Show Source
Nested Schema : country
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top