[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Sample CIQ for TC review
|
Greetings all As NZ Gov continues to adopt CIQ, we have an internal requirement
as shown below in this snippet from a specification. In due course we will parse it with our new flavour of the
month: STAX… But how does it seem to you? Cheers Colin …………………………………………………………………… 1.1
Customer Information
Wherever possible, [ciq-v3.0] will be used to specify customer
information. There are a number of elements that are common to several
Help Desk Web Service operations. 1.1.1 Root
element
The root element that contains any customer information
will be a <xpil:Party> element. 1.1.2 User
Identifier (Logon Name)
igovt logon service logon names will be represented as <xpil:Identifier>
elements. xpil:Identifier/@xpil:Type This attribute MUST have the value
‘LogonName’. xpil:Identifier/@ct:Status When present, this attribute represents the status of the
User in the igovt logon service. It can have the value
‘Active’, ‘Locked’, or ‘Suspended’. xpil:Identifier/xpil:IdentifierElement This element contains the igovt logon name xpil:Identifier/xpil:IdentifierElement/@xpil:Type This attribute MUST have the value
‘Identifier’. 1.1.3 Contact
Number
The User’s registered contact number (and registered
mobile number for TXT authentication, if the User has one) will be represented
as <xpil:ContactNumber> elements. xpil:ContactNumber/@xpil:Usage This mandatory attribute describes the usage of the
number. A value of ‘Contact’ means this is the User’s
registered contact number. A value of ‘TXT Authentication’
means this is the User’s registered mobile number for TXT
authentication. The igovt logon service only allows a single number for
each Usage value, i.e. one ‘Contact’ number and one ‘TXT
Authentication’ number. xpil:ContactNumber/xpil:ContactNumberElement/@xpil:Type=”CountryCode” xpil:ContactNumber/xpil:ContactNumberElement/@xpil:Type=”AreaCode” xpil:ContactNumber/xpil:ContactNumberElement/@xpil:Type=”LocalNumber” These three numbers MUST be used to represent phone
numbers. Other types are allowed by the xpil schema, but they will
not be recognised by the Help Desk Web Service. The three elements of a telephone number MUST NOT include
any prefix characters, and all three elements MUST be present. For
example, the Wellington number 04 555 6666, when used as the User’s
contact number, would be represented as:
1.1.4 Email
Address
The User’s email address will be represented as a <xpil:ElectronicAddressIdentifier>
element. /xpil:ElectronicAddressIdentifer/@xpil:Type This attribute MUST have a value of ‘EMAIL’. 1.1.5
Example of usage
The following xml fragment shows an example containing all
of the elements described above. Note that specific web service
operations expect or provide only some or one of these elements.
1.2
Sample Request
1.3
Sample Response
Cheers Colin Alternative email:
colin_wallis@hotmail.com CAUTION: This email message and any attachments contain information that may be confidential and may be LEGALLY PRIVILEGED. If you are not the intended recipient, any use, disclosure or copying of this message or attachments is strictly prohibited. If you have received this email message in error please notify us immediately and erase all copies of the message and attachments. Thank you. ==== |
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]