QueryGroup Response

The QueryGroup response is the response to the QueryGroup Request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
GroupBasic	Container	See GroupBasic Response Container for details.	Mandatory
Address	Container	See Address Response Container for details.	Optional

GroupBasic Response Container

The GroupBasic response container contains the following elements:

Element Name	Content Type	Description	Required?
GroupCode	String6	The CMP Group Code automatically generated to uniquely identify the Group.	Mandatory
GroupDescription	String30	A full description of the Group.	Mandatory
CompanyNumber	String3	The Company Name to which the Account is attached.	Mandatory
AddressNumber	Integer8	The Account level delivery address number which is used to identify one of the several delivery addresses available.	Mandatory
EmailAddress	String70	The email address set against the Group.	Optional
PostingAccountNumber	String20	Unique number to identify the posting account.	Mandatory
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

Address Request Container

The Address request container instructs the Address Service to update an Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. with an address. This request contains the following elements:

Element Name

Content Type

Description

Required?

AddressData

Container - Choice

Choice of:

PersonalAddress
BusinessAddress

Mandatory

Personal Address Errors

For Personal Addresses, if multiple mandatory fields are not supplied the following error (the details depend on the fields not supplied) is returned:

<Error>

<MessageId>MISSING_ADDRESS_FIELD</MessageId>

<MessageText>Please complete the Title,Middle Name,Surname,Address Line 1,Address Line 2,Address Line 3,

Address Line 4,Address Line 5,Postcode,Daytime Telephone,Evening Telephone,Fax Number,

Address Type,Address Category,Occupation,Id Number,Date Of Birth,Date Of Residence,

Gender field(s)</MessageText>

<ExtraInfo>Title,Middle Name,Surname,Address Line 1,Address Line 2,Address Line 3,

Address Line 4,Address Line 5,Postcode,Daytime Telephone,Evening Telephone,Fax Number,

Address Type,Address Category,Occupation,Id Number,Date Of Birth,Date Of Residence,

Gender</ExtraInfo>

</Error>

Business Address Errors

For Business Addresses, if multiple mandatory fields are not supplied the following error (the details of course depends on the fields not supplied, the complete list is shown here) is returned:

<Error>

<MessageId>MISSING_ADDRESS_FIELD</MessageId>

<MessageText>Please complete the Title,Forename,MiddleName,Surname,Address Line 1,Address Line 2,

Address Line 3,Address Line 4,Address Line 5,Postcode,Company Telephone,Contact Telephone,

Fax Number,Address Type,Address Category,Date Of Incorporation,Date Of Residence,Job Title,

Company Name,Company Registration,Industrial Classification field(s)</MessageText>

<ExtraInfo>Title,Forename,MiddleName,Surname,Address Line 1,Address Line 2,

Address Line 3,Address Line 4,Address Line 5,Postcode,Company Telephone,Contact Telephone,

Fax Number,Address Type,Address Category,Date Of Incorporation,Date Of Residence,Job Title,

Company Name,Company Registration,Industrial Classification </ExtraInfo

</Error>

PersonalAddress Request Container

The PersonalAddress request container has the following elements:

Element Name	Content Type	Description	Required?
Title	String10	The customer's appropriate title for example Mr, Mrs, Miss, Ms or Dr. This field is always mandatory but can be made optional via configuration if required.	Mandatory
Forename	String15	Customer's first name.	Optional
MiddleName	String10	Customer's middle name.	Optional
Surname	String25	Customer's surname.	Mandatory
Address1	String40	Line one of the customer's address.	Mandatory
Address2	String40	Line one of the customer's address.	Optional
Address3	String40	Line one of the customer's address.	Optional
Address4	String40	Line one of the customer's address.	Optional
Address5	String40	Line one of the customer's address.	Optional
Postcode	String10	Customer's post code. Must be entered without spaces.	Optional
DateOfBirth	Date	Customer's date of birth, in the format YYYY-MM-DD.	Optional
Gender	String	Choice of: Male, Female, Unknown or BLANK.	Optional
MaritalStatus	String	Choice of: Married, Single, Widowed, Divorced, Other, Separated or BLANK.	Optional
DateOfResidence	Date	The date from which the customer has lived at the address specified, in the format YYYY-MM-DD.	Optional
CustomerType	String10	Selected from one of the available Customer Types configured in CMP.	Optional
AddressType	String10	Identifies if the customer is a home owner, renting, living with parents, council tenant etc. Configurable CMP list.	Optional
AddressCategory	String10	Indicates property value. A category range relating to the address. Configurable CMP list.	Optional
Occupation	String10	The customer's current occupation. Configurable CMP list.	Optional
IDType	String10	The available type of ID used as proof of identity for example passport or driving license. Configurable CMP list.	Optional
IDNumber	String30	The unique ID from the proof of identity.	Optional
TelephoneNumber	String15	Customer's main contact telephone number.	Optional
EveningTelephoneNumber	String15	Customer's additional telephone number they can be reached on.	Optional
FaxNumber	String15	Customer's fax number.	Optional

CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. configuration controls which elements are mandatory and optional. Standard validation settings can be changed via CMP back office setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'P' for Personal Address.

BusinessAddress Request Container

The BusinessAddress request container has the following elements:

Element Name	Content Type	Description	Required?
CompanyName	String60	Name of company.	Mandatory
Address1	String40	Line one of the company's address.	Mandatory
Address2	String40	Line two of the company's address.	Optional
Address3	String40	Line three of the company's address.	Optional
Address4	String40	Line four of the company's address.	Optional
Address5	String40	Line five of the company's address.	Optional
Postcode	String10	Company's postcode. Must be entered without spaces.	Optional
CompanyTelephoneNumber	String15	Company's main contact telephone number.	Optional
ContactTelephoneNumber	String15	The individual's contact telephone number.	Optional
FaxNumber	String15	Company's fax number	Optional
CompanyType	String10	Indicates the type of company. Configurable CMP list.	Optional
AddressType	String10	Identifies the company's address. Configurable CMP list.	Optional
AddressCategory	String10	Indicates property value. A category range relating to the address can be configured. Configurable CMP list.	Optional
IndustrialClassificationCode	String10	Indicates the industry the company resides. Configurable CMP list.	Optional
CompanyRegistration	String25	Unique ID the company is registered to.	Optional
DateOfIncorporation	Date	The date the company register at the address specified in the format YYYY-MM-DD.	Optional
Title	String10	Company's contact title.	Optional
Forename	String15	Company's contact first name.	Optional
MiddleName	String10	Company's contact middle name.	Optional
Surname	String25	Company's contact surname name.	Optional
JobTitle	String30	Company's contact job title.	Optional

CMP configuration controls which elements are mandatory and optional. Standard validation settings can be changed via CMP back office setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'C' for Company Address.