b2g interface specification inte… · web viewworld wide web consortium. wsdl ... and only...

UNCLASSIFIED

Personal Property Securities Register

B2G Interface Specification

Interface Version: 2016/05

Document State: For external useUpdate for R5a

PPSR B2G Interface Specification (R5a) of 529

UNCLASSIFIED

Table of ContentsVersion Change History..........................................................................................................................................51 Introduction....................................................................................................................................................9

1.1 Purpose..................................................................................................................................................91.2 Audience...............................................................................................................................................91.3 Scope.....................................................................................................................................................91.4 Acronyms..............................................................................................................................................91.5 Related Documents.............................................................................................................................10

2 Background..................................................................................................................................................112.1 The Business to Government Channel................................................................................................112.2 Key Concepts......................................................................................................................................12

2.2.1 Registrations..................................................................................................................................122.2.2 Registration Numbers, Tokens and Change Numbers...................................................................142.2.3 Secured Party Groups and Access Codes......................................................................................152.2.4 B2G Accounts................................................................................................................................182.2.5 The Address for Service.................................................................................................................192.2.6 The B2G Mailbox...........................................................................................................................202.2.7 User Defined Fields.......................................................................................................................202.2.8 Searching and Privacy...................................................................................................................212.2.9 Registration Kinds.........................................................................................................................212.2.10 Date and Time Handling...........................................................................................................212.2.11 PDF Files..................................................................................................................................23

3 Message Format...........................................................................................................................................243.1 SOAP over HTTPS.............................................................................................................................243.2 WSDL and XML Schema Files..........................................................................................................243.3 SOAP Faults........................................................................................................................................25

3.3.1 PpsrSoapFaultDetail.....................................................................................................................253.4 WS-Security........................................................................................................................................253.5 B2G Interface Versioning...................................................................................................................27

3.5.1 WSDL and XML Schema Versioning.............................................................................................273.5.2 Namespaces...................................................................................................................................273.5.3 Versioning Considerations............................................................................................................29

3.6 Endpoints............................................................................................................................................323.6.1 Production and Discovery Endpoints............................................................................................323.6.2 SOAP Version Endpoints...............................................................................................................323.6.3 MTOM Endpoints..........................................................................................................................333.6.4 B2G Interface Version...................................................................................................................34

3.7 Target Environment............................................................................................................................343.8 Request-Response Message Exchange...............................................................................................353.9 Common Message Fields....................................................................................................................36

3.9.1 Target Environment Request Message Header Field....................................................................363.9.2 Common Message Body Fields......................................................................................................37

3.10 Common SOAP Fault Contracts.........................................................................................................403.10.1 PpsrSoapFaultDetail................................................................................................................403.10.2 PpsrIncorrectEnvironmentFaultDetail.....................................................................................413.10.3 PpsrInvalidB2GRequestMessageFaultDetail...........................................................................423.10.4 PpsrUnauthorisedFaultDetail..................................................................................................433.10.5 PpsrStringLengthExceededFaultDetail....................................................................................433.10.6 PpsrInvalidDateTimeFormatFaultDetail.................................................................................44

3.11 Common Business Rules....................................................................................................................454 B2G Web Services.......................................................................................................................................49

4.1 B2G Web Services Overview.............................................................................................................494.2 Which Service Operations Do I Use?.................................................................................................51

4.2.1 Creating Things.............................................................................................................................524.2.2 Finding Things...............................................................................................................................544.2.3 Changing Things............................................................................................................................594.2.4 Producing Reports.........................................................................................................................70


UNCLASSIFIED

4.2.5 System Checks................................................................................................................................714.3 Collateral Registration Service...........................................................................................................72

4.3.1 Fault Contracts..............................................................................................................................734.3.2 Create Registrations......................................................................................................................744.3.3 Upload Registration Attachment.................................................................................................1064.3.4 Retrieve Registration...................................................................................................................1124.3.5 Retrieve Registration Attachment................................................................................................1304.3.6 Amend Registration......................................................................................................................1364.3.7 Discharge Registration................................................................................................................1634.3.8 Transfer Single Registration........................................................................................................1694.3.9 Transfer All Registrations............................................................................................................1764.3.10 Reset Registration Token........................................................................................................1844.3.11 Reissue Verification Statement................................................................................................1894.3.12 Transfer Multiple Registrations..............................................................................................195

4.4 Secured Party Group Service............................................................................................................2044.4.1 Fault Contracts............................................................................................................................2054.4.2 Create Secured Party Group.......................................................................................................2064.4.3 Retrieve Secured Party Group.....................................................................................................2204.4.4 Retrieve Secured Party Group History........................................................................................2284.4.5 Update Secured Party Group......................................................................................................2354.4.6 Reset Access Code.......................................................................................................................2574.4.7 Change Access Code....................................................................................................................261

4.5 Collateral Registration Search Service.............................................................................................2664.5.1 Important concepts......................................................................................................................2674.5.2 Fault Contracts............................................................................................................................2724.5.3 Common Search Classes..............................................................................................................2744.5.4 Search By Registration Number..................................................................................................2934.5.5 Search By Serial Number.............................................................................................................2984.5.6 Search By Grantor.......................................................................................................................3104.5.7 Search By Grantor And Event Date Range.................................................................................3254.5.8 Ordinal Search.............................................................................................................................3354.5.9 Retrieve Search Result.................................................................................................................3454.5.10 Retrieve Search Result Registration Attachment....................................................................3504.5.11 Retrieve Grantor Search Result Detail...................................................................................3564.5.12 Filter Grantor Search Result..................................................................................................3624.5.13 Filter Grantor And Event Date Range Search Result.............................................................3724.5.14 Retrieve Registration History Detail.......................................................................................3784.5.15 Request Search Certificate......................................................................................................3824.5.16 Retrieve Search Certificate.....................................................................................................3884.5.17 Retrieve Search Certificate Registration Attachment.............................................................3934.5.18 Request Search Certificates....................................................................................................396

4.6 Report Service...................................................................................................................................4034.6.1 Fault Contracts............................................................................................................................4044.6.2 Request Report.............................................................................................................................4064.6.3 Retrieve Report Summaries.........................................................................................................4114.6.4 Retrieve Report............................................................................................................................4184.6.5 DeleteReport................................................................................................................................423

4.7 B2G Mailbox Service........................................................................................................................4274.7.1 Fault Contracts............................................................................................................................4294.7.2 Retrieve Messages........................................................................................................................4304.7.3 Retrieve Message PDF................................................................................................................4394.7.4 Delete Messages..........................................................................................................................444

4.8 Register Operations Service..............................................................................................................4484.8.1 Ping..............................................................................................................................................4494.8.2 Change B2G Password................................................................................................................4524.8.3 Is Lax Supported..........................................................................................................................456

4.9 Alert Notification Service.................................................................................................................4584.9.1 Common Alert Notification Classes.............................................................................................4604.9.2 Create Alert Notification.............................................................................................................463


UNCLASSIFIED

4.9.3 Amend Alert Notification.............................................................................................................4714.9.4 Cancel Alert Notification.............................................................................................................4814.9.5 Retrieve Alert Notification...........................................................................................................4864.9.6 Retrieve Alert Notifications.........................................................................................................492

5 Reference Types.........................................................................................................................................4985.1 ChangeType......................................................................................................................................4985.2 CollateralClassFilterCriteriaType.....................................................................................................4995.3 CollateralClassSearchCriteriaType...................................................................................................5005.4 CollateralClassType..........................................................................................................................5025.5 CollateralType...................................................................................................................................5035.6 ExtendedBooleanType......................................................................................................................5045.7 GrantorType......................................................................................................................................5055.8 IdentifierVerificationStatusType......................................................................................................5055.9 NevdisVehicleIdentifierType............................................................................................................5065.10 NewRegistrationCollateralClassType...............................................................................................5065.11 NewRegistrationCollateralType........................................................................................................5085.12 NewRegistrationSerialNumberType.................................................................................................5085.13 OrdinalSearchResultType.................................................................................................................5105.14 OrganisationNumberType.................................................................................................................5115.15 RegistrationEventType......................................................................................................................5125.16 ReportFormatType............................................................................................................................5135.17 ReportRequestedChannelType..........................................................................................................5135.18 ReportStatusType..............................................................................................................................5145.19 SearchSelectionFlagType..................................................................................................................5145.20 SearchType........................................................................................................................................5155.21 SecuredPartyType.............................................................................................................................5155.22 SerialNumberSearchCriteriaType.....................................................................................................5165.23 SerialNumberType............................................................................................................................5185.24 SortOrderType..................................................................................................................................520

6 Allowable Characters for Grantor Names..................................................................................................521

FiguresFigure 1 - Lifecycle of a Registration....................................................................................................................14Figure 2 - Creation and Use of Registration Number, Token and Change Number..............................................15Figure 3 - Secured Party Groups............................................................................................................................15Figure 4 - Secured Party Groups and Registrations...............................................................................................16Figure 5 - Cannot Alter Composition of Secured Party Groups............................................................................17Figure 6 - Pre-Acquisition Situation of two separate entities each with their own Registrations..........................17Figure 7 - Post Acquisition situation with Registrations consolidated..................................................................18


UNCLASSIFIED

Version Change HistoryThis section of the document describes the changes introduced with each B2G interface version.

The PPSR currently supports three B2G interface versions:

Interface version 2011/04

Interface version 2015/02 (Introduced as part of R4)

Interface version 2016/05 (Introduced as part of R5a)

Release Interface version

Change type Description of change

R4 2015/02 New service

Alert Notification Service – This includes create, amend, retrieve and cancel alert notification operations.

R4 2015/02 New operation

Transfer Multiple Registrations operation – Ability to transfer more than one registration to another SPG using this service.

R4 2015/02 New element

Organisation verification status type field – Indicates verifications status when a call is sent out to ASIC/ABR.This element is included in -

RetrieveRegistrationResponseMessage SearchByGrantorSearchResult ChangeHistory class of Search Result Detail


Registrar Alert field – To advise that the registration is subjected to abnormal changes.This element is included in -

RetrieveRegistrationResponseMessage ChangeHistory class of Search Result Detail OrdinalSearchSearchResult

R4 2015/02

Changed property of an element

‘AccessToSearchResultExpiryTime’ element will not show Search result expiry date time while there is no fee charged for retrieving the search result after the search result access period has expired.This element is included in the Search Summary of CommonSearch Classes.

R42015/02 and 2011/04

New error number

New error number created for a locked B2G account customer location user

Error Number 40024 (Rule No. 3.11-240 Common Business Rules)


Element name – Is active (To identify whether the secured party group is active)


UNCLASSIFIED

Message that includes this element - RetrieveRegistrationResponseMessage


Organisation number verification date time field – Indicates when ASIC/ABR was contacted for verification. This element is included in the SearchByGrantorSearchResult of Common Search by Grantor classes SearchByGrantorSearchResult

R5a 2016/05 New operation

Request Search Certificates operation. This operation allows the request of multiple search certificates from a search, and to have them sent to an email address and/or have a notification sent to a B2G Mailbox when they are generated.

R5a 2016/05 New element

The BillingReferenceNumber element has been added to the CommonB2GMessageType class (in the Common Message Body Fields section).This element provides a mechanism to link chargeable transactions in PPSR to an identifier in the customer’s system.


The CCAddressDetail element has been added to the CommonRequestType class (in the Common Message Body Fields section).This element provides a mechanism to request copies of notifications to be sent to an email address and/or a B2G Mailbox)This new element has associated error numbers for validation errors (see Common Business Rules):

35010 (Rule No 3.11-250) 41106 (Rule No 3.11-260)


The PpsrResponseMessages element has been added to the CommonResponseType class (in the Common Message Body Fields section).This element provides a mechanism to receive warning or informational messages returned from PPSR.

R5a 2016/05 Changed element

The type of the AddressForService element has been changed in some messages to the AddressForServiceWithAdditionalNotificationAddresses class. This class allows specification of additional email and/or B2G Mailboxes to receive a copy of notifications sent to the Address for Service.The new class is used in

RetrieveSecuredPartyGroupResponseMessage UpdateSecuredPartyGroupRequestMessage


UNCLASSIFIED

This new class has associated error numbers for validation errors (see Update Secured Party Group Business Rules):

35300 (Rule No 4.4.5-480) 35301 (Rule No 4.4.5-490) 35302 (Rule No 4.4.5-500) 35018 (Rule No 4.4.5-510) 41106 (Rule No 4.4.5-520)

R5a AllError number updates

Some error numbers were corrected in the documentation (the error numbers returned through the interface have not changed, this is only correcting the documentation):

35002 → 67635003 → 67735004 → 67835006 → 67935019 → 69335020 → 69435021 → 69535040 → 71443026 → 925

R5a AllError number updates

Some error numbers were missing or not fully referenced in the documentation (no new error numbers are returned through the interface, this is only correcting the documentation):

35108 (Rule No 4.3.2-760) 35108 (Rule No 4.3.2-770) 35108 (Rule No 4.3.2-780) 35108 (Rule No 4.3.6-850) 33076 (Rule No 4.3.8-175, had a duplicate number of

4.3.8-160) 35127 (Rule No 4.3.8-180) 33076 (Rule No 4.3.9-135, had a duplicate number of

4.3.8-120) 35127 (Rule No 4.3.9-150) 1361 (Rule No 4.3.12-220) 35127 (Rule No 4.3.12-240) 41101 (Rule No 4.5.16-50)


UNCLASSIFIED

1 Introduction

1.1 Purpose

The purpose of this document is to describe the interfaces of the B2G web services, the requirements and specifications for establishing a B2G connection between business and government in relation to the PPSR.

This document describes the new interface introduced in 2016. The previous interfaces remain operational. Old interface specifications are available at ppsr.gov.au

1.2 Audience

The audience for this document is developers building and maintaining a B2G Client system design to interface with the PPSR.

Users of this document are assumed to have knowledge of the operation of Web Services using SOAP.

1.3 Scope

The scope of this document is limited to the following:

Defining the business requirements to use the B2G Interface

Defining interfaces to B2G web service methods

The B2G Interface specification does not cover the legislative or business background for the PPSR, nor does it provide recommendations about how the interface should be integrated into business operations

1.4 Acronyms

ABN Australian Business Number

ACN Australian Company Number

ARBN Australian Registered Business Number

ARSN Australian Registered Scheme Number

B2G Business To Government

CSV Comma Separated Values

PPSR Personal Property Securities Register

MTOM SOAP Message Transmission Optimisation Mechanism

SOAP Simple Object Access Protocol


UNCLASSIFIED

SSL Secure Socket Layer

W3C World Wide Web Consortium

WSDL Web Services Definition Language

XML eXtensible Markup Language

XSD XML Schema Definition

1.5 Related Documents

Users of this document may also need to read:

B2G Mailbox Notifications (for retrieving notifications through the B2G mailbox)

Reports Technical Specification (for requesting and retrieving predefined reports through the B2G Interface)


UNCLASSIFIED

2 BackgroundThe (original) B2G interface was developed from 2011 in order to support the introduction of the PPSR on 30 January 2012. That development included extensive consultation with stakeholders to ensure the smooth commencement of the register

Until 2015 this interface has remained largely unchanged. Over this time there have been a number of requests to provide additional functionality within the B2G interface.

To cover these extra functions (and to enhance some of the existing functionality), a new version of the interface has been developed. The new functionality is:

Alert Notifications – providing a mechanism for receiving alerts through the B2G interface when registrations are made against an organisation with an ASIC identifier (ACN, ARBN, ARSN) Transfer Multiple Registrations – providing a mechanism to transfer a set of registrations to a new secured party, and only generating a single verification statement.

The existing interface will remain operational alongside the new interface. The only need to use the new interface is to incorporate the new functionality within the B2G client system.

2.1 The Business to Government Channel

The B2G Channel operates on the premise that a client will provide their own internal software and resources dedicated to performing their required functions and that the completion of these functions either provides for or relies on registrations and information contained in the PPSR.

The PPSR is offering a means by which these customers can connect to the PPSR Register called the B2G (Business to Government) Channel.

The B2G Channel is a hosted service of the PPSR that enables B2G authorised clients to transact with the PPSR through a dedicated channel over the internet in an automated fashion. This service allows for the seamless integration between the B2G client’s workflow and business systems and the functionality of the PPSR. Modification of a client’s existing systems or development of new systems may be required to accomplish this outcome.

Users of the B2G channel send and receive PPS registration data and receive third party data (such as NEVDIS data) free of the context that is provided over the web interface. This includes notifications of terms, disclaimers and explanatory notes about data.

Access to and use of data provided through the PPSR is subject to the PPSR General Conditions Of Use and applicable third party data conditions (which can be obtained at www.ppsr.gov.au). To the extent permitted by law, all data provided through the PPSR is made available without any representation or warranty of any kind (without limitation in respect to accuracy) and the Commonwealth, and our third party data providers (which includes any person mentioned in the Third Party Data Conditions as providing information through the PPSR), have no liability to you in respect of any loss or damage that you might


UNCLASSIFIED

suffer no matter how arising (including negligence) that is directly or indirectly related to the NEVDIS Data.

B2G users should also familiarise themselves with the presentation of registration data and third party data as it appears on verification statements and search certificates from time to time to ensure that they understand the limits on the data provided. For example, a NEVDIS stolen vehicle summary provided over the B2G channel does not disclose:

that Tasmanian stolen vehicle information is currently unavailable from NEVDIS and the alternative that is available.

the disclaimer above

that a stolen vehicle notification, or the absence of one, does not necessarily mean a vehicle is or is not stolen, or

how to interpret a stolen vehicle notification to enable a user to contact the relevant police authority in the most efficient way.

2.2 Key Concepts

There are a number of key concepts that are an important aid in understanding this document. These include an understanding of:

Registrations

Registration Numbers, Tokens and Change Numbers

Secured Party Groups and Access Codes

B2G Accounts

The Address for Service

The B2G Mailbox

User Defined Fields

Searching and Privacy

Date / Time Handling

PDF Files

2.2.1 Registrations

A Registration has the following:

A description of the collateral that is registered. Each registration describes the collateral by the class of collateral (eg motor vehicle, watercraft, intangible, financial. Depending on the class of collateral, there may be other attributes used to describe the collateral, such as a serial number (eg motor vehicle VIN) or a free text description.

Note: The PPS Regulations define the collateral classes that can be used to describe collateral. The Regulations also allow for some collateral classes to be further described and the concept of “subclass” is used in PPSR. For example, the class of Agriculture can be further described as being either of the subclass Crops or the subclass Livestock. Further details of the use of subclasses and the class hierarchy are


UNCLASSIFIED

provided in sections 2.5, 3.1 and 4.1 of the document “PPSR - 6.4.3.1 - Describing Collateral”. In the B2G Interface Specification, the use of the term “class” is used to refer to either a class as defined in the Regulations or a subclass as defined in the document “PPSR - 6.4.3.1 - Describing Collateral”.

The type of collateral being registered. Registrations are either for commercial property or consumer property, based on the use of the property.

The secured party (or secured parties) that have the security interest in the collateral (eg a bank that is lending money using the collateral as security).

Note: The PPS Regulations define how secured parties must be identified in PPSR. Further details of how secured parties need to be identified are provided in section 4.3.2.1 of the document “PPSR - 6.4.3.1 - Describing Secured Parties”.

The grantor (or grantors) that have granted the security interest in the collateral. This is often, but not always, the debtor. For some registrations there will not be any grantor recorded – this is based on factors such as the type of collateral. For example, a consumer registration that is described by a serial number cannot have a grantor defined.

Note: The PPS Regulations define how grantors must be identified in PPSR. Further details of how grantors need to be identified are provided in section 3 of the document “PPSR - 6.4.3.1 - Describing Grantors”.

The kind of registration. The primary purpose of the PPSR is to allow for registration of collateral that is subject to a security interest. However, existing registers that are replaced by PPSR (such as state-based registers of encumbered vehicles) allow for additional interests in collateral to be registered. For example, police forces registering hoon liens. The majority of registrations in PPSR will be for security interests, however PPSR will also allow for registration of other kinds of interest.

The period during which the registration is in effect – the Start Time and the End Time for the registration.

Other attributes that describe either the collateral or the registration itself. There are a number of Boolean attributes that indicate things such as whether the collateral is inventory, whether assets are subject to control, whether the security interest is a purchase money security interest. Some classes of collateral allow a free text description to be added. Some collateral classes also allow a file (eg a PDF document) to be uploaded and attached to the registration.

As described, some combination of the above information is required at time of registration. Once a registration is created, it can be amended or discharged. A registration will expire when the End Time is before the current time. See Figure 1


UNCLASSIFIED

Figure 1 - Lifecycle of a Registration

Only certain aspects of a registration can be amended. For all other fields, a new registration reflecting the new situation needs to be created and the old registration discharged. An amended Registration will be in effect from the time the changes are recorded on the PPSR system.

A history of all changes made to a registration is kept and can be viewed when required. This also makes it possible to view a Registration as it was at a particular point in time.

When a registration is first made and whenever the registration is amended or discharged, a Verification Statement will be sent to the secured parties.

2.2.2 Registration Numbers, Tokens and Change Numbers

Registrations are the key type of record on the Register. Each Registration when created is assigned a unique Registration Number to identify it. Each time a change is made to a Registration, including Creation, Amend and Discharge, a unique Change Number is created. Expire does not cause a change number to be generated.

The combination of Registration Number and Change Number will identify a Registration record for an item of property at a particular point in time, according to the Register.

Each Registration is issued with a Registration Token (or Token). A Token is used to authorise a user to Amend or Discharge a Registration. See Figure 2. A record of the Token should be kept safe and made available only to personnel authorised to Amend or Discharge a Registration. There is only one Token per Registration. If a Token is lost or compromised a new Token can be requested.


UNCLASSIFIED

Figure 2 - Creation and Use of Registration Number, Token and Change Number

2.2.3 Secured Party Groups and Access Codes

A secured party is an individual or organisation that holds a security interest. A secured party uses the PPSR to register a registration.

A secured party group consists of one or more secured parties (either individuals or organisations as shown in Figure 3). A secured party can be in more than one Secured Party Group however it is separately defined within each group. It will not be possible to say "what groups is this secured party in."

Figure 3 - Secured Party Groups

It is the secured party group that is associated with a registration, even if the secured party group comprises only one secured party. See figure 4.


UNCLASSIFIED

Figure 4 - Secured Party Groups and Registrations

Each Secured Party Group is allocated a unique Secured Party Group Number, used to identify the Secured Party Group. The Secured Party Group needs to exist prior to using it in a Registration. It is necessary to know the Secured Party Group Number for the Secured Party Group in order to create a registration for that Secured Party Group.

Each Secured Party Group has an ‘Address for Service.’ This is the address to which PPSR will send notices. When sending a notice to the Secured Parties, PPSR will send one notice to the ‘Address for Service’ rather than a separate notice to each Secured Party.

A search for Registrations will reveal the names and identifying numbers (eg ACN, ARSN, ARBN, ABN) of the Secured Parties recorded on Registrations returned in the search result, and also show the Address for Service of the Secured Party Group, but will not reveal address or contact details of the Secured Parties or other details of the Secured Party Group. Secured Party Group Numbers are not disclosed by a search for Registrations. Note that there is no facility to search PPSR for Secured Parties or for the Registrations made by particular Secured Parties.

Changes will not be allowed to the Secured Parties in a Secured Party Group once it has been formed. That is it is not possible to either add or delete a Secured Party from a Secured Party Group. See Figure 5. It will be necessary to create a new Secured Party Group. It will be possible to change the address and contact details of the Secured Parties or the ‘Address for Service’ of the Secured Party Group.


UNCLASSIFIED

Figure 5 - Cannot Alter Composition of Secured Party Groups

If the Secured Party is an organisation and has supplied an ACN, ARBN or an ARSN the number will be attempted to be verified with ASIC, or if an ABN was supplied it will be attempted to be verified with the ABR. The name returned from ASIC or ABR will be included on Verification Statements and will be the name stored in the Name field of the Secured Party. If for any reason the verification attempt was not successful, the supplied information will be recorded. If a collateral record that is associated with a particular Secured Party Group is changed (ie a new change number generated) or a search certificate for it is requested and there remains Secured Party details that are not verified, a further attempt to verify the Secured Party details will be made. If an organisation legally changes it name, an ability to ‘Reverify’ the Secured Party Group on the PPSR system can be done to reflect these changes. Any updated details retrieved from these external registers will be used to update the Secured Party Group record in the PPSR and will be used from then on.

If a Secured Party Group wishes to transfer some or all of its registrations to another Secured Party Group it can be done. The need to use this capability would most likely arise in a merger, acquisition, de-merger or company restructure situation. The following scenario displayed in Figure 6 and 7, of Company D acquiring Company A and becoming the Secured Party to Company A’s Registrations is illustrative of this function.

Figure 6 - Pre-Acquisition Situation of two separate entities each with their own Registrations

Company D acquires Company A and transfers the Registrations ABC and DEF from Secured Party Group 1 to Secured Party Group 4. No other details change on the transferred registrations.

When registrations are transferred between Secured Party Groups, an amendment is made to every registration that is transferred. Only one Verification Statement is produced covering all the transferred registrations, but the Verification Statement is sent to both the old and the new Secured Party Groups.


UNCLASSIFIED

Figure 7 - Post Acquisition situation with Registrations consolidated

Each Secured Party Group is issued with an Access Code. The Secured Party Group Number and Access Code is used to authorise the transfer of a Secured Party Group’s Registrations and changes to the address details within a Secured Party Group. The Secured Party Group Number and Access Code is also an alternative authorisation mechanism for a registration linked to the Secured Party Group. Supplying this combination instead of a Registration Token, will authorise a user to Amend or Discharge a Registration.

The National Service Centre (NSC) can Deactivate a Secured Party Group that does not have any active registrations. An inactive Secured Party Group cannot be have registrations assigned to it (through either create or transfer)

2.2.4 B2G Accounts

Every organisation that will use the B2G Channel must first be established in PPSR as an Account Customer. This allows the Account Customer to use the Web Channel of PPSR. In order to use the B2G Channel, the Account Customer must apply to the Registrar for access to the B2G Channel. Once access is approved, the Account Customer record in PPSR will be updated to allow access to the B2G Channel. The Account Customer will now have access to both the Web and B2G Channels. There is no need for separate Account Customers for access to each channel.

In order to use the Web Channel, the Account Customer must define a User for each individual person that will access the Web Channel. Each user is issued with a user name and password for access to the Web Channel. Initially at the creation of the Account Customer in PPSR, only a User for an Account Customer administrator needs to be defined. If the Account Customer does not intend to use the Web Channel, but only use the B2G Channel, the Account Customer does not need to define any User other than the Account Customer administrator. The term B2G Account Customer refers to an Account Customer that uses the B2G Channel, whether or not they choose to use the Web Channel.

The user names and passwords issued for access to the Web Channel cannot be used to access the B2G Channel. PPSR does not authenticate or authorise access to the B2G Channel by individual users in the Account Customer. PPSR only authenticates and authorises access to the B2G Channel for the Account Customer as a whole. If the Account Customer wants to control access to PPSR through the B2G Channel by individual users of their system, this access control must be provided within the Account Customer’s system. The Account


UNCLASSIFIED

Customer does not need to setup individual Users within PPSR for access to the B2G Channel by individual persons in the Account Customer.

The PPSR services provided by the B2G Channel and defined in the B2G Interface Specification are designed to be usable by both external customers of PPSR and internal organisations responsible for the management and operation of the Register. Some of the functionality provided by the B2G Channel may not be for use by external customers. Where there is functionality that may not be for use by external customers, this has been noted in the specification as for use by authorised Account Customers.

Larger organisations using the B2G Channel may have more than one site from which their systems will need to interact with the PPSR. In order to meet PPSR security requirements and make the organisation’s systems manageable, the concept of ‘locations’ for a B2G Account Customer has been implemented. A ‘location’ is defined as a single contiguous IP Address Range. For a single B2G Account Customer there can be multiple locations defined. Each location can have multiple ‘location users established, each with a user name and password. These ‘location users’ are not the same as Users that access the Web Channel, but are credentials used by PPSR to authenticate access by the B2G Account Customer’s systems. Each B2G request sent from a location will have its user name, password and IP Address checked before the request can be processed.

For example, a B2G Account Customer can use separate ‘locations’ for separate physical data centres, or systems within a data centre. Where the B2G Account Customer has separate systems within a location that will access PPSR, they can define separate ‘location users’ for each system, allowing each separate system to independently manage its own password (e.g. the password used by each system to access PPSR can be changed for each system independently).

B2G Account Customers do not configure the locations and location users within PPSR themselves. The locations and location users that a B2G Account Customer requires need to be advised to the Registrar, who will arrange for the necessary configuration to be defined in PPSR. The initial password for each location user will be provided to the B2G Account Customer, who will need to configure this password in their system and use the Change B2G Password operation of the B2G Channel to set a password defined by the B2G Account Customer. B2G Account will be locked after 5 failed password attempts. The location user password must be changed periodically (at least every 90 days).

There are two checks performed by PPSR for each B2G request sent from a B2G Account Customer. One check is whether the B2G Account Customer’s access has been deactivated, either at the level of the whole Account Customer, or just at an individual location or location user level. If this is true you cannot transact using this account, location or location user. The second check is ‘Is Account Charging Suspended’. If this is true transactions that attract a charge would not be possible using the B2G Channel. Transactions can still be conducted via the web on a pay-as-you-go basis, whilst this condition is true.

2.2.5 The Address for Service

The Address for Service is the nominated address to which all registration notifications for Secured Parties are sent. In PPSR the address for service is associated with the Secured Party Group and can be subsequently updated. When the Address for Service is updated, an


UNCLASSIFIED

amendment is made to every registration that is affected. Only one Verification Statement is produced covering all the registrations, but the Verification Statement is sent to both the old and the new Address for Service.

All notifications must be sent to one of: an email address, fax number or postal mail address.

One of the options for the Address for Service of a Secured Party Group is to choose a B2G address. This is done by specifying the B2G Account Customer Number as well as an email address. If this option is chosen, both the Address for Service and the email address are sent Verification Statements, along with the Secured Party Group’s notifications being placed in a B2G Mailbox as an added convenience.

Part of the address for service is three (optional) additional addresses that provide the ability to send copies of notifications sent to the Address for Service to email and/or B2G Mailbox.

2.2.6 The B2G Mailbox

The B2G mailbox is a facility that is available to the B2G Account Customer. Messages in the B2G Mailbox must be retrieved by the B2G Customer. Management of the B2G Mailbox content is the responsibility of the B2G Account Customer. Management of these messages within a B2G Customer’s workflow should be included in the functionality of the customer’s own software.

As discussed above, if the Address for Service of a particular Secured Party Group is the B2G Address, notifications will be sent via email and to the B2G Mailbox. If this is the case, notifications and other information relating to the Secured Party Group’s registrations will be available in the B2G Mailbox.

If the B2G Account Customer Address is the Address for Service the following information will be available in the B2G Mailbox:

Verification Statements for New and Altered Registrations

Registration Tokens

Secured Party Group Access Code

Further, the types of messages that will be in the B2G Mailbox as a result of being a B2G customer include:

System Messages and Notices from the Registrar’s Office

Optional types of messages can be requested to be received in the B2G mailbox:

Alert Notifications when a Registration is made against a nominated Grantor (that must be identified by an ASIC issued number)

2.2.7 User Defined Fields

Up to five (5) user defined fields can be included in each call to a PPSR B2G service. These fields can be used by the B2G Customer to assist in tracking and managing interactions with the PPSR. The values in these fields will be recorded against transaction records in PPSR and can be used in reports provided by PPSR. These fields have no bearing on the


UNCLASSIFIED

transaction itself within PPSR. They are provided for the convenience of the B2G Customer. These fields can be your organisational unit codes, user codes or account cost codes. These fields are optional and will have no checking done on them.

The PPSR will include the same information in the response message generated as a result of the request message.

2.2.8 Searching and Privacy

The PPSR is a public Register that contains information about individuals. Minimal details about individuals are held on the PPSR and only collected where necessary. For example, registrations for consumer collateral items described by serial numbers do not contain any grantor details.

PPSR search functions ensure that only individual details provided as part of the search criteria are returned with the search results. Search is an exact match and for individuals this is on both name and date of birth.

This will require names to be recorded accurately as prescribed in the regulations.

2.2.9 Registration Kinds

The primary purpose of the PPSR is to allow for registration of collateral that is subject to a security interest. However, existing registers that are replaced by PPSR (such as state-based registers of encumbered vehicles) allow for additional interests in collateral to be registered. For example, police forces registering hoon liens. The majority of registrations in PPSR will be for security interests, however PPSR will also allow for registration of other kinds of interest.

Every PPSR Account Customer will be assigned one Registration Kind. By default this will be Security Interest. However, an Account Customer can apply to the Registrar to have the Registration Kind assigned to their Customer Account changed.

Whenever a new Registration is created by an Account Customer, the Registration Kind of the Registration will be the Registration Kind assigned to the Account Customer.

If an organisation needs to be able to create registrations for more than one Registration Kind, they will need to establish a separate Account for each Registration Kind.

2.2.10 Date and Time Handling

2.2.10.1 Overview

The date and time of events relating to registrations in PPSR are critical elements of the Register. Of specific importance are the following:

Start Time of a registration

End Time of a registration

Time of changes to a registration


UNCLASSIFIED

Being able to determine the order of registrations being made and changes to registrations is an important part of determining the relative priority of security interests in collateral. In addition, to the essential dates/times relating to registrations mentioned above, the date and times of all changes to PPSR data will be stored.

2.2.10.2 PPSR Time Precision

For PPSR there is greater importance in determining the relative order of changes to registrations being made and changes to registrations than the absolute precision with which the times are recorded. The unique Change Number assigned to Registration records when they are created and when they are changed is used in PPSR to determine relative order and this takes precedence over the absolute time recorded in the PPSR database.

2.2.10.3 PPSR Time Zone

PPSR operates on Canberra time. All dates and times provided to PPSR, stored in PPSR, and retrieved from PPSR will be the local time in Canberra.

2.2.10.4 Daylight Saving Transitions

On the day that daylight saving ends, the hour between 2 AM and 3 AM occurs twice.

The PPSR will be unavailable during the period when daylight saving ends. This is to ensure that the time sensitive nature of the Register is maintained.

2.2.10.5 Date/Time Values with the B2G Channel

Date and Time values will be provided in B2G web service messages using the primitive xs:dateTime datatype defined in the W3C specification of XML Schema (http://www.w3.org/TR/xmlschema-2/).

The xs:dateTime datatype will be used in all circumstances when either just a date or both a date and time of day are relevant. PPSR will send and receive only xs:dateTime values in B2G web service messages; the date-only xs:date datatype will not be used. For the Registration’s End Time specification the time provided should be 23:59:59. If it is not, it will not generate an error. The message will still be accepted and the time will be changed to 23:59:59.

The format of dateTime values in B2G web service messages will include the time down to whole seconds and will not include time zone information. The date/time specified will be Canberra time.

For example, where the value is 06:47:34 pm on 9 January 2014 Canberra time, the value in the B2G message will be:

2014-01-09T18:47:34

Date and date/time values passed in to B2G web services will be checked to ensure they do not contain greater precision than required (ie no milliseconds) and to ensure they do not contain UTC or offset details.


http://www.w3.org/TR/xmlschema-2/

UNCLASSIFIED

2.2.11 PDF Files

The register stores generated documents in PDF format. This includes:

Search Certificates

Verification Statements

Notifications

These documents are initially stored in high speed storage, but over time they will be transitioned to lower speed then finally offline storage.

An attempt to retrieve a document that is in offline storage will return error 1702:

This file has been archived and cannot be retrieved at this time. If you wish to have this file restored please contact the National Service Centre on 1300 007 777 and provide the following information: Location: XXXX; File Name: YYYY

The NSC can be contacted and the file restored to high speed storage and then it can be directly accessed.

In some instances the document may be deleted, in which case the error will be 1701:

This file has been removed and cannot be retrieved.


UNCLASSIFIED

3 Message FormatThis section describes implementation details that apply to every service and service operation and their use within all B2G web service operations. These common elements apply for every service and service operation.

All B2G web services will be found at: https://b2g.ppsr.gov.au. A “discovery” environment is available to enable customers to develop and test their software against the current version of the PPSR web services. The discovery environment is at: https://b2g-disc.ppsr.gov.au. Other environments may be provided for specific usage from time to time.

3.1 SOAP over HTTPS

PPSR B2G Channel uses the Simple Object Access Protocol (SOAP). Both SOAP 1.1 and SOAP 1.2 are supported.

Services that may involve sending or receiving files can use SOAP Message Transmission Optimization Mechanism (MTOM).

The SOAP HTTP Binding is used. SSL is used to provide transport layer encryption of messages. Note that client certificates are not used for authentication.

Web Service Description Language (WSDL) is used to define the web service contracts and can be used by many development tools to generate code for connecting to and invoking the web services.

All messages sent to and received from PPSR will need to comply with the WSDL.

3.2 WSDL and XML Schema Files

Customers wishing to use the B2G web services will be provided with a Web Service Description Language (WSDL) file and associated XML schema (XSD) files that describe the B2G web services.

In addition to the XSD files provided with the WSDL file, two additional XSD files are used with the B2G web services:

XSD for Notifications. The schema definitions for the notification types that are provided in messages in the B2G Mailbox. See the “B2G Mailbox Notifications” document for further information.


UNCLASSIFIED

XSD for Reports. The schema definitions for the reports that are provided by PPSR. This includes the schema for report criteria used to request reports and the schema for report output. See the “Reports Technical Specification” document for further information.

3.3 SOAP Faults

All errors in PPSR web services are reported using SOAP faults.

When an error occurs as a result of an internal PPSR system problem the fault code provided in the SOAP fault will be Server (SOAP 1.1) or Receiver (SOAP 1.2). Account customer software can resend the same request at a later time.

When business rule checks are being performed on an incoming message any non-compliance with the business rules will be reported with a fault code of Client (SOAP 1.1) or Sender (SOAP 1.2). Account customer software should not attempt to resend the same message.

PPSR will provide additional information related to the SOAP fault in the detail element of the SOAP fault. For Client/Sender faults, PPSR will provide details of the specific business rule check that was violated in the detail element.

3.3.1 PpsrSoapFaultDetail

The base class for the content of the SOAP fault detail element is PpsrSoapFaultDetail. See section 3.10.1 PpsrSoapFaultDetail for more information about PpsrSoapFaultDetail.

PpsrSoapFaultDetail will be the type used for the detail element when the fault code is Server/Receiver.

The PpsrSoapFaultDetail may be extended to provide additional details when the fault code is Client/Sender.

Note that PpsrSoapFaultDetail is not used for WS-Security SOAP faults (see below).

3.4 WS-Security

WS-Security is used for authentication of B2G customers. The username and password for a B2G customer location user must be provided in the appropriate SOAP header. The username is assigned by PPSR. An initial password will be assigned by PPSR and must be changed by the account customer using the Change B2G Password operation of the Register Operations web service before calling any other operations.


UNCLASSIFIED

The username and password must be provided as a UserNameToken in a WS-Security SOAP header. For example:

<soap:Header xmlns:soap="http://www.w3.org/2003/05/soap-envelope”><wsse:Security soap:mustUnderstand="true" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-

wssecurity-secext-1.0.xsd"><wsse:UsernameToken wsu:Id="UsernameToken-2" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-

200401-wss-wssecurity-utility-1.0.xsd"><wsse:Username>username</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-

1.0#PasswordText">password</wsse:Password><wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-

security-1.0#Base64Binary">rxjVyr3hRuHm1cKkkQ1MAg==</wsse:Nonce><wsu:Created>2009-11-02T10:22:42.866Z</wsu:Created>

</wsse:UsernameToken></wsse:Security>

</soap:Header>

If the WS-Security header is not provided, a SOAP fault will be returned with a WS-Security fault code of InvalidSecurity.

If either the username or password is invalid, a SOAP fault will be returned with a WS-Security fault code of FailedAuthentication.

Note that for SOAP 1.2, the WS-Security fault codes are provided as a Subcode and the fault Code will be Sender.

Example FailedAuthentication WS-Security SOAP fault for SOAP 1.1:

<soap:Body xmlns:soap="http://www.w3.org/2003/05/soap-envelope”><soap:Fault>

<faultcode xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">wsse:FailedAuthentication</faultcode>

<faultstring xml:lang="en-US">At least one security token in the message could not be validated.</faultstring>

</soap:Fault></soap:Body>

Example FailedAuthentication WS-Security SOAP fault for SOAP 1.2:

<soap:Body xmlns:soap="http://www.w3.org/2003/05/soap-envelope”><soap:Fault>


UNCLASSIFIED

<soap:Code><soap:Value>soap:Sender</soap:Value><soap:Subcode>

<soap:Value xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">wsse:FailedAuthentication</soap:Value>

</soap:Subcode></soap:Code><soap:Reason>

<soap:Text xml:lang="en-US">At least one security token in the message could not be validated.</soap:Text>

</soap:Reason></soap:Fault>

</soap:Body>

3.5 B2G Interface Versioning

3.5.1 WSDL and XML Schema Versioning

In order to allow for changes to be made to the PPSR B2G Interface without requiring all B2G Account Customers to implement updates to their own systems at exactly the same time, PPSR will continue to support an existing version of the B2G Interface for a period of time after the introduction of a new version.

There is a possibility that PPSR may need to introduce a new version for which it will not be possible to support any previous versions once the new version is introduced. In this case, sufficient lead time will be required to allow all B2G Account Customers to update and test their systems prior to the implementation of the new version.

3.5.2 Namespaces

PPSR uses the following namespaces:

http://schemas.ppsr.gov.au/yyyy/mm/services

http://schemas.ppsr.gov.au/yyyy/mm/data

http://schemas.ppsr.gov.au/notifications


UNCLASSIFIED

http://schemas.ppsr.gov.au/reports

http://schemas.ppsr.gov.au/faults

Some of the namespaces include version information, represented as “yyyy/mm” in the path, where yyyy and mm are the year and month of the version of the B2G Interface in which the version of the namespace is introduced. If there is a need to release more than one version of the B2G Interface within a month, the day of the month will be added for versions after the first in the month (e.g. http://schemas.ppsr.gov.au/yyyy/mm/dd/services).

3.5.2.1 http://schemas.ppsr.gov.au/yyyy/mm/services

This namespace is used for the definition of all services and operations.

Whenever a new version of the B2G Interface is implemented, all existing services and operations will be included in the new version of the namespace, even if there is no change to some of the services and operations.

A new version of the WSDL will only ever refer to the new version of this namespace.

3.5.2.2 http://schemas.ppsr.gov.au/yyyy/mm/data

This namespace is used for the definition of all data elements that make up the messages for the service operations, with the exception of notifications and faults.

Whenever a new version of the B2G Interface is implemented, only those data elements that are new or changed will be included in the new version of the namespace. Older versions of the namespace will continue to be used for as long as they are needed.

3.5.2.3 http://schemas.ppsr.gov.au/notifications

This namespace is used for the definition of all data elements that make up the notifications provided through the B2G Mailbox.

This namespace is not versioned. New notification types and additional data elements in existing notification types can be added without requiring a new version of the B2G Interface. The XSD for this namespace is not provided as part of the WSDL for the B2G Interface. An update to the notifications XSD will be published and made available on the PPSR public website (http://www.ppsr.gov.au).


http://www.ppsr.gov.au/

UNCLASSIFIED

See the document “B2G Mailbox Notifications” for more information about this namespace.

3.5.2.4 http://schemas.ppsr.gov.au/reports

This namespace is used for the definition of all data elements that make up the report criteria and report output for reports provided by PPSR.

This namespace is not versioned. New reports and additional data elements in existing report criteria and output can be added without requiring a new version of the B2G Interface. The XSD for this namespace is not provided as part of the WSDL for the B2G Interface. An update to the reports XSD will be published and made available on the PPSR public website (http://www.ppsr.gov.au).

See the document “Reports Technical Specification” for more information about this namespace.

3.5.2.5 http://schemas.ppsr.gov.au/faults

This namespace is used for the definition of all data elements that make up the fault types provided through the B2G Interface.

This namespace is not versioned. New versions of the B2G Interface may include additional fault types and additional data elements in existing fault types. When a new version of the B2G Interface is implemented, and the new version includes additional fault types or additional data elements, B2G Account Customers using a previous version of the B2G Interface will not be able to use the new fault types or additional data elements.

3.5.3 Versioning Considerations

3.5.3.1 Use of Reference Types

PPSR uses reference data types that have a restricted list of available values (see section 5 Reference Types). Where these reference data types are used in the http://schemas.ppsr.gov.au/yyyy/mm/data namespace they are defined using the XML schema representation of an xs:simpleType with an xs:restriction of a base type of xs:string, followed by xs:enumeration elements listing the accepted values. Where these reference data types are used in the http://schemas.ppsr.gov.au /notifications namespace they are defined just as type xs:string,

For example:

<xs:simpleType name="CollateralType">


http://www.ppsr.gov.au/

UNCLASSIFIED

<xs:restriction base="xs:string"> <xs:enumeration value="Unsupported" /> <xs:enumeration value="Unknown" /> <xs:enumeration value="Consumer" /> <xs:enumeration value="Commercial" /> </xs:restriction> </xs:simpleType>

3.5.3.1.1 Use of Reference Types in the http://schemas.ppsr.gov.au/yyyy/mm/data Namespace

In the http://schemas.ppsr.gov.au/yyyy/mm/data namespace, all reference data types that can be returned in messages from PPSR will include the value “Unsupported” in the enumerated list of values. The value “Unsupported” will not be included in reference data types that are only used for messages sent to PPSR.

If a new value needs to be added to the list of values for a reference data type, the new value will be added to the enumerated list of values for the reference data type in a new version of the http://schemas.ppsr.gov.au/yyyy/mm/data namespace, and instances of the new value will only be returned by PPSR when a new version of the B2G Interface is being used. If a B2G Account Customer is using an old version of the B2G Interface and a record using the new value of the reference data type needs to be returned from PPSR to the B2G Account Customer, the value returned for the reference data type will be “Unsupported”.

For example, consider the impact if a new collateral class is implemented in PPSR. This will be implemented in a new version of the B2G Interface. It will not be possible for a user of the old version of the B2G Interface to create a registration for this new collateral class. However, it will be possible for the user of the old version to retrieve a registration for this new collateral class (the registration may have been created through the PPSR Web Channel, or by another B2G Account Customer using the new version of the B2G Interface). It would still be possible for certain operations to be performed for the registration using the old version of the B2G Interface (e.g. Discharge the registration). Registrations returned in search results may be for the new collateral class.

When developing a B2G Account Customer system that accesses the PPSR B2G Interface, the system should be designed to deal with “Unsupported” being returned in reference data types. It is up to the B2G Account Customer to decide how their system will deal with this situation.

For example, consider the situation of amending a registration to change the end time of the registration (e.g. to “renew” the registration). If a user of an old version of the B2G Interface retrieves a registration with an “Unsupported” collateral type or “Unsupported” collateral class, it could not be determined from the collateral type or collateral class whether PPSR would allow the end time of the registration to be a maximum


UNCLASSIFIED

of 7 years or 25 years, or whether the end time can be “not stated”. The B2G Account Customer might decide to implement their system in either of the following ways:

Not allow the registration to be amended, and inform the end-user that the registration will need to be amended using the PPSR Web Channel.

Allow the user to select an end time up to 25 years or to specify the end time as “not stated”. When the amendment request is sent to PPSR, PPSR will validate the request against the business rules for the actual collateral type and collateral class. If a “not stated” end time has been requested and it is not allowed, PPSR will respond with an error. If an end time greater than the allowed maximum is requested, PPSR will accept the amendment, but will set the new end time to the maximum allowed (note that the response message will include the adjusted amended end time – see the definition of the IsRegistrationEndTimeChanged element in section 4.3.6.2.2 AmendRegistrationResponseMessage).

Where a reference data type that is used in both request messages and response messages includes the value “Unsupported”, the value “Unsupported” must not be sent in a request message to PPSR.

3.5.3.1.2 Use of Reference Types in the http://schemas.ppsr.gov.au/notifications Namespace

The http://schemas.ppsr.gov.au/notifications namespace is only used to return data to B2G Account Customers through messages in the B2G Mailbox. All reference data types used in this namespace are only provided as xs:string values. Therefore, when a new value needs to be added to the list of values for a reference data type in a notification message, a new version of the http://schemas.ppsr.gov.au/notifications namespace is not required.

The text of the values for reference data types in notification messages will be exactly the same as the enumerated values used for the corresponding types in the http://schemas.ppsr.gov.au/yyyy/mm/data namespace.

3.5.3.2 Additional Elements in Existing Fault Types

If additional information needs to be provided for an existing type in the http://schemas.ppsr.gov.au/faults namespaces, new elements will be added to the schema definition for the type. An update will be made to the B2G Interface Specification and XSD file for http://schemas.ppsr.gov.au/faults namespace, but a new version of the B2G Interface will not be required.

It will be up to each B2G Account Customer to determine when and if they make use of the new XSD and make use of the new elements. To ensure a B2G Account Customer’s system continues to deserialise fault messages correctly until they make use of the new XSD, B2G Account


UNCLASSIFIED

Customers need to ensure they support ‘lax’ processing of the XML in messages (i.e. that they can continue to process messages even if there are elements in a message that were not originally defined in the schema).

To ensure correct processing of messages when new elements are added, new elements will always be added in sequence after existing elements.

Account Customers using the PPSR B2G interface need to support lax processing of XML. Support for lax processing of the XML in response messages is widely supported by the major web service stacks (e.g. WCF, Axis2, Metro, SOAP::WSDL). Lax processing may not be the default behaviour using all web service stacks, and may need to be turned on or otherwise configured.

PPSR provides a web service operation that can be used by B2G Account Customers to test whether the web service stack used in their own systems is configured to provide lax processing. See section 4.8.3 Is Lax Supported for more information.

3.6 Endpoints

3.6.1 Production and Discovery Endpoints

The WSDL is distributed with endpoint addresses for each service that include the location of the discovery site (b2g-disc.ppsr.gov.au).

For example, an endpoint defined for the discovery site:

https://b2g-disc.ppsr.gov.au/PpsrB2GService/2011/02/CollateralRegistration.svc/soap11

These addresses will need to be updated in order to access the production site for PPSR (b2g.ppsr.gov.au).

3.6.2 SOAP Version Endpoints

The WSDL contains endpoint addresses for both SOAP 1.1 and SOAP 1.2. The SOAP version used by a particular endpoint is indicated by the inclusion of the SOAP version in the final segment of the endpoint address. “soap11” is used for SOAP 1.1, and “soap12” is used for SOAP 1.2.

For example, an endpoint using SOAP 1.1:


UNCLASSIFIED


and an endpoint using SOAP 1.2:


3.6.3 MTOM Endpoints

The WSDL contains endpoint addresses for both the use of MTOM and when MTOM is not used. The use of MTOM is indicated by the inclusion of “mtom” in the final segment of the endpoint address. This is combined with the value used for the relevant SOAP version. If “mtom” is not included in the final segment of the endpoint address, MTOM is not used.

For example, a SOAP 1.1 endpoint using MTOM:

https://b2g-disc.ppsr.gov.au/PpsrB2GService/2011/02/CollateralRegistration.svc/soap11mtom

and a SOAP 1.2 endpoint not using MTOM:


If the B2G Account Customers system supports MTOM, the MTOM endpoints should be used when calling operations that involve the sending or receiving of files, such as attachments and verification statements. This includes the following operations:

Collateral Registration Service – Upload Registration Attachment

Collateral Registration Service – Retrieve Registration Attachment

Collateral Registration Search Service – Retrieve Search Result Registration Attachment

Collateral Registration Search Service – Retrieve Search Certificate

Collateral Registration Search Service – Retrieve Search Certificate Registration Attachment

Report Service – Retrieve Report

B2G Mailbox Service – Retrieve Message PDF


UNCLASSIFIED

3.6.4 B2G Interface Version

The version of the B2G Interface supported by a particular endpoint is indicated in the path of the endpoint address. The version is included in the path as “yyyy/mm”, where yyyy and mm are the year and month of the version of the B2G Interface. Note that the value of yyyy and mm will correspond to the values in the http://schemas.ppsr.gov.au/yyyy/mm/services namespace for the version of the B2G Interface version.

For example, an endpoint for the February 2011 version of the B2G Interface:


If there is a need to release more than one version of the B2G Interface within a month, the day of the month will be added for versions after the first in the month.

For example, an endpoint for the 23 November 2014 version of the B2G Interface:

https://b2g-disc.ppsr.gov.au/PpsrB2GService/2014/11/23/CollateralRegistration.svc/soap11

3.7 Target Environment

It is critical that users of PPSR are always aware of which PPSR environment they are interacting with (e.g. production or discovery). For example, the PPSR Web Channel provides visible differences on web pages when a non-production environment is accessed. This is intended to help prevent a user from accidentally creating a registration in a non-production environment when they intended to create the registration in production, or creating a registration in the production environment when they intended to use a non-production environment.

The content of PDF documents produced by PPSR (e.g. Verification Statements, Search Certificates) will clearly identify if they have been produced from a non-production environment.

For the B2G Channel, as well as the production PPSR system, a discovery system is made available to enable customers to test their software against the current version of PPSR. In addition to the production and discovery environments, additional environments may be made available from time to time for specific purpose testing.


UNCLASSIFIED

As well as using the correct endpoint address for the target environment (see section 3.6.1 Production and Discovery Endpoints), B2G Account Customer systems must identify the target PPSR environment in each request message sent to PPSR. PPSR will also identify in response messages the PPSR environment that processed the message.

The target environment is provided in request messages as a text value that must match (case-insensitive) the required value for the specific environment. The values for the production and discovery PPSR environments are “Production” and “Discovery” respectively. The value for other environments will be advised when access to the environment is needed.

See section 3.9 Common Message Fields for details of how the target environment is specified in request and response messages.

B2G Account Customers should provide a means for the value of the target environment to be configured in their system, and ensure the value is configured correctly when their system is deployed within their own test/production environments.

It is recommended that B2G Account Customers provide feedback to their own users about the environment being used, particularly when it is a non-production environment.

3.8 Request-Response Message Exchange

PPSR web services use the Request-Response message exchange pattern. Each operation has a specific schema for the request message and a schema for the corresponding response message returned upon successful completion of the web service operation.

All PPSR web service operations occur synchronously and provide an immediate response. In many cases, all the PPSR activity required for the transaction invoked by the request message is completed before the response message is returned.

However, some transactions require additional activity to be performed which is performed asynchronously. The additional activity will be queued before the response message is returned. In these cases, once the asynchronous process has completed, PPSR will add a message to the B2G mailbox for the account customer that sent the original web service request message.


UNCLASSIFIED

3.9 Common Message Fields

Every web service operation will include a standard set of fields in the request message and a standard set of fields in the response message. These are common to every request and response message and are described below. They will not be described in the details for each web service operation.

3.9.1 Target Environment Request Message Header Field

Every web service operation will include a field in the request message to specify the target environment (see section 3.7 Target Environment). The target environment field will be provided in a SOAP header rather than the SOAP body.

BaseRequestMessageAbstract Class

FieldsTargetEnvironment : string

Class Req. Element Type Notes

BaseRequestMessage 1..1 TargetEnvironment string(50) The PPSR system environment (e.g. Production, Discovery) to be used to process the request message. See section 3.7 Target Environment.


UNCLASSIFIED

3.9.2 Common Message Body Fields


UNCLASSIFIED


UNCLASSIFIED

The common request and response message fields are:


CommonRequestType 1..1 CommonB2GMessageType CommonB2GMessageType CommonRequestType is the base class for the request message used for all B2G service operations.

0..1 CCAddressDetail NotificationAddressDetail Contains addresses to send a copy of notifications generated by the request. Only copies of notifications sent to an Address for Service will be sent.The notification sent to an address for service will list the addresses where copies of a notification were sent. The owner of a secured party group can control whether a CC address can receive a copy of the notification (see IsSendToCCAddressAllowed in the RetrieveSecuredPartyGroup operation of the Secured Party Group service; section 4.4.3)

NotificationAddressDetail 0..1 B2GMailboxAccountCustomerNumber

String(20) If a valid B2G Account Customer Number is provided and allowed by the Secured Party Group, a copy of the notification will always be sent to B2G mailbox of the account customer number.

0..1 EmailAddress String(250) If a valid email address is provided and allowed by the Secured Party Group, a copy of the notification(s) will be sent to the email address.

CommonResponseType 1..1 CommonB2GMessageType CommonB2GMessageType CommonResponseType is the base class for the response message used for all B2G service operations.

1..1 PpsrRequestMessageId long A unique message identifier that identifies this message uniquely within the PPSR system.

1..1 RequestProcessedByEnvironment string(50) The PPSR system environment (e.g. Production, Discovery) that processed the request message. See section 3.7 Target Environment.

1..1 RequestProcessedDateTime dateTime The date and time when the request message was processed.

0..1 PpsrResponseMessages List<string> A list of warning and informational messages generated by processing the request. The request has been processed, but the response may differ from what was expected.Currently the only message returned is when the CCAddressDetail has valid addresses but the Secured Party Group has prevented notifications being sent.


UNCLASSIFIED


CommonB2GMessageType 1..1 CustomersRequestMessageId string(50) An identifier generated by the customer’s own software that will uniquely identify each request message within the customer’s own software.In a response message, this is the same value contained in the request message to which this message is a response.

0..1 BillingReferenceNumber String(40) An identifier provided by the customer designed to assist in linking this request to a transaction in the Transaction Reconciliation Report. It can be used to link transactions for a specific user of the B2G system.The BillingReferenceNumber is only used for chargeable transactions, but providing it when the transaction is not chargeable will not cause an error or warning.In a response message, this is the same value contained in the request message to which this message is a response

0..5 CustomersUserDefinedFields List<CustomersUserDefinedField> These are optional user defined fields to assist the B2G Account Customer to better manage the internal usage of the PPSR. See section2.2.7 User Defined Fields.

CustomersUserDefinedField 1..1 FieldName string(50) A customer supplied name for the reference field.

1..1 FieldValue string(50) A customer supplied value for the reference field.

3.10 Common SOAP Fault Contracts

The following SOAP Fault contracts provide the schema of the detail element that are common to multiple service operations. These are not repeated in the description of each individual service operation. The SOAP Fault contracts for the detail elements that are specific to individual service operations are included in the sections that describe each operation.

3.10.1 PpsrSoapFaultDetail

The base class for the content of the SOAP fault detail element is PpsrSoapFaultDetail. This class is used directly for some faults, and will be extended for other faults.


UNCLASSIFIED

PpsrSoapFaultDetailClass

PropertiesErrorNumber : stringErrorReferenceId : stringRequestProcessedByEnvironment : string


PpsrSoapFaultDetail 1..1 ErrorNumber string(10) The ErrorNumber is used to identify the specific error that occurred, or the specific business rule that was not complied with.

1..1 ErrorReferenceId string(50) A unique identifier assigned by PPSR to the occurrence of this fault being raised. The value of the ErrorReferenceId can be used by PPSR support staff to correlate a specific instance of an error with information in PPSR system logs.

1..1 RequestProcessedByEnvironment string(50) The PPSR system environment (e.g. Production, Discovery) that processed the request message. See section 3.7 Target Environment.

3.10.2 PpsrIncorrectEnvironmentFaultDetail

This class is used when the target environment specified in a request message is not correct for the environment of the endpoint a request message has been sent to (see section 3.7 Target Environment).

The target environment specified in a request message is only checked after the username and password provided in the WS-Security SOAP header have been checked. If a request message has been sent to the wrong endpoint for the required target environment, it is possible that an invalid username and password have also been provided for the endpoint the request has been sent to. If the username and password are invalid, a WS-Security SOAP fault will be returned rather than PpsrIncorrectEnvironmentFaultDetail.


UNCLASSIFIED

PpsrIncorrectEnvironmentFaultDetail


PropertiesReceivedByEnvironment : stringTargetEnvironment : string


PpsrIncorrectEnvironmentFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 TargetEnvironment string(50) The PPSR system environment (e.g. Production, Discovery) included in the request message. See section 3.7 Target Environment.

1..1 ReceivedByEnvironment string(50) The PPSR system environment (e.g. Production, Discovery) that received the request message. See section 3.7 Target Environment.

3.10.3 PpsrInvalidB2GRequestMessageFaultDetail

This class is used when the Customer’s Request Message Id contained in a request message has been used before by the Account Customer for a different request.

PpsrInvalidB2GRequestMessageFaultDetail


PropertiesCustomersRequestMessageId : string


UNCLASSIFIED


PpsrInvalidB2GRequestMessageFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 CustomersRequestMessageId string(50) The value of CustomersRequestMessageId contained in the request message to which this fault has been provided.

3.10.4 PpsrUnauthorisedFaultDetail

This class is used when the Account Customer is not authorised to call the requested B2G service operation

PpsrUnauthorisedFaultDetail


PropertiesTask : string


PpsrUnauthorisedFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 Task string(100) Identifies the task the B2G customer is not authorised to perform.

3.10.5 PpsrStringLengthExceededFaultDetail

This class is used when the length of a string value exceeds the maximum allowed length for the element.


UNCLASSIFIED

PpsrStringLengthExceededFaultDetail


PropertiesElementName : stringElementValue : stringMaxAllowedLength : int


PpsrStringLengthExceededFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 ElementName string Identifies the name of the element in the request message with a value that exceeds the maximum allowed length for the element.

1..1 ElementValue string Provides the value of the element in the request message that exceeds the maximum allowed length for the element.

1..1 MaxAllowedLength int Provides the maximum allowed length for the element in the request message that exceeds the maximum allowed length for the element.

3.10.6 PpsrInvalidDateTimeFormatFaultDetail

This class is used when a dateTime value is not provided in the required format (see section 2.2.10.5 Date/Time Values with the B2G Channel).


UNCLASSIFIED

PpsrInvalidDateTimeFormatFaultDetail


PropertiesElementName : string


PpsrInvalidDateTimeFormatFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 ElementName string Identifies the name of the element in the request message with an invalid date/time format.

3.11 Common Business Rules

Rule No. Business Rule SOAP Fault

3.11-10 The username is a valid username for a User that is a B2G Account Customer Location User.

See section 3.4 WS-Security.

3.11-20 The password is valid for the User. See section 3.4 WS-Security.

3.11-30 A value for TargetEnvironment must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50006

3.11-40 The TargetEnvironment matches the required value for the environment of the endpoint the request message has been sent to.

Fault Detail Type: PpsrIncorrectEnvironmentFaultDetailError Number: 50007

3.11-50 B2G access for the User has been activated. Fault Detail Type: PpsrSoapFaultDetailError Number: 50010


UNCLASSIFIED


3.11-60 B2G access for the Account Customer Location of the User has been activated. Fault Detail Type: PpsrSoapFaultDetailError Number: 50012

3.11-70 B2G access for the Account Customer of the User has been activated. Fault Detail Type: PpsrSoapFaultDetailError Number: 50021

3.11-80 PPSR access for the Account Customer of the User has been activated. Fault Detail Type: PpsrSoapFaultDetailError Number: 50011

3.11-90 The source IP address of the request message is within the range allowed for the B2G Account Customer Location of the User.

Fault Detail Type: PpsrSoapFaultDetailError Number: 50013

3.11-100 If the password is expired, the operation request must be for Change B2G Password. Fault Detail Type: PpsrSoapFaultDetailError Number: 50020

3.11-110 A value for CustomersRequestMessageId must be provided. Fault Detail Type: PpsrInvalidB2GRequestMessageFaultDetail

Error Number: 50014

3.11-120 The CustomersRequestMessageId has not been used before by the Account Customer for a request for a different operation.

Fault Detail Type: PpsrInvalidB2GRequestMessageFaultDetail

Error Number: 50002

3.11-130 The CustomersRequestMessageId has not been used before by the Account Customer for a different request message (but the same operation).Note: if a request message is received with a CustomersRequestMessageId that has been used before by the Account Customer, PPSR will compare the current request message with the previously received request message. If the request messages are identical, PPSR will determine whether the previous message was processed after it was received. If it was previously processed, the response created when it was previously processed will be returned. If it was not previously processed, it will be processed now.


Error Number: 50008

3.11-140 There are no more than five CustomersUserDefinedFields included in the request message.


3.11-150 For each CustomersUserDefinedField included in the request message, the values of both FieldName and FieldValue must not be empty strings.



UNCLASSIFIED


3.11-160 The Account Customer is authorised to call the requested B2G service operation. Fault Detail Type: PpsrUnauthorisedFaultDetailError Number: 31001

3.11-170 The values provided for string elements in the request message do not exceed the maximum allowed length for the element.

Fault Detail Type: PpsrStringLengthExceededFaultDetailError Number: 30600

3.11-180 The values provided for dateTime elements in the request message do not contain milliseconds and do not contain UTC or offset details.

Fault Detail Type: PpsrInvalidDateTimeFormatFaultDetailError Number: 50016

3.11-190 For request messages that will invoke a PPSR transaction where a fee will be charged, an account status check will be conducted prior to processing the request. The Account Customer of the User has not had charging suspended.


3.11-200 For request messages that will invoke a PPSR transaction where a fee will be charged, an account status check will be conducted prior to processing the request. The Account Customer of the User must have sufficient credit available for the amount of the transaction fee that will be changed.


3.11-210 The B2G account customer payment type must be of Credit or PrePay. Fault Detail Type: PpsrSoapFaultDetailError Number: 50024

3.11-220 The response message is only accessible for 1440 minutes (24 hours) after the request is processed,If the same message (all fields including CustomersRequestMessageId) is received within 24 hours of the initial response, then the same response message will be returned. If after 24 hours then error number 50023 will be returned.Note 1: the expiry duration may be changed from time to timeNote 2: retrieving the response again is designed to overcome uncertainty with network errors. It is not designed to provide long term storage for the account customer.


Error Number: 50023


UNCLASSIFIED


3.11-230 The response message is not available at the moment.If the same message (all fields including CustomersRequestMessageId) is received while the original messages is still being processed, error number 50026 will be returned.This is to avoid race conditions where the same request could be (partially) processed multiple times. If the message is received within 60 seconds of the original request, then this message will be returned if the response is not yet available.


Error Number: 50026

3.11-240 The B2G Account Customer Location User must not be locked Fault Detail Type: PpsrUnauthorisedFaultDetailError Number: 40024

3.11-250 If a value is provided for the B2GAccountCustomerNumber element, then the value must be for an existing B2G account customer.

Fault Detail Type: PpsrInvalidB2GRequestMessageFaultDetailError Number: 35010

3.11-260 If a value is provided for the EmailAddress element, then the value must be in a valid format for an email address.

Fault Detail Type: PpsrInvalidB2GRequestMessageFaultDetailError Number: 41106


UNCLASSIFIED

4 B2G Web ServicesThis section describes all services and their service methods available via the B2G Channel.

4.1 B2G Web Services Overview

The PPSR B2G Channel consists of a number of exposed Web Services. Each web service has a number of operations.

The system will enforce a timeout period for web service operations of 120 seconds. Coordination of these services into the business’ workflow is the responsibility of each B2G Account Customer.

The list of services and their operations available via the B2G Channel include:

1. Collateral Registration Service1. Create Registrations2. Upload Registration Attachment3. Retrieve Registration4. Retrieve Registration Attachment5. Amend Registration6. Discharge Registration7. Transfer Single Collateral Registration8. Transfer All Collateral Registrations9. Reset Registration Token10. Reissue Verification Statement11. Transfer Multiple Registrations

2. Secured Party Group Service1. Create Secured Party Group2. Retrieve Secured Party Group3. Retrieve Secured Party Group History


UNCLASSIFIED

4. Update Secured Party Group5. Reset Access Code6. Change Access Code

3. Collateral Registration Search Service1. Search By Registration Number2. Search By Serial Number3. Search By Grantor4. Search By Grantor And Event Date Range5. Ordinal Search6. Retrieve Search Result7. Retrieve Search Result Registration Attachment8. Retrieve Grantor Search Result Detail9. Filter Grantor Search Result10. Filter Grantor And Event Date Range Search Result11. Retrieve Registration History Detail12. Request Search Certificate13. Retrieve Search Certificate14. Retrieve Search Certificate Registration Attachment

4. Report Service 1. Request Report2. Retrieve Report Summaries3. Retrieve Report4. Delete Report

5. B2G Mailbox Service 1. Retrieve Messages5. Retrieve Message PDF6. Delete Messages


UNCLASSIFIED

6. Register Operations Service1. Ping2. Change B2G Password3. Is Lax Supported

7. Alert Notification Service1. Create Alert Notification2. Amend Alert Notification3. Retrieve Alert Notification4. Retrieve Alert Notifications5. Cancel Alert Notification

4.2 Which Service Operations Do I Use?

A B2G Account Customer does not need to use all B2G web services or operations, or implement the use of all operations within their own systems.

For example, a B2G Account Customer may choose to create and manage their Secured Party Groups using the Web Channel and only use the B2G Channel for creating and managing Registrations and searching the Register. This B2G Account Customer does not need to implement use of the Secured Party Group Service. Another B2G Account Customer may only be interested in searching the Register and have no need to create or manage Secured Party Groups or Registrations.

All B2G Account Customers will be required to implement and use the Change B2G Password operation of the Register Operations Service.

This remainder of this section describes the various scenarios a B2G Account Customer is likely to encounter or need. This section is broken into the following general areas:

Creating Things

Finding Things

Changing Things


UNCLASSIFIED

Producing Reports

System Check

4.2.1 Creating Things

The two key items that can be created are:

A new Secured Party Group

A new Registration (Grantor Details are part of this)

Scenario Description Service Operations to use

Create a Secured Party Group

A Secured Party Group is any combination of Secured Parties that has an interest in a piece of property. A Secured Party may be a member of a number Secured Party Groups.There is only one Secured Party Group per registration and must exist prior to creating a registration.

The data required to create a new Secured Party Group is: Nominated ‘Address for Service’ For each Secured Party in the Group:

Mailing address details and Email Address Identifying Details:

If the Secured Party is an organisation: Organisation Number Type and Organisation Number (eg ACN); or Organisation Name

If an individual: Given Names and Family Name

The Secured Party Group Access Code will be issued by the system. If so required it can be changed – see Secured Party Group – Change Access Code and Secured Party Group – Reset Access Code.The Secured Party Group Access Code will be sent to the Secured Party Group Address for Service.

Secured Party Group Service – Create Secured Party Group

If the Secured Party Group Address for Service is the B2G Account Customer Address, the Secured Party Group Access Code will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.

B2G Mailbox Service – Retrieve Messages


UNCLASSIFIED


Create New Registrations

The Secured Party Group needs to exist on the PPS Register. If this is not the case use the Create a Secured Party Group scenario described above.

It is good practise when creating a new registration to firstly use the Register to search for interests over that collateral.

Collateral Registration Search Service – Search By Serial Number for an item of collateral described by serial number OR

Collateral Registration Search Service – Search By Grantor if collateral is not described by a serial number

Once satisfied about the results of that search, create the registration. Multiple collateral items which have the same Grantor and Secured Party Group can be registered in the one interaction although they will be created as individual registrations.The data required to create a registration is: Secured Party Group Number Giving of Notice Identifier Details of the collateral Details of the Grantor(s) (if required) Options about the Registration itself

Collateral Registration Service – Create Registrations

If the registration will include one or more attachments, upload each attachment before creating the registration.


On confirmation that the registration was successful, search the Register again to ensure that this new registration is as expected and another registration for the same collateral has not been made.

Collateral Registration Search Service – Search By Serial Number for an item of collateral described by serial number OR

Collateral Registration Search Service – Search By Grantor if collateral is not described by a serial number

After the successful registration of an interest in this collateral, the verification statement and the registration token will be sent to the Secured Party Group Address for Service.

If a Secured Party Group Address for Service is the B2G Account Customer Address the Verification Statement and Registration Token will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.

B2G Mailbox Service – Retrieve Messages B2G Mailbox Service – Retrieve Message

PDF


UNCLASSIFIED

4.2.2 Finding Things

PPSR provides the following search capabilities:

Search by registration number

Search by serial number

Search by grantor

Ordinal search

The following table provides scenarios when these searches would be undertaken.


Finding registered interests in collateral items that are described by serial number

There are several different classes of registrations that relate to items that can be described by serial number. These include motor vehicles, watercraft, aircraft and intellectual property.To conduct a search on an item of collateral described by serial number, the following search criteria are required: Collateral Class Serial Number, and Type of Serial Number.

The search will return a list of the registrations that match the search criteria. The list may be empty.

This search can also be specified as a Point in Time Search by suitably authorised users1.

Collateral Registration Search Service – Search By Serial Number

1 A point in time search performs the search against the Register as it appeared at a specified date and time.


UNCLASSIFIED


Finding registered interests that are not described by serial number

Descriptions of collateral that are not described by serial number will vary from one record to another. The only reasonable way of determining whether an item of collateral not described by serial number is subject to a security interest is to conduct a search by Grantor. The search can be narrowed by Collateral Type / Class and other criteria if so desired.To conduct this search identifying details of the Grantor need to be supplied. For an individual it would include Family Name, Given Names and Date Of Birth. For an organisation an identifying number such as ACN, ARBN, ARSN or ABN, otherwise the organisation’s name. Where a specific collateral class is specified as part of the search criteria, the search will also include the classes of “all present and after acquired property” and “all present and after acquired property except”.

The search will return a count of the registrations that match the search criteria.This search can be specified as a Point in Time Search by suitably authorised users.

Collateral Registration Search Service – Search By Grantor

If the number of registrations that match the search criteria are very large, the search result can be filtered to provide a smaller number of matches.

Collateral Registration Search Service – Filter Grantor Search Result

The matching registrations can be retrieved to view the details of the registrations. Collateral Registration Search Service – Retrieve Grantor Search Result Details

Finding a specific Registration

This is a search for a specific registration by its Registration Number.

The current details for the Registration will be returned. Collateral Registration Search Service – Search By Registration Number


UNCLASSIFIED


Viewing history details of a registration that has been identified in a prior search

This will facilitate an understanding of all of the changes made to a registration found in a prior search, from its initial registration to its current state.The data required is: the Registration Number the Change Number the Search Number (that returned the registration number quoted above)

The details of the specified Registration after the specified Change Number will be returned. Collateral Registration Search Service – Retrieve Registration History Details

Retrieving an attachment to a Registration found in a Search.

If an attachment to one of the search results needs to be viewed, it can also be returned.The data required is: the Search Number the Registration Number the Change Number the Attachment Id

The attachment is returned. Collateral Registration Search Service – Retrieve Search Result Registration Attachment

Comparing the order of Registrations as they were recorded in the Register

This is a specialised search that will allow the determination of the order of two registration events. A registration event is either the start time of registration, the change time of a Change Number or the end time of registration. It should be understood this DOES NOT in itself determine priority. It determines which registration event occurred first on the PPS Register.The data required to conduct this search are the two registration numbers and optionally the change numbers for the registrations that are being compared.

The result returned will be the order of the two registration events. Collateral Registration Search Service – Ordinal Search


UNCLASSIFIED


Finding Messages in the B2G Mailbox

In order to assist in managing your mailbox the following features are available.Messages can be filtered by: B2G Message type, eg verification statements only The timestamp of the message Message Id range Secured Party Group Number Registration Number Change Number Giving of Notice Identifier Original Customer’s Request Message Id

Messages matching the requested criteria will be returned.Note that messages are not removed from the mailbox when they are retrieved. They can be deleted explicitly or will be removed after a period of time has elapsed based on the time the message was put into the mailbox. The period of time has initially been set at 60 days, however this may be reviewed in the future.


Some messages will have a PDF file. The file is not returned automatically. If you want the PDF file associated with a specific message this must be retrieved separately.



UNCLASSIFIED


How to get a Search Certificate on a Search Result

It is possible to get a search certificate from the PPS Register to show a particular result of most of the searches described above.

To get a search certificate the Search Number for the search result must be provided. Where there are multiple registrations in the search result for a Grantor search, the Registration Number of an individual registration in the search result must be provided. To get a search certificate for an earlier version of a registration in a search result, the Change Number for the required version must be provided.

Collateral Registration Search Service – Request Search Certificate

The search certificate will be produced asynchronously and can be retrieved once it is ready. Collateral Registration Search Service – Retrieve Search Certificate

If the search certificate is for a single registration that has one or more attachments, the attachment can be downloaded separately for inclusion in the search certificate.

It is possible to get one or more search certificates from a single search, and have them sent to an email address. The search certificate(s) will be produced asynchronously and then sent to the specified address.


Collateral Registration Search Service – Request Search Certificates

How to Reissue a Search Certificate

If a search certificate was issued and there is a need for that certificate to be reissued it can be done. It will have the same certificate number.

The search certificate number is required for this transaction to be completed.If the certificate number cannot be supplied a new certificate will need to be requested as described above.

Collateral Registration Search Service – Retrieve Search Certificate

If the search certificate is for a single registration that has one or more attachments, the attachment can be downloaded separately for inclusion in the search certificate.



UNCLASSIFIED


How to Reissue a Verification Statement

If for any reason a verification statement needs to be reissued there is a facility to do so.

The data required is: Registration Number Change Number Registration Token or Secured Party Group Number and Access Code

The reissued verification statement will be sent to the ‘Address for Service.’ Collateral Registration Service – Reissue Verification Statement

If the Secured Party Group Address for Service is the B2G Account Customer Address, the Verification Statement will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.



4.2.3 Changing Things

Managing how items are changed is always more complicated than creating a new item. The PPSR is no exception to this. In the PPSR there are things that can be changed and some things that cannot be changed. This section describes where and how to manage changing records in the PPSR environment.

Before making changes to records on the Register, it is important to confirm what the current details are. To accomplish this, a series of retrieval services have been made available. These are detailed first before any further discussion on changing records on the Register.


UNCLASSIFIED


Retrieving a Registration when the Registration Number and Registration Token (or Secured Party Group Access Code) is known

The primary use of this capability is to ensure that the latest details of a registration are known. This is of particular importance prior to attempting some sort of change action on the registration. (An example of this would be demonstrated in Step 1 of The Amend Registration Scenario below)The data required for this service is: Registration Number Registration Token (or Secured Party Group Number and Access Code)Only the current registration details are returned.

Collateral Registration Service – Retrieve Registration Details

Retrieving an attachment to a Registration

If on or after retrieval of the current registration details discussed above, the attachment needs to be viewed it can also be retrieved.The data required is: The Registration Number. Registration Token (or Secured Party Group Number and Access Code) Attachment IdThe attachment associated with that registration number is returned.

Collateral Registration Service – Retrieve Registration Attachment

Retrieve Secured Party Group Details

To view the current details of a Secured Party Group.The data required for this transaction are: Secured Party Group Number Secured Party Group Access CodeThe Secured Party Group details are returned.

Secured Party Group Service – Retrieve Secured Party Group

The following scenarios will demonstrate the correct approach to changing records on the Register.


UNCLASSIFIED


Amend a Registration

Amend a Registration is applicable for changing the following elements of a registration (subject to the appropriate business rules) add or remove a grantor registration end time giving of notice identifier vehicle registration number vehicle description aircraft nationality registration marks assigned pursuant to the Chicago Convention collateral description that is free text proceeds claimed proceeds description subordinate add or remove an attachment

Things that cannot be amended on a registration include: Secured Party Group (see the scenario for Change the Secured Party Group on a registration) that it is a transitional registration that it is a migrated registration organisation grantor number organisation grantor name individual grantor name individual grantor date of birth any serial number manufacturer’s name for aircraft, helicopter, or aircraft engine manufacturer’s generic model designator for aircraft, helicopter, or aircraft engine collateral type collateral class start time PMSI


UNCLASSIFIED

Scenario Description Service Operations to use inventory assets subject to control attachment file name attachment description

To amend a registration, it is good practise to firstly retrieve the current version from the Register and use the details of this registration as the basis of the amendment.


If the amendment to the registration will include adding one or more attachments, upload each attachment before amending the registration.


Make the amendment subject to the business rules of the Register.The data required for this service is: The Registration Number The latest Change Number The Registration Token (or Secured Party Group Number and Access Code) The details of the registration to be amended

Collateral Registration Service – Amend Registration

After confirmation of the successful completion of amendment, retrieve the registration record to ensure that the amended registration is as expected.


After the successful amendment of this registration, a verification statement will be issued to the Secured Party Group Address for Service.

If a Secured Party Group Address for Service is the B2G Account Customer Address the Verification Statement will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.




UNCLASSIFIED


Change the Secured Party Group on one Registration

As stated in the previous scenario, the Secured Party Group cannot be changed on a Registration via the Amend transaction. To do this the Registration must be ‘transferred’ from the original Secured Party Group to the new Secured Party Group.The new Secured Party Group needs to exist prior to attempting this transfer.

The data required for this transaction are: Registration Number of the registration to be transferred Original Secured Party Group Number Registration Token (or Original Secured Party Group Number and Access Code) New Secured Party Group Number

Collateral Registration Service –Transfer Single Collateral Registration

The registration is updated immediately.The registration will remain the same except for the Secured Party Group and Address for Service. This will be considered by the system as a change and generate a new change number. The start time of the registration will not be altered.

For this particular type of transaction, a Verification Statement will be sent to the Address for Service for BOTH the original Secured Party Group and the new Secured Party Group.A new registration Token will be generated for the transferred registration and sent to ONLY the new Secured Party Group.

If the original and/or new Secured Party Group Address for Service is the B2G Account Customer Address, the Verification Statement will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.



If the new Secured Party Group Address for Service is the B2G Account Customer Address, the Registration Token will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.




UNCLASSIFIED


Change the Secured Party Group on ALL Registrations for that Secured Party Group

This scenario is only applicable for when a Secured Party Group wants to assign ALL of their registrations to another Secured Party Group such as after an acquisition or merger.The new Secured Party Group needs to exist prior to attempting this bulk transfer.

The data required for this transaction are: Original Secured Party Group Number Original Secured Party Group Access Code New Secured Party Group Number

Collateral Registration Service –Transfer All Collateral Registrations

The registrations are not updated immediately, but are submitted for subsequent background processing.The registrations will remain the same except for the Secured Party Group and Address for Service. This will be considered by the system as a change and generate a new change number for each registration. The start time of the registrations will not be altered.

For this particular type of transaction, a Verification Statement will be sent to the Address for Service for BOTH the original Secured Party Group and the new Secured Party Group. Note that only one Verification Statement will be produced that will list all of the registrations that have been transferred.A new registration Token will be generated for each transferred registration and sent to ONLY the new Secured Party Group.

If the original and/or new Secured Party Group Address for Service is the B2G Account Customer Address, the Verification Statement will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.



If the new Secured Party Group Address for Service is the B2G Account Customer Address, the Registration Tokens will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.




UNCLASSIFIED


Change the Start time for a Registration

This cannot be altered. The start time of a registration is a system generated value based on the time a registration was put onto the Register.

No service available.

Renew a Registration

Use the Amend a Registration scenario to amend just the registration end time. Collateral Registration Service – Amend Registration

Discharge a Registration

To discharge a registration, it is good practise to firstly retrieve the current version from the Register to ensure it is the registration of interest and is the latest version of that registration.

Collateral Registration Service – Retrieve Registration

Discharge the target registration. The data required for this transaction is: Registration Number Latest Change Number Registration Token (or Secured Party Group Number and Access Code)

Collateral Registration Service – Discharge Registration

The end time of the registration will be set to the current date and time.This registration will now no longer be visible to searches.A Verification Statement will be sent to the Secured Party Group Address for Service.

If a Secured Party Group Address for Service is the B2G Account Customer Address the Verification Statement will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.




UNCLASSIFIED


Change the Address for Service for a Secured Party Group

Changing the Address for Service affects all of the current Registrations associated with a Secured Party Group. As a result of this operation a new Change Number will be issued for each Registration affected. A Verification Statement will be produced listing all affected Registrations.Changing the Address for Service for a Secured Party Group is done using the Secured Party Group Service – Update Secured Party Group operation. Other changes can be made to Secured Party Group at the same time using this operation (see Update details within a Secured Party Group scenario below). However, registrations are only affected if the Address for Service is changed and a Verification Statement is only produced if the Address for Service is changed.

Firstly retrieve the Secured Party Group Secured Party Group Service – Retrieve Secured Party Group

Make the changes to the Address for Service subject to the business rules of the Register.The data required for this service is: Secured Party Group Number Secured Party Group Access Code The new Address for Service detailsMake other changes to the Secured Party Group as described in Update details within a Secured Party Group scenario below.

Secured Party Group Service – Update Secured Party Group

The update to the Address for Service recorded for the Secured Party Group is made immediately. However, the address for service recorded for the registrations are not updated immediately, but are submitted for subsequent background processing.The registrations will remain the same except for the Address for Service. This will be considered by the system as a change and generate a new change number for each registration. The start time of the registrations will not be altered.

For this particular type of transaction, a Verification Statement will be sent to BOTH the old and new Address for Service. Note only one Verification Statement will be produced listing all of the registrations that have been transferred.

If the old and/or new Secured Party Group Address for Service is the B2G Account Customer Address, the Verification Statement will be sent by email and a copy of the same can be retrieved from the B2G Mailbox.




UNCLASSIFIED


Update details within a Secured Party Group

The secured parties that make up a Secured Party Group cannot be altered once the Secured Party Group has been saved. If there is a need to add or remove a secured party, or change the identity of a secured party, you need to create a new Secured Party Group (see Create a New Secured Party Group scenario detailed earlier) and then transfer registrations to the new Secured Party Group (see Change the Secured Party Group on ALL Registrations for that Secured Party Group scenario).The contact and address details of any of the individual secured parties in the Secured Party Group can be updated but not any of the identifying information of a Secured Party.

Firstly retrieve the Secured Party Group. Secured Party Group Service – Retrieve Secured Party Group

Change the details you want to alter.The data required for this service is: Secured Party Group Number Secured Party Group Access Code The updated secured party contact and address details.



UNCLASSIFIED


Secured Party Organisation Name Change

If a secured party in a Secured Party Group that is an organisation identified by an ACN, ARBN, ARSN or ABN changes its legal name, this change can be reflected in the Secured Party Group record without the need for creating a new Secured Party Group. The name recorded for the secured party in a Secured Party Group record can be updated by requesting the organisations identifier to be re-verified with the source register (ASIC for ACN, ARBN or ARSN, ABR for ABN).Note that for a secured party in a Secured Party Group that is an organisation not identified by an ACN, ARBN, ARSN or ABN, the name of the organisation was provided when the Secured Party Group was created and this name cannot be changed. To change this name it will be necessary to create a new Secured Party Group (see Create a New Secured Party Group scenario detailed earlier) and then transfer registrations to the new Secured Party Group (see Change the Secured Party Group on ALL Registrations for that Secured Party Group scenario).

Firstly retrieve the Secured Party Group. Secured Party Group Service – Retrieve Secured Party Group

Change the details you want to alter.The data required for this service is: Secured Party Group Number Secured Party Group Access Code The updated secured party contact and address details.


Change Secured Party Group Access Code

A Secured Party Group can change their Access Code.

The data required is: Secured Party Group Number Current Secured Party Group Access Code New Secured Party Group Access CodeThe new access code will be sent to the Secured Party Group Address for Service.

Secured Party Group Service – Change Access Code




UNCLASSIFIED


Reset Secured Party Group Access Code

A new Secured Party Group Access Code for a particular Secured Party Group can be generated by PPSR.

The data required is: Secured Party Group NumberThe new system generated access code will be sent to the Secured Party Group Address for Service.

Secured Party Group Service – Reset Access Code



Reset a Registration Token

A new Registration Token for a particular registration can be generated by PPSR.

The data required is: Registration Number Secured Party Group Number Secured Party Group Access CodeThe new registration token will be sent to the Secured Party Group Address for Service.

Collateral Registration Service – Reset Registration Token




UNCLASSIFIED


Change your B2G Password

A B2G Account Customer can change the Password for a B2G Account Customer Location User.The data required is: New B2G PasswordNote that the username and current password will be provided in the WS-Security SOAP header in the usual way.

Register Operations Service – Change B2G Password

Delete Messages from the B2G Mailbox

Messages are not removed from the mailbox when they are retrieved.They can be deleted explicitly or will be removed after a period of time has elapsed based on the time the message was put into the mailbox. To delete messages explicitly, send a list of Message Ids of the messages to be deleted.

B2G Mailbox Service – Delete Messages

4.2.4 Producing Reports

PPSR allows Account Customers to produce a range of reports.


Request PPSR to produce a report.

Request a report by specifying the report type and any necessary report criteria. Report Service – Request Report

The report will be produced asynchronously and can be retrieved once it is ready. Report Service – Retrieve Report

Get a list of recent reports requested by the Account Customer

Reports are kept on PPSR for a maximum of seven days after they have been produced. After this time the reports are deleted by PPSR. Reports can be deleted earlier by the Account Customer if they no longer need to access the report output.A B2G Account Customer can retrieve a list of all reports that have been requested by the Account Customer and have not yet been deleted.The list will include summary information about the reports, including the report type, the report criteria used, and whether the report has been produced.The list of reports can be restricted to just reports of a specified report type, or for a specific report.

Report Service – Retrieve Report Summaries


UNCLASSIFIED


Delete a report A B2G Account Customer can delete a report once they have retrieved the report output and stored it in their own system.

Report Service – Delete Report

4.2.5 System Checks


Is the PPSR System Available

A simple system check of “Ping” is available to ensure that the client system can communicate with the PPSR system.

Register Operations Service – Ping


UNCLASSIFIED

4.3 Collateral Registration Service

The Collateral Registration Service contains operations that create and manage Registrations. These include:

Create Registrations

Upload Registration Attachment

Retrieve Registration

Retrieve Registration Attachment

Amend Registration

Discharge Registration

Transfer Single Collateral Registration

Transfer All Collateral Registrations

Reset Registration Token

Reissue Verification Statement

Transfer Multiple Collateral Registrations

Details of these operations are described below.


UNCLASSIFIED

4.3.1 Fault Contracts

4.3.1.1 PpsrCollateralRegistrationAccessFaultDetail

This class is used when an existing Registration is accessed or acted upon using a Registration Token or Secured Party Group Number/Access Code which are not supplied or invalid.

PpsrCollateralRegistrationAccessFaultDetail


PropertiesRegistrationNumber : string


PpsrCollateralRegistrationAccessFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 RegistrationNumber string(20) The Registration Number that resulted in the error.If no Registration Number was provided, this will be an empty string.


UNCLASSIFIED

4.3.2 Create Registrations

This operation is used to submit an application to add new Registrations to PPSR.

The operation will be used most commonly to create a single new Registration each time the operation is called. The request message provided when the operation is called must provide all the information required to create the new Registration record in PPSR. This includes the attributes used to describe the collateral being registered, the identity of the Secured Party Group and (if required) the Grantor(s).

It is possible to use the operation to create more than one Registration as part of the one application. However, there are restrictions on the Registrations that can be created within the one application. All Registrations must have the same Collateral Type (Commercial or Consumer) and must be for the same Secured Party Group and Grantor(s). Allowing multiple Registrations to be created at the same time allows for scenarios such as a lender providing finance to a car dealer for the purchase of multiple cars.

To facilitate creation of multiple registrations within the one application, the data elements that are common to each registration only need to be provided once. These common data elements will be applied to each Registration record that is created. In the schema for the request message for the Create Registrations operation, common data elements have been grouped separately from other Registration data elements that need to be individually specified for each Registration.

There are many optional data elements within the request message. Depending on the Collateral Type (i.e. Commercial or Consumer), Collateral Class (e.g. Motor Vehicle, Watercraft, Agriculture, Intellectual Property, etc.) and whether the collateral is described by a serial number, some data elements will not be relevant, some data elements will be relevant but optional, and some data elements will be mandatory. In the schema for the request message for the Create Registrations operation, data elements are only shown as mandatory if they are always mandatory for every Registration. Optional data elements must only have a value provided when the data element is relevant for the particular Registration.

PPSR will validate the data provided in each call to the Create Registrations operation to ensure: all mandatory data is provided; that data is not provided when it is not relevant; and the provided data contains acceptable values. Whether particular data elements that are not always mandatory, are mandatory for a specific Registration, is not documented in this specification. The document “PPSR - 6.4.3.1 - Describing Collateral” defines the business rules regarding optional and mandatory data requirements for specific Collateral Types and Collateral Classes.


UNCLASSIFIED

Note: Many of the business rules checks that are performed by PPSR refer to whether a data element is allowed, relevant or required for the registration. The document “PPSR - 6.4.3.1 - Describing Collateral” should be referred to for the specific rules that apply for specific Collateral Types and Collateral Classes.

Not all Registrations can have a Grantor recorded when the Registration is created in PPSR. Whether a Registration allows or requires a Grantor will depend upon the Collateral Type, Collateral Class and whether the collateral is described by a serial number. If at least one of the Registrations in the request message requires a Grantor, then at least one Grantor must be specified in the request message. If none of the Registrations in the request message allows a Grantor, then do not include any Grantors in the request message. If one or more Grantors is included in the request message then all of the Grantors will be included in each of the Registrations created in PPSR that allow a Grantor; the Grantors will not be included in the Registrations that do not allow a Grantor.

If any of the Registrations in the request are to be created with any Attachments, the Attachment must have been uploaded to PPSR using the Upload Registration Attachment operation before calling the Create Registrations operation. The Upload Registration Attachment operation will return an Attachment Id for the uploaded attachment. This Attachment Id is then included in the Create Registrations request message in order to add the Attachment to the appropriate Registration. Each Attachment uploaded to PPSR can only be associated with one Registration. Once a Registration has been saved with a particular Attachment Id, the same Attachment Id cannot be used to save with another Registration.

There is a limit applied to the number of Attachments that can be added to a single Registration. The limit is not specified in this document and it may change over time. B2G Account Customers will be advised of the limit in the number of Attachments that can be added to a single Registration and any changes to the limit.

The business rule checks that are performed by PPSR when a call is made to the Create Registrations operation are listed in section 4.3.2.4 Business Rules. If there are any violations of any of these business rules, details of the business rule that was violated will be returned as a SOAP fault. Provided all common business rules as documented in section 3.11 Common Business Rules are passed, all business rule checks for the registration data will be performed on all the data provided in the request message and a complete list of business rules violated will be returned in the SOAP fault. The SOAP Fault detail element used to provide the business rule violations is PpsrCollateralRegistrationCreateValidationFaultDetail (see section 4.3.2.3.1).


UNCLASSIFIED

4.3.2.1 Operation Contract

Service Name: CollateralRegistration

Operation Name: CreateRegistrations

Request: CreateRegistrationsRequestMessage

Response: CreateRegistrationsResponseMessage


UNCLASSIFIED

4.3.2.2 Message Contracts

4.3.2.2.1 CreateRegistrationsRequestMessage

CreateRegistrationsRequestMessage

BaseRequestMessageClass

CreateRegistrationsRequestType

CommonRequestTypeClass

PropertiesIsTransitional : boolNewRegistrations : List<NewCollateralRegistration>SecuredPartyGroupNumber : string

NewGrantorClass

PropertiesNewGrantorSequenceNumber : short

NewGrantorIndividualClass

PropertiesDateOfBirth : DateTimeFamilyName : stringGivenNames : string

GrantorOrganisationClass

PropertiesOrganisationName : stringOrganisationNumber : string

NewRegistrationCollateralTypeEnum

ConsumerCommercial

GrantorTypeEnum

UnsupportedOrganisationIndividual

OrganisationNumberTypeEnum

UnsupportedACNARBNARSNABN

CreateRegistrationsRequest

CollateralType

Grantors : List<NewGrantor>

GrantorType

OrganisationIndividual

OrganisationNumberType


UNCLASSIFIED

NewCollateralRegistrationClass

PropertiesAreAssetsSubjectToControl : bool?AreProceedsClaimed : bool?CollateralDescription : stringEarlierRegistrationNumber : stringGivingOfNoticeIdentifier : stringIsInventory : bool?IsPMSI : bool?IsRegistrationEndTimeNotStated : bool?IsSubordinate : boolNewRegistrationSequenceNumber : shortProceedsClaimedDescription : stringRegistrationEndTime : DateTime?

NewAttachmentClass

PropertiesAttachmentId : longNewAttachmentSequenceNumber : short

NewRegistrationSerialisedCollateralDescriptionClass

PropertiesSerialNumber : string

AdditionalAircraftCollateralDescriptionClass

PropertiesAircraftNationality : stringAircraftNationalityCodeAndRegistrationMark : stringManufacturersModel : stringManufacturersName : string

AdditionalVehicleCollateralDescriptionClass

PropertiesVehicleDescriptiveText : stringVehicleRegistrationNumber : string

NewRegistrationCollateralClassTypeEnum

AircraftMotorVehicleWatercraftAircraftEngineAirframeHelicopterSmallAircraftAgricultureCropsLivestockOtherGoodsChattelPaperCurrencyDocumentOfTitleIntermediatedSecurityInvestmentInstrumentNegotiableInstrumentAccountGeneralIntangibleIntellectualPropertyCircuitLayoutCopyrightPatentDesignTradeMarkPlantBreedersRightAllPapNoExceptAllPapWithExcept

NewRegistrationSerialNumberTypeEnum

VINChassisNumberMotorVehicleManufacturersNumberHINOfficialNumberAircraftEngineManufacturersNumberAirframeManufacturersNumberHelicopterManufacturersNumberAircraftNationalityCodeAndRegistrationMarkPatentNumberTradeMarkNumberDesignNumberPlantBreedersRightNumber

SerialNumberDetails

CollateralClassType

Attachments : List<NewAttachment>

SerialNumberType

AdditionalVehicleDetails AdditionalAircraftDetails


UNCLASSIFIED


CreateRegistrationsRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 CreateRegistrationsRequest CreateRegistrationsRequestType

CreateRegistrationsRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number identifies the Secured Party Group for the Registration(s).

1..1 IsTransitional boolean Indicates if the Registrations are for an interest that existed prior to the registration commencement time of PPSR. If there is more than one new Registration included in the request and any of them are transitional registrations, then all of them must be transitional registrations.

1..1 CollateralType NewRegistrationCollateralType The Collateral Type for all of the Registrations included in the requestSee section 5.11 NewRegistrationCollateralType for details.

1..* NewRegistrations List<NewCollateralRegistration> One or more items of collateral. A separate Registration will be created for each NewCollateralRegistration in the list.

0..* Grantors List<NewGrantor> Zero, one or more grantors.Only provide NewGrantors if there is at least one NewCollateralRegistration that allows a grantor.If at least one NewCollateralRegistration requires a grantor, then at least one NewGrantor must be included.Do not provide any NewGrantors if none of the NewCollateralRegistrations allows a grantor.

NewCollateralRegistration 1..1 NewRegistrationSequenceNumber short A unique sequence number must be provided for each registration in order to uniquely identify the registration in the request when creating multiple registrations simultaneously.The first NewCollateralRegistration in a request message should have a NewRegistrationSequenceNumber value of 1; the second NewCollateralRegistration in a request message should have a NewRegistrationSequenceNumber value of 2, and so on.When the new Registrations have been created in PPSR and the Registration Numbers assigned by


UNCLASSIFIED


PPSR are provided in the response message, the Registration Numbers in the response message are linked to the sequence numbers in the request message.This number will be used to associate business rule violations (if any) with a particular registration. In the SOAP fault, the fault detail will include the NewRegistrationSequenceNumber value for any violations related to the NewCollateralRegistration.This number is not stored in PPSR as part of the Registration record.

0..1 EarlierRegistrationNumber string(20) The Registration Number of an existing earlier registration where the earlier registration relates to the same security interest. The earlier registration must still be current (not expired/discharged or removed).

0..1 GivingOfNoticeIdentifier string(50) An optional identifier that a Secured Party can specify for the registration.The giving of notice identifier is included in any communication sent from the PPSR to the registration’s address for service (e.g. verification statement).

1..1 CollateralClassType NewRegistrationCollateralClassType The Collateral Class for the registration.See section 5.10 NewRegistrationCollateralClassType for details.Not all Collateral Classes can be used for every Registration. The Collateral Classes that can be used depend upon the value of CollateralType.

0..1 SerialNumberDetails NewRegistrationSerialisedCollateralDescription

If the collateral in the registration is described by a serial number, the SerialNumberDetails element must be provided with details of the serial number.SerialNumberDetails can only be provided if the Collateral Type and Collateral Class allow for collateral to be described by a serial number.SerialNumberDetails must not be provided if the Collateral Type and Collateral Class do not allow for collateral to be described by a serial number.SerialNumberDetails must be provided if the Collateral Type and Collateral Class do not allow for collateral to be described other than by a serial number.


UNCLASSIFIED


0..1 CollateralDescription string(500) A free text description of the collateral.Whether a free text description is allowed and whether it is mandatory for a registration is described in the document “PPSR - 6.4.3.1 - Describing Collateral”CollateralDescription must not be provided if a free text description is not allowed.CollateralDescription must be provided if a free text description is mandatory.Note: if there is insufficient space to adequately describe the collateral and attachments are allowed for the registration, additional description can be provided in a file attachment with the registration.

0..1 IsRegistrationEndTimeNotStated boolean If “true”, identifies that the End Time for the registration has a value of “Not Stated”.Whether the End Time for a registration can be “Not Stated” for a registration is described in the document “PPSR - 6.4.3.1 - Describing Collateral”Only provide a value if “Not Stated” is allowed for the registration.If “Not Stated” is allowed for the registration, then a value must be provided.

0..1 RegistrationEndTime dateTime If a value for RegistrationEndTime is provided, the time provided should be 23:59:59. If it is not, it will not generate an error. The message will still be accepted and the time will be changed to 23:59:59.If the End Time for a registration can be “Not Stated” and the value of IsRegistrationEndTimeNotStated is True, then a value must not be provided for RegistrationEndTime.If the End Time for a registration cannot be “Not Stated”, then a value must be provided for RegistrationEndTime.If the End Time for a registration can be “Not Stated” and the value of IsRegistrationEndTimeNotStated is False, then a value must be provided for RegistrationEndTime.The maximum End Time that can be provided for a registration depends upon the Collateral Type,


UNCLASSIFIED


Collateral Class and whether the collateral is described by a serial number. If a RegistrationEndTime is provided and the value exceeds the maximum End Time allowed, it will not generate an error. The message will still be accepted and the End Time will set to 23:59:59 on the date of the maximum allowed End Time for the registration.If a RegistrationEndTime is provided, it cannot be on a date prior to the current date.

0..1 IsPMSI boolean Whether a registration is a PMSI is not relevant for all registrations and is described in the document “PPSR - 6.4.3.1 - Describing Collateral”.Only provide a value for IsPMSI if whether or not a registration is a PMSI is relevant.If whether or not a registration is a PMSI is relevant then a value for IsPMSI must be provided.

0..1 IsInventory boolean Whether the collateral is inventory.Whether the collateral is inventory is not relevant for all registrations and is described in the document “PPSR - 6.4.3.1 - Describing Collateral”.Only provide a value for IsInventory if whether or not the collateral is inventory is relevant.If whether or not collateral is inventory is relevant then a value for IsInventory must be provided.

0..1 AreAssetsSubjectToControl boolean Whether the collateral is an asset subject to control.Whether the collateral is an asset subject to control is not relevant for all registrations and is described in the document “PPSR - 6.4.3.1 - Describing Collateral”.In addition, for some registrations whether the collateral is an asset subject to control is only relevant if the collateral is inventory.Only provide a value for AreAssetsSubjectToControl if whether or not the collateral is an asset subject to control is relevant.If whether or not collateral is an asset subject to control is relevant then a value for AreAssetsSubjectToControl must be provided.


UNCLASSIFIED


0..1 AreProceedsClaimed boolean Whether or not proceeds are claimed.Whether proceeds are claimed is not relevant for all registrations and is described in the document “PPSR - 6.4.3.1 - Describing Collateral”.Only provide a value for AreProceedsClaimed if whether or not proceeds are claimed is relevant.If whether or not proceeds are claimed is relevant then a value for AreProceedsClaimed must be provided.

0..1 ProceedsClaimedDescription string(500) A free text description of the proceeds claimed. If whether proceeds are claimed is not relevant for the registration, or the value provided for AreProceedsClaimed is False, then a value for ProceedsClaimedDescription must not be provided.If whether proceeds are claimed is relevant and the value provided for AreProceedsClaimed is True, then providing a value in the ProceedsClaimedDescription element is optional. However, if a value is not provided, PPSR will set the description of proceeds claimed to “All present and after acquired property”.

1..1 IsSubordinate boolean

0..* Attachments List<NewAttachment> A list of Attachments (if any) to be saved as part of the registration.Attachments are not allowed for all registrations. Whether attachments are allowed is described in the document “PPSR - 6.4.3.1 - Describing Collateral”.Attachments must only be provided if attachments are allowed for the registration.

NewRegistrationSerialisedCollateralDescription

1..1 SerialNumberType NewRegistrationSerialNumberType The type of the serial number used to describe the collateral. See section 5.12 NewRegistrationSerialNumberType for details.The type of serial number that can be used depends upon the values of CollateralType and CollateralClassType and is described in the document “PPSR - 6.4.3.1 - Describing Collateral”.

1..1 SerialNumber string(50) The value of the serial number used to describe the collateral.


UNCLASSIFIED


0..1 AdditionalVehicleDetails AdditionalVehicleCollateralDescription If the collateral being described by serial number is for the Collateral Class of Motor Vehicle, the AdditionalVehicleDetails must be provided.If the collateral being described by serial number is for any other Collateral Class, the AdditionalVehicleDetails must not be provided.

0..1 AdditionalAircraftDetails AdditionalAircraftCollateralDescription If the collateral being described by serial number is for one of the following Collateral Classes: Aircraft Engine Airframe Helicopter Small Aircraftthe AdditionalAircraftDetails must be provided.If the collateral being described by serial number is for any other Collateral Class, the AdditionalAircraftDetails must not be provided.

AdditionalVehicleCollateralDescription 0..1 VehicleRegistrationNumber string(20) The registration plate number of the vehicle can optionally be provided.

0..1 VehicleDescriptiveText string(500) If the type of serial number used to describe the collateral is a Motor Vehicle Manufacturer's Number, then a free text description of the vehicle can be provided in the VehicleDescriptiveText. However, the VehicleDescriptiveText must not be provided if a value has been provided for VehicleRegistrationNumber.If the type of serial number used to describe the collateral is anything other than a Motor Vehicle Manufacturer's Number, then a value must not be provided for VehicleDescriptiveText.

AdditionalAircraftCollateralDescription 0..1 ManufacturersName string(100) The name of the manufacturer.A value for the ManufacturersName must be provided in the following cases: Collateral Class is Aircraft Engine and the

type of serial number used to describe the collateral is an Aircraft Engine Manufacturer’s Number

Collateral Class is Airframe and the type of serial number used to describe the collateral is an Airframe Manufacturer’s Number

Collateral Class is Helicopter and the type of


UNCLASSIFIED


serial number used to describe the collateral is a Helicopter Manufacturer’s Number

A value for the ManufacturersName must not be provided in all other cases.

0..1 ManufacturersModel string(50) A generic model designator provided by the manufacturer.A value for the ManufacturerModel must be provided in the following cases: Collateral Class is Aircraft Engine and the

type of serial number used to describe the collateral is an Aircraft Engine Manufacturer’s Number

Collateral Class is Airframe and the type of serial number used to describe the collateral is an Airframe Manufacturer’s Number

Collateral Class is Helicopter and the type of serial number used to describe the collateral is a Helicopter Manufacturer’s Number

0..1 AircraftNationality string(50) The aircraft nationality (the state of registry e.g. ‘Australia’).

A value for the AircraftNationality is optional and may be provided in the following cases: Collateral Class is Airframe and the type of

serial number used to describe the collateral is an Airframe Manufacturer’s Number


Collateral Class is Small Aircraft and the type of serial number used to describe the collateral is an Aircraft Nationality Code and Registration Mark

A value for the AircraftNationality must not be provided in all other cases.

0..1 AircraftNationalityCodeAndRegistrationMark

string(100) The nationality (e.g. ‘VH’ for Australia) and registration marks assigned pursuant to the Chicago Convention.

A value for the


UNCLASSIFIED


AircraftNationalityCodeAndRegistrationMark is optional and may be provided in the following cases: Collateral Class is Airframe and the type of

serial number used to describe the collateral is an Airframe Manufacturer’s Number


A value for the AircraftNationalityCodeAndRegistrationMark must not be provided in all other cases.Note: If the Collateral Class is Small Aircraft, the Aircraft Nationality Code and Registration Mark must be provided in the SerialNumber element, and the SerialNumberType must be AircraftNationalityCodeAndRegistrationMark. There must be no value provided in the AircraftNationalityCodeAndRegistrationMark element.

NewAttachment 1..1 NewAttachmentSequenceNumber short A unique sequence number must be provided for each attachment in order to uniquely identify the attachment when there is more than one attachment in the request.The first NewAttachment in a request message should have a NewAttachmentSequenceNumber value of 1; the second NewAttachment in a request message should have a NewAttachmentSequenceNumber value of 2, and so on.If there is more than one registration with attachments in the request, the NewAttachmentSequenceNumber must be unique across all registrations in the request (i.e. do not restart the sequence at 1 for each registration).This number will be used to associate business rule violations (if any) with a particular attachment. In the SOAP fault, the fault detail will include the NewAttachmentSequenceNumber value for any violations related to the NewAttachment.This number is not stored in PPSR as part of the Registration record.


UNCLASSIFIED


1..1 AttachmentId long The Attachment Id for the attachment to be saved as part of the registration.The Attachment Id must be for an attachment that has already been uploaded to PPSR using the Upload Registration Attachment operation (see 4.3.3 Upload Registration Attachment).The Attachment Id must not have already been used for another registration.

NewGrantor 1..1 NewGrantorSequenceNumber short A unique sequence number must be provided for each grantor in order to uniquely identify the grantor in the request when there is more than one grantor in the request.The first NewGrantor in a request message should have a NewGrantorSequenceNumber value of 1; the second NewGrantor in a request message should have a NewGrantorSequenceNumber value of 2, and so on.This number will be used to associate business rule violations (if any) with a particular grantor. In the SOAP fault, the fault detail will include the NewGrantorSequenceNumber value for any violations related to the NewGrantor.This number is not stored in PPSR as part of the Registration record.

1..1 GrantorType GrantorType Indicates whether the Grantor is an organisation or an individual. See section 5.7 GrantorType for details.If the CollateralType is Consumer, then only grantors who are individuals can be provided.

0..1 Organisation GrantorOrganisation If the grantor is an organisation, a value for Organisation must be provided.If the grantor is not an organisation, a value for Organisation must not be provided.

0..1 Individual NewGrantorIndividual If the grantor is an individual, a value for Individual must be provided.If the grantor is not an individual, a value for Individual must not be provided.

GrantorOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.


UNCLASSIFIED


Only provide a value for OrganisationNumberType if the grantor is an organisation that will be identified in PPSR by its organisation number.If a value is provided for OrganisationNumberType then a value must also be provided for OrganisationNumber and a value must not be provided for OrganisationName.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumberType.

0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.Only provide a value for OrganisationNumber if the grantor is an organisation that will be identified in PPSR by its organisation number.If a value is provided for OrganisationNumber then a value must also be provided for OrganisationNumberType and a value must not be provided for OrganisationName.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumber.

0..1 OrganisationName string(250) The name of the organisation.Only provide a value for OrganisationName if the grantor is an organisation that will not be identified in PPSR by an organisation number.If a value is provided for OrganisationName then a value must not be provided for OrganisationNumberType or OrganisationNumber.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumberType and OrganisationNumber.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters forGrantor Names for the list of allowable characters.

NewGrantorIndividual 1..1 FamilyName string(40) The family name of the grantor.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters forGrantor Names for the list of allowable characters.


UNCLASSIFIED


1..1 GivenNames string(80) The given names of the grantor.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters forGrantor Names for the list of allowable characters.

1..1 DateOfBirth dateTime The date of birth of the grantor.Note: A time should not be specified. However, if a time component is specified it is ignored by PPSR.

4.3.2.2.2 CreateRegistrationsResponseMessage

CreateRegistrationsResponseMessageClass

CreateRegistrationsResponseType

CommonResponseTypeClass

RegistrationInfoClass

PropertiesChangeNumber : longIsRegistrationEndTimeChanged : boolNewRegistrationSequenceNumber : shortPpsrTransactionId : longRegistrationEndTime : DateTime?RegistrationNumber : stringRegistrationStartTime : DateTime

CreateRegistrationsResponse

Registrations : List<RegistrationInfo>


CreateRegistrationsResponseMessage 1..1 CreateRegistrationsResponse CreateRegistrationsResponseType

CreateRegistrationsResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..* Registrations List<RegistrationInfo> There will be one RegistrationInfo in the list of Registrations for each NewCollateralRegistration that was provided in the request message.


UNCLASSIFIED


RegistrationInfo 1..1 NewRegistrationSequenceNumber short The same value as the NewRegistrationSequenceNumber in the corresponding NewCollateralRegistration that was provided in the request message.

1..1 RegistrationNumber string(20) The Registration Number assigned by PPSR to the Registration.

1..1 ChangeNumber long The Change Number assigned by PPSR to the initial version of the Registration.Every time a Registration is amended, including the original creation of the Registration, a unique sequential Change Number is assigned to the version of the Registration record. This Change Number will be unique and sequentially allocated across all changes to all Registration records, not just across the changes to the one Registration.

1..1 PpsrTransactionId long A unique identifier of the transaction in PPSR.

1..1 RegistrationStartTime dateTime When there is more than one NewCollateralRegistration in the request message, all registrations created at the same time will have the same RegistrationStartTime value.

0..1 RegistrationEndTime dateTime The date and time that the registration will expire. See the corresponding element of the CreateRegistrationsRequestType for more details.

1..1 IsRegistrationEndTimeChanged boolean Indicates whether the RegistrationEndTime was changed by PPSR while creating the registration.This can occur in the following cases: If the value for RegistrationEndTime in the

request message is greater than the maximum end time allowed for this combination of Collateral Type, Collateral Class and whether the collateral is described by a serial number, the time component will be set to 23:59:59 on the date of the maximum allowed End Time for the registration.

If the value for RegistrationEndTime in the request message is provided and has a


UNCLASSIFIED


time component that is not 23:59:59, the time component will be set to 23:59:59.

4.3.2.3 Fault Contracts

4.3.2.3.1 PpsrCollateralRegistrationCreateValidationFaultDetail

PpsrCollateralRegistrationCreateValidationFaultDetail


PpsrValidationErrorClass

PropertiesErrorMessage : stringErrorNumber : string

PpsrValidationErrorGroupClass

PropertiesSequenceNumber : short

ApplicationValidationErrors : List<PpsrValidationError>

CollateralRegistrationValidationErrors : List<PpsrValidationErrorGroup>

AttachmentValidationErrors : List<PpsrValidationErrorGroup>

GrantorValidationErrors : List<PpsrValidationErrorGroup> ValidationErrors : List<PpsrValidationError>


PpsrCollateralRegistrationCreateValidationFaultDetail

1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

0..1 ApplicationValidationErrors List<PpsrValidationError> A list of validation errors in the data that is common to all Registrations in the request message.

0..1 CollateralRegistrationValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data for Registrations in the request message.

0..1 AttachmentValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data for attachments in the request message.

0..1 GrantorValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data for grantors in the request message.


UNCLASSIFIED


PpsrValidationErrorGroup 1..1 SequenceNumber short Identifies the sequence number of the element in the request message for which validation errors have occurred. For example, if the PpsrValidationErrorGroup is for validation errors associated with a NewCollateralRegistration in the request message, the value of SequenceNumber will be the value of the NewRegistrationSequenceNumber of the NewCollateralRegistration in the request message.

1..1 ValidationErrors List<PpsrValidationError> A list of validation errors in the data for the element in the request message identified by the SequenceNumber.

PpsrValidationError 1..1 ErrorNumber string(10) The ErrorNumber is used to identify the specific validation error that occurred, or the specific business rule that was not complied with.

1..1 ErrorMessage string A description of the error.

4.3.2.4 Business Rules

Many business rule violations will be returned as a SOAP Fault where the content of the SOAP fault detail element is PpsrCollateralRegistrationCreateValidationFaultDetail and the value of the ErrorNumber is 678. The PpsrCollateralRegistrationCreateValidationFaultDetail allows multiple business rule violations to be reported. In the following table, the value in the SOAP Fault column indicates which group of errors in the PpsrCollateralRegistrationCreateValidationFaultDetail that a violation of the business rule will be reported in (ApplicationValidationErrors, CollateralRegistrationValidationErrors, AttachmentValidationErrors or GrantorValidationErrors), as well as the value of the ErrorNumber for the business rule that has been violated.


4.3.2-10 The CreateRegistrationsRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


UNCLASSIFIED


4.3.2-20 The value provided for SecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailApplicationValidationErrorsError Number: 32013

4.3.2-30 The value of SecuredPartyGroupNumber must be for an existing Secured Party Group. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailApplicationValidationErrorsError Number: 32014

4.3.2-41 The value provided for the SecuredPartyGroupNumber must not be for a migrated Secured Party Group.

Fault Detail Type: PpsrSecuredPartyGroupAccessFaultDetailError Number: 33069

4.3.2-50 At least one NewCollateralRegistration must be provided. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailApplicationValidationErrorsError Number: 32146

4.3.2-60 If more than one NewCollateralRegistration is provided, then each NewCollateralRegistration must have a unique NewRegistrationSequenceNumber.

Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailCollateralRegistrationValidationErrorsError Number: 32145

4.3.2-70 If a value is provided in the EarlierRegistrationNumber element, then the value must be a Registration Number for an existing registration.


4.3.2-80 If a value is provided in the EarlierRegistrationNumber element, then the value must be a Registration Number for a registration that is still current (i.e. not expired, discharged or removed).



UNCLASSIFIED


4.3.2-90 The value for CollateralClassType is allowed for the provided CollateralType. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailCollateralRegistrationValidationErrorsError Number: 32110

4.3.2-100 If a value is provided in the SerialNumberDetails element, then describing collateral by a serial number must be allowed for the provided CollateralType and CollateralClassType. SerialNumberDetails must not be provided if the CollateralType and CollateralClassType do not allow for collateral to be described by a serial number.


4.3.2-110 If a value is not provided in the SerialNumberDetails element, then describing collateral without a serial number must be allowed for the provided CollateralType and CollateralClassType.


4.3.2-120 If a value is provided in the SerialNumberDetails element, then the value of the SerialNumberType must be allowed for the provided CollateralType and CollateralClassType.


4.3.2-130 If a value is provided in the SerialNumberDetails element, then the value provided in the SerialNumber must not be an empty string.


4.3.2-140 If a value is provided in the SerialNumberDetails element and the SerialNumberType provided is “VIN”, then the SerialNumber provided must be 17 characters in length, excluding white spaces.


4.3.2-150 If a value is provided in the SerialNumberDetails element and the value in the CollateralClassType is for a Collateral Class other than Motor Vehicle, then AdditionalVehicleDetails must not be provided.



UNCLASSIFIED


4.3.2-160 If a value is provided in the AdditionalVehicleDetails element, and the SerialNumberType is not Motor Vehicle Manufacturer’s Number, then a value must not be provided in the VehicleDescriptiveText.


4.3.2-170 If a value is provided in the AdditionalVehicleDetails element, the SerialNumberType is Motor Vehicle Manufacturer’s Number and a value has been provided in the VehicleRegistrationNumber element that is not an empty string, then a value must not be provided in the VehicleDescriptiveText that is not an empty string.


4.3.2-180 If a value is provided in the SerialNumberDetails element and the value in the CollateralClassType is for one of the Collateral Classes of Aircraft Engine, Airframe or Helicopter, then AdditionalAircraftDetails must be provided.


4.3.2-190 If a value is provided in the SerialNumberDetails element and the value in the CollateralClassType is for a Collateral Class other than Aircraft Engine, Airframe, Helicopter or Small Aircraft, then AdditionalAircraftDetails must not be provided.


4.3.2-200 If a value is provided in the AdditionalAircraftDetails element and: the CollateralClassType is Aircraft Engine and the SerialNumberType is Aircraft

Engine Manufacturer’s Number, or the CollateralClassType is Airframe and the SerialNumberType is Airframe

Manufacturer’s Number, or the CollateralClassType is Helicopter and the SerialNumberType is Helicopter

Manufacturer’s Numberthen a value must be provided for ManufacturersName and the value must not be an empty string.



UNCLASSIFIED


4.3.2-210 If a value is provided in the ManufacturerName element, then the CollateralClassType and SerialNumberType must be one of: the CollateralClassType is Aircraft Engine and the SerialNumberType is Aircraft



Manufacturer’s Number


4.3.2-220 If a value is provided in the AdditionalAircraftDetails element and: the CollateralClassType is Aircraft Engine and the SerialNumberType is Aircraft



Manufacturer’s Numberthen a value must be provided for ManufacturersModel and the value must not be an empty string.


4.3.2-230 If a value is provided in the ManufacturersModel element, then the CollateralClassType and SerialNumberType must be one of: the CollateralClassType is Aircraft Engine and the SerialNumberType is Aircraft






UNCLASSIFIED


4.3.2-240 If a value is provided in the AircraftNationality element, then the CollateralClassType and SerialNumberType must be one of: the CollateralClassType is Airframe and the SerialNumberType is Airframe


Manufacturer’s Number the CollateralClassType is Small Aircraft and the SerialNumberType is Aircraft

Nationality Code and Registration Mark


4.3.2-250 If a value is provided in the AircraftNationalityCodeAndRegistrationMark element, then the CollateralClassType and SerialNumberType must be one of: the CollateralClassType is Airframe and the SerialNumberType is Airframe




4.3.2-260 If a value is provided for CollateralDescription, then a free text description must be allowed for the registration.


4.3.2-270 If a free text description is mandatory for the registration, then a value must be provided for CollateralDescription and the value must not be an empty string.


4.3.2-280 If a value is provided for IsRegistrationEndTimeNotStated, then providing a “Not Stated” end time must be allowed for the registration.


4.3.2-290 If providing a “Not Stated” end time is allowed for the registration, then a value must be provided for IsRegistrationEndTimeNotStated.



UNCLASSIFIED


4.3.2-300 If a value is not allowed and is not provided for IsRegistrationEndTimeNotStated, then a value must be provided for RegistrationEndTime.


4.3.2-310 If a value is allowed and is provided for IsRegistrationEndTimeNotStated and the value is “false”, then a value must be provided for RegistrationEndTime.


4.3.2-320 If a value is allowed and is provided for IsRegistrationEndTimeNotStated and the value is “true”, then a value must not be provided for RegistrationEndTime.


4.3.2-330 If a value is provided for RegistrationEndTime, it must not be before the current date. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailCollateralRegistrationValidationErrorsError Number: 32122

4.3.2-340 If whether a registration is a PMSI is not relevant for the registration, then a value for IsPMSI must not be provided.


4.3.2-350 If whether a registration is a PMSI is relevant for the registration, the type of serial number, then a value for IsPMSI must be provided.


4.3.2-360 If whether collateral is inventory is not relevant for the registration, then a value for IsInventory must not be provided.



UNCLASSIFIED


4.3.2-370 If whether collateral is inventory is relevant for the registration, then a value for IsInventory must be provided.


4.3.2-380 If whether the collateral is an asset subject to control is not relevant for the registration, then a value for AreAssetsSubjectToControl must not be provided.


4.3.2-390 If whether the collateral is an asset subject to control is relevant for the registration, but is not relevant because asset subject to control is subject to the collateral being inventory and the value of IsInventory is “false”, then a value for AreAssetsSubjectToControl must not be provided.


4.3.2-400 If whether the collateral is an asset subject to control is relevant for the registration, and is also relevant because asset subject to control is subject to the collateral being inventory and the value of IsInventory is “true”, then a value for AreAssetsSubjectToControl must be provided.


4.3.2-410 If whether the collateral is an asset subject to control is relevant for the registration regardless of whether the collateral is inventory, then a value for AreAssetsSubjectToControl must be provided.


4.3.2-420 If whether proceeds are claimed is not relevant for the registration, then a value for AreProceedsClaimed must not be provided.


4.3.2-430 If whether proceeds are claimed is relevant for the registration, then a value for AreProceedsClaimed must be provided.



UNCLASSIFIED


4.3.2-440 If whether proceeds are claimed is not relevant for the registration, then a value for ProceedsClaimedDescription must not be provided.


4.3.2-450 If whether proceeds are claimed is relevant for the registration, and the value of AreProceedsClaimed is False, then a value for ProceedsClaimedDescription must not be provided.


4.3.2-460 If a value is provided for the Attachments element and at least one NewAttachment is provided, then attachments must be allowed for the registration.


4.3.2-471 The value provided for AttachmentId in a NewAttachment must exist in PPSR. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailCollateralRegistrationValidationErrorsError Number: 43029

4.3.2-480 If more than one NewAttachment is provided (across all NewCollateralRegistrations in the request message), then each NewAttachment must have a unique NewAttachmentSequenceNumber.

Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailAttachmentValidationErrors Error Number: 43012

4.3.2-490 If more than one NewAttachment is provided (across all NewCollateralRegistrations in the request message), then a NewAttachment must not have the same AttachmentId as another NewAttachment already provided.


4.3.2-500 The value provided for AttachmentId in a NewAttachment must be for an Attachment that has been uploaded to PPSR by this Account Customer.



UNCLASSIFIED


4.3.2-510 The value provided for AttachmentId in a NewAttachment must not be for an Attachment that has already been associated with an existing Registration (even if the existing Registration has expired, been discharged, removed or archived, or the Attachment has been removed from the existing Registration).


4.3.2-520 The number of NewAttachments for a single NewCollateralRegistrations must not exceed the maximum allowed number of Attachments for a Registration.


4.3.2-530 If a value is provided for the Grantors element and at least one Grantor is provided, then there must be at least one NewCollateralRegistration provided that allows a Grantor.

Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailApplicationValidationErrorsError Number: 32136

4.3.2-540 If a NewCollateralRegistration is provided that requires a Grantor, then at least one Grantor must be provided.

Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailRegistrationValidationErrorsError Number: 32027

4.3.2-550 If the value provided for CollateralType element is Consumer, then there must not be any Grantors with GrantorType that is not Individual.

Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailGrantorValidationErrorsError Number: 32132

4.3.2-560 The value provided for the GrantorType element must not be Unsupported. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailGrantorValidationErrorsError Number: 32016

4.3.2-570 If the value provided for the GrantorType element is Organisation, then a value must not be provided for the Individual element.



UNCLASSIFIED


4.3.2-580 If the value provided for the GrantorType element is Organisation, then a value must be provided for the Organisation element and a value must be provided for either OrganisationName or OrganisationNumber where the value is not an empty string.


4.3.2-590 If a value is provided for the Organisation element, then a value must not be provided for both OrganisationName and OrganisationNumber.

Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetail GrantorValidationErrorsError Number: 32121

4.3.2-600 If a value is provided for the OrganisationNumber element, then a value must also be provided for OrganisationNumberType.


4.3.2-610 If a value is not provided for the OrganisationNumber element, then a value must not be provided for OrganisationNumberType.


4.3.2-620 If a value is provided for the OrganisationNumberType element, the value must not be Unsupported.


4.3.2-631 If a value provided for OrganisationNumberType element is ABN, the value must be 11 digits.

Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailAddedGrantorValidationErrorsError Number: 33071

4.3.2-642 If a value provided for OrganisationNumberType element is ACN, ARSN or ARBN, the value must be 9 digits.



UNCLASSIFIED


4.3.2-650 If a value is provided for the OrganisationName element, then the value provided must only contain 7-bit ASCII characters (see section 6 Allowable Characters for Grantor Names for the list of allowable characters).


4.3.2-660 If the value provided for the GrantorType element is Individual, then a value must not be provided for the Organisation element.


4.3.2-670 If the value provided for the GrantorType element is Individual, then a value must be provided for the Individual element with values provided for both FamilyName and GivenNames that are not empty strings.


4.3.2-680 If the value provided for the GrantorType element is Individual, then the value provided for FamilyName must only contain 7-bit ASCII characters (see section 6 Allowable Characters for Grantor Names for the list of allowable characters).


4.3.2-690 If the value provided for the GrantorType element is Individual, then the value provided for GivenNames must only contain 7-bit ASCII characters (see section 6 Allowable Characters for Grantor Names for the list of allowable characters).


4.3.2-700 If a value is provided for the Individual element, and a value has been provided for DateOfBirth, then the value must not be later than the current date (as per Canberra time).


4.3.2-710 If a value is provided for the Individual element, and a value has been provided for DateOfBirth, then the calculated age (as per Canberra time) must not be more than 120 years old.



UNCLASSIFIED


4.3.2-720 If more than one Grantor is provided, then each Grantor must have a unique NewGrantorSequenceNumber.


4.3.2-730 If more than one Grantor is provided, then a Grantor must not be an exact replica (i.e. have all the same values) of another Grantor already provided.


4.3.2-740 Cannot create a registration for an inactive Secured Party group. Fault Detail Type: PpsrCollateralRegistrationAccessExceptionApplicationValidationErrorsError Number: 33073

4.3.2-750 There must be no validation errors from the request. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailError Number: 678

4.3.2-760 A grantor validation error. Violation details are provided in the error message. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailGrantorValidationErrorsError Number: 35108

4.3.2-770 A collateral validation error. Violation details are provided in the error message. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailCollateralRegistrationValidationErrorsError Number: 35108

4.3.2-780 A secured party validation error. Violation details are provided in the error message. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailApplicationValidationErrorsError Number: 35108


UNCLASSIFIED

4.3.3 Upload Registration Attachment

This operation is used to upload an Attachment to PPSR.

All Attachments that form part of a Registration must be uploaded to PPSR prior to creating or amending the Registration to include the Attachment.

When an attachment is uploaded, the file name of the attachment must be provided. An optional description of the attachment can also be provided.

When an Attachment is uploaded to PPSR, the Attachment will be checked for conformance with PPSR requirements for Attachments. This includes:

Checking the file for viruses and other malware.

Ensuring the file is a file type that can be accepted as an Attachment. The accepted file types are not specified in this document and they may change over time. B2G Account Customers will be advised of the accepted file types and any changes to the accepted file types.

Ensuring the file size is within the file size limit for Attachments. The file size limit is not specified in this document and it may change over time. B2G Account Customers will be advised of the file size limit and any changes to the file size limit.

When the Attachment has been checked and accepted by PPSR, the Attachment will be allocated a unique Attachment Id. The Attachment Id needs to be provided in the subsequent request to create or amend a Registration in order to add the Attachment to the Registration.

Each Attachment uploaded to PPSR can only be associated with one Registration. Once a Registration has been saved with a particular Attachment Id, the same Attachment Id cannot be used to save with another Registration, even if the existing Registration has expired or the Attachment has been removed from the existing Registration.


UNCLASSIFIED



Operation Name: UploadRegistrationAttachment

Request: UploadRegistrationAttachmentRequestMessage

Response: UploadRegistrationAttachmentResponseMessage


4.3.3.2.1 UploadRegistrationAttachmentRequestMessage

UploadRegistrationAttachmentRequestMessage


UploadRegistrationAttachmentRequestType


PropertiesAttachment : byte[]AttachmentDescription : stringAttachmentFileName : string

UploadRegistrationAttachmentRequest


UNCLASSIFIED


UploadRegistrationAttachmentRequestMessage

1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 UploadRegistrationAttachmentRequest



1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 AttachmentFileName string(255) The file name of the attachment.

1..1 Attachment byte[] The attachment file as a byte array.

0..1 AttachmentDescription string(250) An optional description of the attachment.

4.3.3.2.2 UploadRegistrationAttachmentResponseMessage

UploadRegistrationAttachmentResponseMessageClass

UploadRegistrationAttachmentResponseType


PropertiesAttachmentId : longPpsrTransactionId : long

UploadRegistrationAttachmentResponse


UploadRegistrationAttachmentResponseMessage

1..1 UploadRegistrationAttachmentResponse



1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


UNCLASSIFIED



1..1 AttachmentId long A unique identifier of the attachment allocated by PPSR to the attachment. The Attachment Id needs to be provided in the subsequent request to create or amend a Registration in order to add the Attachment to the Registration.


4.3.3.3.1 PpsrCollateralRegistrationUploadAttachmentFaultDetail

PpsrCollateralRegistrationUploadAttachmentFaultDetail


PropertiesAttachmentFileName : string


PpsrCollateralRegistrationUploadAttachmentFaultDetail


1..1 AttachmentFileName string(255) The file name of the attachment that resulted in the error.


UNCLASSIFIED



4.3.3-10 The UploadRegistrationAttachmentRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.3.3-20 The AttachmentFileName element must be provided. Fault Detail Type: PpsrCollateralRegistrationUploadAttachmentFaultDetailError Number: 43000

4.3.3-31 The value provided for AttachmentFileName must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationUploadAttachmentFaultDetailError Number: 43002

4.3.3-42 The value provided for AttachmentFileName must not be null. Fault Detail Type: PpsrCollateralRegistrationUploadAttachmentFaultDetailError Number: 43001

4.3.3-50 The value provided for AttachmentFileName must not contain any of the following characters:

< (less than) > (greater than) : (colon) " (double quote) / (forward slash) \ (backslash) | (vertical bar or pipe) ? (question mark) * (asterisk) . (period) as the first or last character any control character (e.g. tab)

Fault Detail Type: PpsrCollateralRegistrationUploadAttachmentFaultDetailError Number: 43015


UNCLASSIFIED


4.3.3-60 The Attachment file must not contain a virus or other malware. Fault Detail Type: PpsrCollateralRegistrationUploadAttachmentFaultDetailError Number: 43011

4.3.3-70 The file type of the Attachment file must be a file type that can be accepted by PPSR as an Attachment.


4.3.3-80 The file size of the Attachment file must not be greater than the maximum allowed file size.



UNCLASSIFIED

4.3.4 Retrieve Registration

This operation is used to retrieve the current version of a Registration. This allows the secured party to review the current information held in PPSR for the registration prior to performing some other action for the registration, such as amending or discharging the registration.

The Registration Number of the Registration needs to be provided in the request to identify the specific registration to be retrieved.

Access to retrieve the specific registration needs to be authorised. To authorise access, the request message must include either:

the Registration Token for the registration; or

the Secured Party Group Number of the Secured Party Group for the registration, and the Secured Party Group Access Code for the Secured Party Group.



Operation Name: RetrieveRegistration

Request: RetrieveRegistrationRequestMessage

Response: RetrieveRegistrationResponseMessage


UNCLASSIFIED


4.3.4.2.1 RetrieveRegistrationRequestMessage

RetrieveRegistrationRequestMessage


RetrieveRegistrationRequestType


PropertiesRegistrationNumber : stringRegistrationToken : stringSecuredPartyGroupAccessCode : stringSecuredPartyGroupNumber : string

RetrieveRegistrationRequest


RetrieveRegistrationRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RetrieveRegistrationRequest RetrieveRegistrationRequestType

RetrieveRegistrationRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 RegistrationNumber string(20) The Registration Number of the Registration to be retrieved.

0..1 RegistrationToken string(50) The Registration Token for the Registration to be retrieved.

0..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group for the Registration to be retrieved. Only provide the SecuredPartyGroupNumber if the RegistrationToken is not provided.

0..1 SecuredPartyGroupAccessCode string(50) The Secured Party Group Access Code for the Secured Party Group. Only provide the SecuredPartyGroupAccessCode if the RegistrationToken is


UNCLASSIFIED


not provided.


UNCLASSIFIED

4.3.4.2.2 RetrieveRegistrationResponseMessage


UNCLASSIFIED


UNCLASSIFIED

SerialisedCollateralDescriptionClass

PropertiesSerialNumber : string

AdditionalVehicleCollateralDescriptionClass


AdditionalAircraftCollateralDescriptionClass

PropertiesAircraftNationality : stringAircraftNationalityCodeAndRegistrationMark : stringManufacturersModel : stringManufacturersName : string

SerialNumberTypeEnum

UnsupportedUnknownMotorVehicleIdentifierVINChassisNumberMotorVehicleManufacturersNumberHINOfficialNumberAircraftEngineManufacturersNumberAirframeManufacturersNumberHelicopterManufacturersNumberAircraftNationalityCodeAndRegistrationMarkPatentNumberTradeMarkNumberDesignNumberPlantBreedersRightNumber

SerialNumberType

AdditionalVehicleDetails

AdditionalAircraftDetails


RetrieveRegistrationResponseMessage 1..1 RetrieveRegistrationResponse RetrieveRegistrationResponseType

RetrieveRegistrationResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


1..1 CollateralRegistration CollateralRegistration The Registration for the requested RegistrationNumber.

CollateralRegistration 1..1 RegistrationNumber string(20) The Registration Number of the registration.

1..1 ChangeNumber long The Change Number of the current version of the registration.

0..1 EarlierRegistrationNumber string(20) The Registration Number of an earlier registration where the earlier registration relates to the same security interest.

1..1 IsTransitional boolean Indicates if the registration is for an interest that existed prior to the registration commencement time of PPSR.

1..1 IsMigrated boolean Indicates if the registration was migrated from


UNCLASSIFIED


an existing register.

1..1 RegistrationStartTime dateTime The date and time the registration was first registered in PPSR.

0..1 IsRegistrationEndTimeNotStated boolean If “true”, identifies that the End Time for the registration has a value of “Not Stated”.If “false”, an End Time will be specified in the RegistrationEndTime.If not specified, the registration cannot have a “not Stated” End Time and an End Time will be specified in the RegistrationEndTime.

0..1 RegistrationEndTime dateTime The date and time that the registration will expire. Only provided if IsRegistrationEndTimeNotStated is “false” or not specified.

1..1 RegistrationChangeTime dateTime The date and time that the registration was last amended (or created if not amended).

1..1 SecuredPartyGroup CollateralRegistrationSecuredPartyGroup

The Secured Party Group for the registration.

0..* Grantors List< Grantor > The Grantors for the registration.

0..1 GivingOfNoticeIdentifier string(50) An optional identifier that a Secured Party Group has specified for the registration.

1..1 AddressForService AddressForService The Address for Service for the registration.

1..1 RegistrationKind string(200) The RegistrationKind of the registration. See section 2.2.9 Registration Kinds for details.

1..1 IsSecurityInterestRegistrationKind boolean Indicates whether the registration is for a security interest.If “true”, the Registration Kind is a security interest.If “false”, the Registration Kind is not a security interest.

1..1 CollateralType CollateralType The Collateral Type of the registration. See section 5.5 CollateralType for details.

1..1 CollateralClassType CollateralClassType The Collateral Class of the registration. See section 5.4 CollateralClassType for details.

0..1 SerialNumberDetails SerialisedCollateralDescription If the collateral in the registration is described by a serial number, the SerialNumberDetails


UNCLASSIFIED


element contains the details of the serial number.

0..1 CollateralDescription string(500) A free text description of the collateral.

0..1 IsPMSI ExtendedBooleanType Whether the registration is a purchase money security interest (PMSI).See section 5.6 ExtendedBooleanType.If not specified, whether the registration is a PMSI is not relevant.

0..1 IsInventory ExtendedBooleanType Whether the collateral is inventory. See section 5.6 ExtendedBooleanType.If not specified, whether the collateral is inventory is not relevant.

0..1 AreAssetsSubjectToControl ExtendedBooleanType Whether the collateral is an asset subject to control. See section 5.6 ExtendedBooleanType.If not specified, whether the collateral is an asset subject to control is not relevant.

0..1 AreProceedsClaimed ExtendedBooleanType Whether or not proceeds are claimed. See section 5.6 ExtendedBooleanType.If not specified, whether or not proceeds are claimed is not relevant.

0..1 ProceedsClaimedDescription string(500) A free text description of the proceeds claimed.

1..1 IsSubordinate boolean Whether the registration is subordinate to another security interest. A value of “true” indicates the registration is subordinate to another security interest. A value of “false” indicates that whether or not the registration is subordinate to another security interest is not stated.

0…* Attachments List<AttachmentDetail> If the registration has any attachments, the Attachments element contains details of the attachments.Note that this element does not contain the actual attachment file. The RetrieveRegistrationAttachment operation is used to retrieve the actual attachment file. See section 4.3.5 Retrieve Registration Attachment.


UNCLASSIFIED


0..1 MigrationDetail MigrationDetail If the registration is a migrated registration (IsMigrated will be “true”), this will contain further details that relate to migrated registrations.

0..1 RegistrarAlert string(2000) A message giving details of abnormal changes to the registration.

SerialisedCollateralDescription 1..1 SerialNumberType SerialNumberType The type of the serial number used to describe the collateral. See section 5.23 SerialNumberType for details.


0..1 AdditionalVehicleDetails AdditionalVehicleCollateralDescription If the collateral being described by serial number is for the Collateral Class of Motor Vehicle, the AdditionalVehicleDetails will be populated.If the collateral being described by serial number is for any other Collateral Class, the AdditionalVehicleDetails will be null.

0..1 AdditionalAircraftDetails AdditionalAircraftCollateralDescription If the collateral being described by serial number is for one of the following Collateral Classes: Aircraft Engine Airframe Helicopter Small Aircraftthe AdditionalAircraftDetails will be populated.If the collateral being described by serial number is for any other Collateral Class, the AdditionalAircraftDetails will be null.

AdditionalVehicleCollateralDescription 0..1 VehicleRegistrationNumber string(20) The registration plate number of the vehicle.

0..1 VehicleDescriptiveText string(500) If the type of serial number used to describe the collateral is a Motor Vehicle Manufacturer's Number, a free text description of the vehicle.

AdditionalAircraftCollateralDescription 0..1 ManufacturersName string(100) The name of the manufacturer.

0..1 ManufacturersModel string(50)



UNCLASSIFIED




CollateralRegistrationSecuredPartyGroup 1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group for the registration.

1..* SecuredParties List<CollateralRegistrationSecuredParty> The Secured Parties that make up the Secured Party Group.

1..1 IsActive boolean Whether the secured party group is active

CollateralRegistrationSecuredParty 1..1 SecuredPartyType SecuredPartyType Indicates whether the Secured Party is an organisation or an individual. See section 5.21 SecuredPartyType for details.

0..1 Organisation SecuredPartyOrganisation If the Secured Party is an organisation, the details of the organisation.

0..1 Individual SecuredPartyIndividual If the Secured Party is an individual, the details of the individual.

SecuredPartyOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details. There is a value for OrganisationNumberType only if the Secured Party is an organisation that is identified in PPSR by its organisation number.

0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.There is a value for OrganisationNumber only if the Secured Party is an organisation that is identified in PPSR by its organisation number.

0..1 OrganisationName string(250) The name of the organisation.If the Secured Party is an organisation that is identified in PPSR by its organisation name, this will be the name of the organisation specified when the Secured Party Group for the registration was created.If the Secured Party is an organisation that is identified in PPSR by its organisation number, this will be the name of the organisation retrieved from ASIC (for ACN, ARSN, ARBN) or ABR (for ABN) for the organisation number. If the organisation number does not exist in ASIC


UNCLASSIFIED


or ABR, or ASIC/ABR has not been successfully contacted yet to verify the organisation number, then the OrganisationName will display a value indicating the verification status of the organisation number.

SecuredPartyIndividual 1..1 FamilyName string(40) The family name of the Secured Party.

1..1 GivenNames string(80) The given names of the Secured Party.

Grantor 1..1 GrantorType GrantorType Indicates whether the Grantor is an organisation or an individual. See section 5.7 GrantorType for details.

0..1 Organisation GrantorOrganisation If the grantor is an organisation, the details of the organisation.

0..1 Individual GrantorIndividual If the grantor is an individual, the details of the individual.

GrantorOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.There is a value for OrganisationNumberType only if the Grantor is an organisation that is identified in PPSR by its organisation number.

0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.There is a value for OrganisationNumber only if the Grantor is an organisation that is identified in PPSR by its organisation number.

0..1 OrganisationName string(250) The name of the organisation. There is a value for OrganisationName only if the Grantor is an organisation that is identified in PPSR by its organisation name.

0..1 OrganisationNumberVerificationStatus

IdentifierVerificationStatusType Indicates whether ASIC/ABR was able to be contacted to verify the organisation number, and if ASIC/ABR was able to be contacted, indicates whether the organisation number was verified as valid by ASIC/ABR.See section 5.8 IdentifierVerificationStatusType for details.

GrantorIndividual 1..1 FamilyName string(40) The family name of the grantor.


UNCLASSIFIED


1..1 GivenNames string(80) The given names of the grantor.

0..1 DateOfBirth dateTime The date of birth of the grantor.

AddressForService 0..1 Addressee string(50) If an addressee has been specified in the Address for Service, this will be the addressee.If an addressee has not been specified in the Address for Service, this will be null.

0..1 B2GAccountCustomerNumber string(20) If a B2G address has been specified in the Address for Service, this will be the Account Customer Number of the B2G Account Customer whose B2G Mailbox will be used for notifications.If a B2G address has not been specified in the Address for Service, this will be null.

0..1 B2GAccountCustomerName string(250) If a B2G address has been specified in the Address for Service, this will be the name of the B2G Account Customer whose B2G Mailbox will be used for notifications.If a B2G address has not been specified in the Address for Service, this will be null.

0..1 EmailAddress string(250) If an email address has been specified in the Address for Service, this will be the email address.If an email address has not been specified in the Address for Service, this will be null.

0..1 FaxNumber string(20) If a fax number has been specified in the Address for Service, this will be the fax number.If a fax number has not been specified in the Address for Service, this will be null.

1..1 MailingAddress Address The postal mail address specified in the Address for Service.

0..1 PhysicalAddress Address If a physical address has been specified in the Address for Service, this will be the physical address.If a physical address has not been specified in the Address for Service, this will be null.

Address 0..1 ISO3166CountryCode string(2) The ISO 3166 country code of the country for the address.


UNCLASSIFIED


0..1 CountryName string(50) The name of the country specified by the ISO3166CountryCode.

1..1 Line1 string(50) The first line of the address.

0..1 Line2 string(50) The (optional) second line of the address.

0..1 Line3 string(50) The (optional) third line of the address.

0..1 Locality string(50) The suburb or town of the address.

0..1 Postcode string(10) The postcode of the address.

0..1 State string(20) The state/province of the address.

AttachmentDetail 1..1 AttachmentId long A unique identifier of the attachment in PPSR.

0..1 AttachmentDescription string(250) An optional description for the attachment.

1..1 AttachmentFileName string(255) The filename of the attachment.

1..1 AttachmentFileSizeBytes int The size of the Attachment in bytes.

1..1 IsMigratedAttachment boolean For registrations that were migrated from other registers prior to commencement of PPSR, an attachment may have been created when the Registration was migrated from its source register that contains additional data provided by the source register that is not supported by PPSR.IsMigratedAttachment indicates whether the attachment is such an attachment.Note that attachments that existed in source registers prior to migration to PPSR and have been brought across to PPSR are not migrated attachments and the value of IsMigratedAttachment will be “false”.

MigrationDetail 1..1 SourceRegister string(200) The name of the register the registration was migrated from.

0..1 OriginalStartDate dateTime(40) The original start date of the registration as recorded on the source register.Note that null value may be returned if there is non-conformant source data.


UNCLASSIFIED


4.3.4.3.1 PpsrCollateralRegistrationRetrieveFaultDetail

PpsrCollateralRegistrationRetrieveFaultDetail




PpsrCollateralRegistrationRetrieveFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 RegistrationNumber string(20) The Registration Number that resulted in the error.



4.3.4-10 The RetrieveRegistrationRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.3.4-20 The value provided for RegistrationNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationAccessFaultDetailError Number: 32144

4.3.4-30 The RegistrationNumber must be for an existing Registration. Fault Detail Type: PpsrCollateralRegistrationAccessFaultDetailError Number: 32005

4.3.4-40 If the RegistrationToken is provided, the SecuredPartyGroupNumber and SecuredPartyGroupAccessCode must not be provided.

Fault Detail Type: PpsrCollateralRegistrationAccessFaultDetailError Number: 32142


UNCLASSIFIED


4.3.4-50 If the RegistrationToken is not provided, the SecuredPartyGroupNumber must be provided and the value must not be an empty string.


4.3.4-60 If the RegistrationToken is not provided, the SecuredPartyGroupAccessCode must be provided and the value must not be an empty string.


4.3.4-70 If the RegistrationToken is provided, the RegistrationToken must be correct for the Registration.


4.3.4-80 If the SecuredPartyGroupNumber and SecuredPartyGroupAccessCode are provided, the SecuredPartyGroupNumber must be the correct SecuredPartyGroupNumber for the Registration and the SecuredPartyGroupAccessCode must be correct for the SecuredPartyGroupNumber.


4.3.4-90 The Registration must not be removed. Fault Detail Type: PpsrCollateralRegistrationRetrieveFaultDetailError Number: 32097

4.3.4-100 The Registration must not be expired/discharged. Fault Detail Type: PpsrCollateralRegistrationRetrieveFaultDetailError Number: 32098

4.3.4-110 The Registration must not be marked as “access is restricted”. Fault Detail Type: PpsrCollateralRegistrationRetrieveFaultDetailError Number: 32002

4.3.4-120 The Registration must not be archived. Fault Detail Type: PpsrCollateralRegistrationRetrieveFaultDetailError Number: 32096


UNCLASSIFIED

4.3.5 Retrieve Registration Attachment

This operation is used to retrieve an Attachment for a Registration.

This operation can be used in conjunction with the Retrieve Registration operation in order to retrieve the current version of a registration. This allows the secured party to review the current information held in PPSR for the registration prior to performing some other action for the registration, such as amending or discharging the registration.

Only Attachments that are associated with the current version of a Registration can be retrieved using this operation. Attachments that are only associated with previous versions of a Registration can be retrieved using the Collateral Registration Search Service.

Access to retrieve the specific Attachment needs to be authorised. The same authorisation used for the Retrieve Registration operation is also used for the Retrieve Registration Attachment operation.



Operation Name: RetrieveRegistrationAttachment

Request: RetrieveRegistrationAttachmentRequestMessage

Response: RetrieveRegistrationAttachmentResponseMessage


UNCLASSIFIED


4.3.5.2.1 RetrieveRegistrationAttachmentRequestMessage

RetrieveRegistrationAttachmentRequestMessage


RetrieveRegistrationAttachmentRequestType


PropertiesAttachmentId : longRegistrationNumber : stringRegistrationToken : stringSecuredPartyGroupAccessCode : stringSecuredPartyGroupNumber : string

RetrieveRegistrationAttachmentRequest


RetrieveRegistrationAttachmentRequestMessage


1..1 RetrieveRegistrationAttachmentRequest




1..1 AttachmentId long The Attachment Id of the Attachment to be retrieved.

1..1 RegistrationNumber string(20) The Registration Number of the Registration to which the Attachment belongs.

0..1 RegistrationToken string(50) The Registration Token for the Registration to


UNCLASSIFIED


which the Attachment belongs.

0..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group for the Registration to which the Attachment belongs. Only provide the SecuredPartyGroupNumber if the RegistrationToken is not provided.

0..1 SecuredPartyGroupAccessCode string(50) The Secured Party Group Access Code for the Secured Party Group. Only provide the SecuredPartyGroupAccessCode if the RegistrationToken is not provided.

4.3.5.2.2 RetrieveRegistrationAttachmentResponseMessage

RetrieveRegistrationAttachmentResponseMessageClass

RetrieveRegistrationAttachmentResponseType


PropertiesAttachment : byte[]AttachmentFileName : stringPpsrTransactionId : long

RetrieveRegistrationAttachmentResponse


RetrieveRegistrationAttachmentResponseMessage

1..1 RetrieveRegistrationAttachmentResponse



UNCLASSIFIED








4.3.5.3.1 PpsrCollateralRegistrationRetrieveAttachmentFaultDetail

PpsrCollateralRegistrationRetrieveAttachmentFaultDetail


PropertiesAttachmentId : longRegistrationNumber : string


PpsrCollateralRegistrationRetrieveAttachmentFaultDetail


1..1 AttachmentId long The Attachment Id that resulted in the error.



UNCLASSIFIED



4.3.5-10 The RetrieveRegistrationAttachmentRequestMessage element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005














UNCLASSIFIED


4.3.5-90 The Registration must not be removed. Fault Detail Type: PpsrCollateralRegistrationRetrieveAttachmentFaultDetailError Number: 32097

4.3.5-100 The Registration must not be expired/discharged. Fault Detail Type: PpsrCollateralRegistrationRetrieveAttachmentFaultDetailError Number: 32098

4.3.5-110 The Registration must not be marked as “access is restricted”. Fault Detail Type: PpsrCollateralRegistrationRetrieveAttachmentFaultDetailError Number: 32002

4.3.5-120 The Registration must not be archived. Fault Detail Type: PpsrCollateralRegistrationRetrieveAttachmentFaultDetailError Number: 32096

4.3.5-130 The AttachmentId must be for an Attachment that is associated with the current version of the Registration (i.e. the AttachmentId must not be for an Attachment that was previously associated the Registration but has since been removed from the Registration).

Fault Detail Type: PpsrCollateralRegistrationRetrieveAttachmentFaultDetailError Number: 43016


UNCLASSIFIED

4.3.6 Amend Registration

This operation is used to amend an existing Registration. Only current Registrations can be amended, that is, only Registrations that have not expired, been discharged or removed from PPSR. A current Registration that has been marked by the Registrar as “access is restricted” cannot be amended.

Not all attributes of a Registration can be amended. If an attribute that cannot be amended needs to be changed it will be necessary to create a new Registration with the required details and discharge the existing Registration. The schema of the request message for the Amend Registration operation does not include data elements for attributes of a Registration that cannot be amended.

The schema of the request message contains data elements for all attributes of a Registration that can be amended. However, not all attributes are relevant for all Registrations. Where an attribute for a specific Registration is not relevant, a value must not be provided in the data element for that attribute in the request message. Refer to the document “PPSR - 6.4.3.1 - Describing Collateral” for details of which attributes are relevant for specific Collateral Types and Collateral Classes.

Only values for attributes that are to be updated need to be provided in the corresponding data elements in the request message. For any data element that is missing or has a null value in the request message, the value of the corresponding attribute will be left unchanged. Data elements for attributes that are not being changed can optionally be provided.

If a new Attachment is to be added to a Registration, the Attachment must have been uploaded to PPSR using the Upload Registration Attachment operation before calling the Amend Registration operation. The Upload Registration Attachment operation will return an Attachment Id for the uploaded attachment. This Attachment Id is then included in the Amend Registration request message in order to add the Attachment to the Registration.

PPSR will validate the data provided in each call to the Amend Registration operation to ensure: that data is not provided when it is not relevant; and the provided data contains acceptable values. Whether particular data elements are relevant is not documented in this specification. PPSR provides separate documentation that defines the business rules regarding optional and mandatory data requirements for specific Collateral Types and Collateral Classes.

It is not possible to amend a Grantor for an existing Registration. If the details for a Grantor need to be changed it will be necessary to amend the Registration by removing the existing Grantor and adding another Grantor with the correct details.


UNCLASSIFIED

It is not possible to change the Secured Party Group for an existing Registration using the Amend Registration operation. The Transfer Single Collateral Registration operation or the Transfer All Collateral Registrations operation should be used to change the Secured Party Group for an existing Registration.

It is not possible to change the Address for Service for an existing Registration using the Amend Registration operation. The Address for Service must be changed for the Secured Party Group recorded for the Registration using the Update Secured Party Group operation of the Secured Party Group service, and this change will then be reflected on all Registrations for the Secured Party Group.

It is not possible to amend an Attachment for an existing Registration. If the details for an Attachment need to be changed it will be necessary to amend the Registration by removing the existing Attachment and adding another Attachment with the correct details.

Some Registrations that have been migrated from existing registers at the time of commencement for PPSR may have an unknown Collateral Type, Collateral Class or Motor Vehicle serial number type. It is not possible to amend these registrations. A new Registration will need to be created and the migrated Registration can be discharged. The EarlierRegistrationNumber attribute of the new Registration can be used to link the new Registration with the migrated Registration.



Operation Name: AmendRegistration

Request: AmendRegistrationRequestMessage

Response: AmendRegistrationResponseMessage


UNCLASSIFIED


4.3.6.2.1 AmendRegistrationRequestMessage

AmendRegistrationRequestMessage


AmendRegistrationRequestType


PropertiesChangeNumber : longRegistrationNumber : stringRegistrationToken : stringSecuredPartyGroupAccessCode : stringSecuredPartyGroupNumber : string

CollateralRegistrationAmendmentsClass

PropertiesCollateralDescription : stringGivingOfNoticeIdentifier : stringIsRegistrationEndTimeNotStated : bool?IsSubordinate : bool?ProceedsClaimedDescription : stringRegistrationEndTime : DateTime?

NewAttachmentClass

PropertiesAttachmentId : longNewAttachmentSequenceNumber : short

RemovedAttachmentClass

PropertiesAttachmentId : longRemovedAttachmentSequenceNumber : short

AdditionalVehicleCollateralDescriptionAmendmentsClass


AdditionalAircraftCollateralDescriptionAmendmentsClass

PropertiesAircraftNationality : stringAircraftNationalityCodeAndRegistrationMark : string

NewGrantorClass

PropertiesNewGrantorSequenceNumber : short

RemovedGrantorClass

PropertiesRemovedGrantorSequenceNumber : short

NewGrantorIndividualClass




GrantorIndividualClass

PropertiesDateOfBirth : DateTime?FamilyName : stringGivenNames : string

ExtendedBooleanTypeEnum

UnsupportedTrueFalseUnknown

GrantorTypeEnum




AmendRegistrationRequest

CollateralRegistrationAmendments

AreProceedsClaimed

AdditionalAircraftDetails

AdditionalVehicleDetails

GrantorsToAdd : List<NewGrantor> GrantorsToRemove : List<RemovedGrantor>

AttachmentIdsToAdd : List<NewAttachment>

AttachmentIdsToRemove : List<RemovedAttachment>

GrantorType


GrantorType

Organisation

Individual



UNCLASSIFIED


AmendRegistrationRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 AmendRegistrationRequest AmendRegistrationRequestType

AmendRegistrationRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 RegistrationNumber string(20) The Registration Number of the Registration to be amended.

0..1 RegistrationToken string(50) The Registration Token for the Registration to be amended.

0..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group for the Registration to be amended. Only provide the SecuredPartyGroupNumber if the RegistrationToken is not provided.


1..1 ChangeNumber long The Change Number of the current version of the registration.This is used to prevent concurrent updates in case more than one user (over all channels) is attempting to update the same Registration at the same time.

1..1 CollateralRegistrationAmendments CollateralRegistrationAmendments The details of the Registration to be amended.

CollateralRegistrationAmendments 0..1 IsRegistrationEndTimeNotStated boolean Indicates whether the Registration has a “Stated” or “Not Stated” End Time,Only needs to be provided if the End Time for the registration is being changed from a “Stated” End Time to a “Not Stated” End Time, or from a “Not Stated” End Time to a “Stated” End Time.Can optionally be provided if the End Time is not being changed or if the End Time is being changed from one “Stated” End Time to another “Stated” End Time.If the registration currently has a “Not Stated” End Time and this is now being changed to a “Stated” End Time, then a value must be specified in the RegistrationEndTime element.

0..1 RegistrationEndTime dateTime The date and time that the Registration will expire.


UNCLASSIFIED


Only needs to be provided if the registration currently has a “Stated” End Time and the End Time is being changed, or if the registration currently has a “Not Stated” End Time and this is now being changed to a “Stated” End Time.If a RegistrationEndTime is provided and the value exceeds the maximum End Time allowed, it will not generate an error. The message will still be accepted and the End Time will set to 23:59:59 on the date of the maximum allowed End Time for the registration.

0..1 GivingOfNoticeIdentifier string(50) An optional identifier that a Secured Party can specify for the Registration.Only needs to be provided if the value is to be amended. Providing a value that is an empty string will clear the current value so that there is no identifier recorded for the registration.

0..1 CollateralDescription string(500) A free text description of the collateral.Only needs to be provided if the value is to be amended. Providing a value that is an empty string will clear the current value so that there is no text description recorded for the registration.

0..1 AreProceedsClaimed ExtendedBooleanType Whether or not proceeds are claimed. Only needs to be provided if the value is to be amended. The value cannot be changed to “Unknown” – if “Unknown” is provided, the value for the registration must currently be “Unknown”.If the value is being changed from “True” to “False”, the current value recorded for ProceedsClaimedDescription for the registration will be cleared. Do not provide a value for ProceedsClaimedDescription in the request message.See section 5.6 ExtendedBooleanType.

0..1 ProceedsClaimedDescription string(500) A free text description of the proceeds claimed.Only needs to be provided if the value is to be amended, or if the value of AreProceedsClaimed is being changed from “Unknown” or “False” to “True”.Providing a value that is an empty string will update the description of proceeds claimed recorded for the registration to the default value “All present and after


UNCLASSIFIED


acquired property”.Not providing a value when the value of AreProceedsClaimed is being changed from “Unknown” or “False” to “True” will update the description of proceeds claimed recorded for the registration to the default value “All present and after acquired property”.

0..1 IsSubordinate boolean Whether the registration is subordinate to another security interest.Only needs to be provided if the value is to be amended.A value of “true” indicates the registration is subordinate to another security interest. A value of “false” indicates that whether or not the registration is subordinate to another security interest is not stated.

0..1 AdditionalVehicleDetails AdditionalVehicleCollateralDescriptionAmendments

Only needs to be provided if the Collateral Class of the registration is Motor Vehicle, the collateral in the registration is described by serial number and any of the additional vehicle details are to be amended.

0..1 AdditionalAircraftDetails AdditionalAircraftCollateralDescriptionAmendments

Only needs to be provided if the Collateral Class of the registration is Aircraft Engine, Airframe, Helicopter or Small Aircraft, the collateral in the registration is described by serial number and any of the additional aircraft details are to be amended.

0..* AttachmentsToAdd List<NewAttachment> A list of Attachments (if any) to be added to the registration.Attachments are not allowed for all registrations. Whether attachments are allowed is described in the document “PPSR - 6.4.3.1 - Describing Collateral”.Attachments must only be provided if attachments are allowed for the registration.

0..* AttachmentsToRemove List<RemovedAttachment> A list of Attachments (if any) to be removed from the registration.

0..* GrantorsToAdd List<NewGrantor> Zero, one or more grantors to be added to the registration.Only provide NewGrantors if there is at least one grantor to be added, and the Registration allows a grantor.Do not provide any NewGrantors if no grantors are to be added to the existing Registration.


UNCLASSIFIED


0..* GrantorsToRemove List<RemovedGrantor> Zero, one or more grantors to be removed from the registration.Only provide RemovedGrantors if there is at least one grantor to be removed.Do not provide any RemovedGrantors if no grantors are to be removed from the existing Registration.All details of each grantor in this list must exactly match (not case sensitive) the details of an existing grantor within the Registration.If it is mandatory for the Registration to have a Grantor recorded and the list of Grantors to be removed included all Grantors currently recorded for the registration, then there must be at least one NewGrantor provided.

AdditionalVehicleCollateralDescriptionAmendments

0..1 VehicleRegistrationNumber string(20) The optional registration plate number of the vehicle.Only needs to be provided if the value is to be amended. Providing a value that is an empty string will clear the current value so that there is no registration plate number recorded for the registration.

0..1 VehicleDescriptiveText string(500) If the type of serial number used to describe the collateral is a Motor Vehicle Manufacturer's Number, an optional free text description of the vehicle. However, the VehicleDescriptiveText must not be provided if a value has been provided for VehicleRegistrationNumber.Only needs to be provided if the value is to be amended. Providing a value that is an empty string will clear the current value so that there is free text description of the vehicle recorded for the registration.

AdditionalAircraftCollateralDescriptionAmendments

0..1 AircraftNationality string(50) The optional aircraft nationality.Only needs to be provided if the value is to be amended. Providing a value that is an empty string will clear the current value so that there is no aircraft nationality recorded for the registration.


string(100) The optional nationality and registration marks assigned pursuant to the Chicago Convention.Only needs to be provided if the value is to be amended. Providing a value that is an empty string will clear the current value so that there are no


UNCLASSIFIED


registration marks recorded for the registration.Note that the nationality and registration marks can only be amended when they are recorded as additional aircraft details, and not when they are recorded as the serial number of the collateral.

NewAttachment 1..1 NewAttachmentSequenceNumber short A unique sequence number must be provided for each attachment being added in order to uniquely identify the attachment when there is more than one attachment being added in the request.The first NewAttachment in a request message should have a NewAttachmentSequenceNumber value of 1; the second NewAttachment in a request message should have a NewAttachmentSequenceNumber value of 2, and so on.This number will be used to associate business rule violations (if any) with a particular attachment. In the SOAP fault, the fault detail will include the NewAttachmentSequenceNumber value for any violations related to the NewAttachment.This number is not stored in PPSR as part of the Registration record.

1..1 AttachmentId long The Attachment Id for the attachment to be added to the registration.The Attachment Id must be for an attachment that has already been uploaded to PPSR using the Upload Registration Attachment operation (see 4.3.3 Upload Registration Attachment).The Attachment Id must not have already been used for another registration, or been used previously on this registration.

RemovedAttachment 1..1 RemovedAttachmentSequenceNumber short A unique sequence number must be provided for each attachment being removed in order to uniquely identify the attachment when there is more than one attachment being removed in the request.The first RemovedAttachment in a request message should have a RemovedAttachmentSequenceNumber value of 1; the second RemovedAttachment in a request message should have a RemovedAttachmentSequenceNumber value of 2, and so on.


UNCLASSIFIED


This number will be used to associate business rule violations (if any) with a particular attachment. In the SOAP fault, the fault detail will include the RemovedAttachmentSequenceNumber value for any violations related to the RemovedAttachment.

1..1 AttachmentId long The Attachment Id for the attachment to be removed from the registration.The Attachment Id must be for an attachment that exists on the current version of the registration.The Attachment Id must not be for an attachment that is a migrated attachment (i.e. an attachment for a migrated registration that was created when the registration was migrated from its source register that contains additional data provided by the source register that is not supported by PPSR).

NewGrantor 1..1 NewGrantorSequenceNumber short A unique sequence number must be provided for each new grantor in order to uniquely identify the grantor in the request when there is more than one new grantor in the request.The first NewGrantor in a request message should have a NewGrantorSequenceNumber value of 1; the second NewGrantor in a request message should have a NewGrantorSequenceNumber value of 2, and so on.This number will be used to associate business rule violations (if any) with a particular grantor. In the SOAP fault, the fault detail will include the NewGrantorSequenceNumber value for any violations related to the NewGrantor.This number is not stored in PPSR as part of the Registration record.

1..1 GrantorType GrantorType Indicates whether the Grantor is an organisation or an individual. See section 5.7 GrantorType for details.If the CollateralType is Consumer, then only grantors who are individuals can be provided.

0..1 Organisation GrantorOrganisation If the grantor is an organisation, a value for Organisation must be provided.If the grantor is not an organisation, a value for Organisation must not be provided.


UNCLASSIFIED


0..1 Individual NewGrantorIndividual If the grantor is an individual, a value for Individual must be provided.If the grantor is not an individual, a value for Individual must not be provided.

RemovedGrantor 1..1 RemovedGrantorSequenceNumber short A unique sequence number must be provided for each grantor to be removed in order to uniquely identify the grantor in the request when there is more than one grantor to be removed in the request.The first RemovedGrantor in a request message should have a RemovedGrantorSequenceNumber value of 1; the second RemovedGrantor in a request message should have a RemovedGrantorSequenceNumber value of 2, and so on.This number will be used to associate business rule violations (if any) with a particular grantor. In the SOAP fault, the fault detail will include the RemovedGrantorSequenceNumber value for any violations related to the RemovedGrantor.This number is not stored in PPSR as part of the Registration record.

1..1 GrantorType GrantorType Indicates whether the Grantor to be removed is an organisation or an individual. See section 5.7 GrantorType for details.

0..1 Organisation GrantorOrganisation If the grantor to be removed is an organisation, a value for Organisation must be provided.If the grantor to be removed is not an organisation, a value for Organisation must not be provided.

0..1 Individual GrantorIndividual If the grantor to be removed is an individual, a value for Individual must be provided.If the grantor to be removed is not an individual, a value for Individual must not be provided.

GrantorOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.Only provide a value for OrganisationNumberType if the grantor is an organisation that will be identified in PPSR by its organisation number.If a value is provided for OrganisationNumberType then a value must also be provided for


UNCLASSIFIED


OrganisationNumber and a value must not be provided for OrganisationName.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumberType.

0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.Only provide a value for OrganisationNumber if the grantor is an organisation that will be identified in PPSR by its organisation number.If a value is provided for OrganisationNumber then a value must also be provided for OrganisationNumberType and a value must not be provided for OrganisationName.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumber.

0..1 OrganisationName string(250) The name of the organisation.Only provide a value for OrganisationName if the grantor is an organisation that will not be identified in PPSR by an organisation number.If a value is provided for OrganisationName then a value must not be provided for OrganisationNumberType or OrganisationNumber.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumberType and OrganisationNumber.When adding a new Grantor, the value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

GrantorIndividual 1..1 FamilyName string(40) The family name of the grantor.

1..1 GivenNames string(80) The given names of the grantor.

0..1 DateOfBirth dateTime The date of birth of the grantor. If the Grantor to be removed does not have a date of birth recorded (possible for migrated registrations), do not provide a value for DateOfBirth.Note: A time should not be specified. However, if a time component is specified it is ignored by PPSR.

NewGrantorIndividual 1..1 FamilyName string(40) The family name of the grantor.


UNCLASSIFIED


The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

1..1 GivenNames string(80) The given names of the grantor.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

1..1 DateOfBirth dateTime The date of birth of the grantor.Note: A time should not be specified. However, if a time component is specified it is ignored by PPSR.

4.3.6.2.2 AmendRegistrationResponseMessage

AmendRegistrationResponseMessageClass

AmendRegistrationResponseType


PropertiesChangeNumber : longIsRegistrationEndTimeChanged : boolPpsrTransactionId : longRegistrationChangeTime : DateTimeRegistrationEndTime : DateTime?RegistrationNumber : string

AmendRegistrationResponse


UNCLASSIFIED


AmendRegistrationResponseMessage 1..1 AmendRegistrationResponse AmendRegistrationResponseType

AmendRegistrationResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 RegistrationNumber string(20) The Registration Number of the Collateral that was amended.

1..1 ChangeNumber long The new Change Number assigned by PPSR to the amended version of the Registration.


1..1 RegistrationChangeTime dateTime

0..1 RegistrationEndTime dateTime The date and time that the registration will expire.

1..1 IsRegistrationEndTimeChanged boolean Indicates whether the RegistrationEndTime was changed by PPSR from the value provided in the request message while amending the registration.This can occur in the following cases: If the value for RegistrationEndTime in the

request message is greater than the maximum end time allowed for this combination of Collateral Type, Collateral Class and whether the collateral is described by a serial number, the time component will be set to 23:59:59 on the date of the maximum allowed End Time for the registration.

If the value for RegistrationEndTime in the request message is provided and has a time component that is not 23:59:59, the time component will be set to 23:59:59.


UNCLASSIFIED


4.3.6.3.1 PpsrCollateralRegistrationAmendFaultDetail

PpsrCollateralRegistrationAmendFaultDetail




PpsrCollateralRegistrationAmendFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.



UNCLASSIFIED

4.3.6.3.2 PpsrCollateralRegistrationAmendValidationFaultDetail

PpsrCollateralRegistrationAmendValidationFaultDetail






PropertiesErrorMessage : stringErrorNumber : stringAddedGrantorValidationErrors : List<PpsrValidationErrorGroup>

RemovedGrantorValidationErrors : List<PpsrValidationErrorGroup>

AddedAttachmentValidationErrors : List<PpsrValidationErrorGroup>

RemovedAttachmentValidationErrors : List<PpsrValidationErrorGroup>

ValidationErrors : List<PpsrValidationError>

CollateralRegistrationValidationErrors : List<PpsrValidationError>


PpsrCollateralRegistrationAmendValidationFaultDetail


1..1 RegistrationNumber string(20) The Registration Number of the Registration being amended.

0..1 CollateralRegistrationValidationErrors List<PpsrValidationError> A list of validation errors related to amendments in the request message other than adding or removing Grantors.

0..1 AddedAttachmentValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data in the request message for attachments to be added.

0..1 RemovedAttachmentValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data in the request message for attachments to be removed.

0..1 AddedGrantorValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data in the request message for grantors to be added.

0..1 RemovedGrantorValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data in the request message for grantors to be removed.


UNCLASSIFIED


PpsrValidationErrorGroup 1..1 SequenceNumber short Identifies the sequence number of the element in the request message for which validation errors have occurred. For example, if the PpsrValidationErrorGroup is for validation errors associated with a Grantor to be added, the value of SequenceNumber will be the value of the NewGrantorSequenceNumber of the NewGrantor in the request message.





Many business rule violations will be returned as a SOAP Fault where the content of the SOAP fault detail element is PpsrCollateralRegistrationAmendValidationFaultDetail and the value of the ErrorNumber is 679. The PpsrCollateralRegistrationAmendValidationFaultDetail allows multiple business rule violations to be reported. In the following table, the value in the SOAP Fault column indicates which group of errors in the PpsrCollateralRegistrationAmendValidationFaultDetail that a violation of the business rule will be reported in (CollateralRegistrationValidationErrors, AddedAttachmentValidationErrors, RemovedAttachmentValidationErrors, AddedGrantorValidationErrors or RemovedGrantorValidationErrors), as well as the value of the ErrorNumber for the business rule that has been violated.


4.3.6-10 The AmendRegistrationRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.3.6-20 The value provided for the RegistrationNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationAccessFaultDetailError Number: 32144


UNCLASSIFIED



4.3.6-41 The RegistrationNumber should not belong to a migrated Secured Party Group. Fault Detail Type: PpsrCollateralRegistrationAccessFaultDetailError Number: 32200







4.3.6-81 If the RegistrationToken is not provided, the SecuredPartyGroupNumber must be provided and the value must not be migrated Secured Party Group.






4.3.6-110 The ChangeNumber provided must be the current ChangeNumber for the Registration. Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32094

4.3.6-120 The Registration must not be removed. Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32097

4.3.6-130 The Registration must not be expired/discharged. Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32098

4.3.6-140 The Registration must not be marked as “access is restricted”. Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32002


UNCLASSIFIED


4.3.6-150 The Registration must not be archived. Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32096

4.3.6-160 The Collateral Type of the Registration must not be “Unknown”. Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32149

4.3.6-170 The Collateral Class of the Registration must not be “Unknown”. Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32150

4.3.6-180 If the Registration is for a motor vehicle that is described by a serial number, the Serial Number Type must not be “Unknown Motor Vehicle Identifier”.

Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32166

4.3.6-190 A value must be provided for CollateralRegistrationAmendments. Fault Detail Type: PpsrCollateralRegistrationAmendFaultDetailError Number: 32009

4.3.6-200 If a value is provided for AdditionalVehicleDetails then the Collateral Class of the Registration must be Motor Vehicle and the collateral in the Registration must be described by a serial number.

Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetailCollateralRegistrationValidationErrorsError Number: 32137

4.3.6-210 If a value is provided for AdditionalVehicleDetails, and the SerialNumberType recorded for the Registration is not Motor Vehicle Manufacturer’s Number, then a value must not be provided in the VehicleDescriptiveText.


4.3.6-220 If a value is provided for AdditionalVehicleDetails, and the SerialNumberType recorded for the Registration is Motor Vehicle Manufacturer’s Number, and a value is provided in VehicleRegistrationNumber that is not an empty string, and a value currently exists in VehicleDescriptiveText for the Registration, then a value must be provided in VehicleDescriptiveText that is an empty string.


4.3.6-230 If a value is provided for AdditionalVehicleDetails, and the SerialNumberType recorded for the Registration is Motor Vehicle Manufacturer’s Number, and a value is provided in VehicleDescriptiveText that is not an empty string, and a value currently exists in VehicleRegistrationNumber for the Registration, then a value must be provided in VehicleRegistrationNumber that is an empty string.



UNCLASSIFIED


4.3.6-240 If a value is provided for AdditionalVehicleDetails, and the SerialNumberType recorded for the Registration is Motor Vehicle Manufacturer’s Number, and no values currently exist in VehicleRegistrationNumber and VehicleDescriptiveText for the Registration, then values must not be provided in both VehicleRegistrationNumber and VehicleDescriptiveText that are not empty strings.


4.3.6-250 If a value is provided for AdditionalAircraftDetails then the Collateral Class of the Registration must be Airframe, Helicopter or Small Aircraft, and the collateral in the registration must be described by a serial number.


4.3.6-260 If a value is provided for AircraftNationality, then the Collateral Class of the Registration and Serial Number Type must be one of: the Collateral Class is Airframe and the Serial Number Type is Airframe

Manufacturer’s Number, or the Collateral Class is Helicopter and the Serial Number Type is Helicopter

Manufacturer’s Number the Collateral Class is Small Aircraft and the Serial Number Type is Aircraft

Nationality Code and Registration Mark


4.3.6-270 If a value is provided in the RegistrationMarks element, then the Collateral Class of the Registration and Serial Number Type must be one of: the Collateral Class is Airframe and the Serial Number Type is Airframe

Manufacturer’s Number, or the Collateral Class is Helicopter and the Serial Number Type is Helicopter



4.3.6-280 If a value is provided for CollateralDescription, then a free text description must be allowed for the Registration.


4.3.6-290 If a value is provided for CollateralDescription and the value is an empty string, then a free text description must not be mandatory for the Registration.



UNCLASSIFIED


4.3.6-300 If a value is provided for IsRegistrationEndTimeNotStated, then providing a “Not Stated” end time must be allowed for the Registration.


4.3.6-310 If a value is provided for IsRegistrationEndTimeNotStated and the value is “true”, or a value is not provided for IsRegistrationEndTimeNotStated and the current value for the Registration is “true”, then a value must not be provided for RegistrationEndTime.

Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetail CollateralRegistrationValidationErrorsError Number: 32033

4.3.6-320 If a value is provided for IsRegistrationEndTimeNotStated and the value is “false”, and there is no current value of the RegistrationEndTime for the Registration, then a value must be provided for RegistrationEndTime.


4.3.6-330 If a value is provided for RegistrationEndTime, it must not be before the current date. Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetailCollateralRegistrationValidationErrorsError Number: 32122

4.3.6-340 If a value is provided for AreProceedsClaimed, then whether proceeds are claimed must be relevant for the Collateral Registration.


4.3.6-350 If a value is provided for AreProceedsClaimed, then the value must not be “Unsupported”.


4.3.6-360 If a value is provided for AreProceedsClaimed and the value is “Unknown”, then the current value of AreProceedsClaimed for the Registration must be “Unknown”.



UNCLASSIFIED


4.3.6-370 If a value is provided for ProceedsClaimedDescription, then whether proceeds are claimed must be relevant for the Registration.


4.3.6-380 If a value is provided for AreProceedsClaimed and the value is “False” or “Unknown”, then a value for ProceedsClaimedDescription must not be provided.


4.3.6-390 If a value is provided for the AttachmentsToAdd element and at least one NewAttachment is provided, then attachments must be allowed for the Registration.


4.3.6-371 The value provided for AttachmentId in a NewAttachment must exist in PPSR. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailCollateralRegistrationValidationErrorsError Number: 925

4.3.6-400 If more than one NewAttachment is provided, then each NewAttachment must have a unique NewAttachmentSequenceNumber.

Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetailAddedAttachmentValidationErrors Error Number: 43018

4.3.6-410 If more than one NewAttachment is provided, then a NewAttachment must not have the same AttachmentId as another NewAttachment already provided.


4.3.6-420 The value provided for AttachmentId in a NewAttachment must be for an Attachment that has been uploaded to PPSR by this Account Customer.



UNCLASSIFIED


4.3.6-430 The value provided for AttachmentId in a NewAttachment must not be for an Attachment that has already been associated with an existing Registration (even if the existing Registration has expired, been discharged, removed or archived, or the Attachment has been removed from the existing Registration).


4.3.6-440 If more than one RemovedAttachment is provided, then each RemovedAttachment must have a unique RemovedAttachmentSequenceNumber.

Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetailRemovedAttachmentValidationErrors Error Number: 43020

4.3.6-450 If more than one RemovedAttachment is provided, then a RemovedAttachment must not have the same AttachmentId as another RemovedAttachment already provided.


4.3.6-460 The value provided for AttachmentId in a RemovedAttachment must be for an Attachment that is associated with the current version of the Registration.


4.3.6-470 The value provided for AttachmentId in a RemovedAttachment must not be for an Attachment that is a migrated attachment.


4.3.6-480 The total of: the number of current attachments already on the registration plus the number of NewAttachments less the number of RemovedAttachments

must not exceed the maximum allowed number of Attachments for a Registration.


4.3.6-490 If a value is provided for GrantorsToAdd and at least one NewGrantor is provided, then a Grantor must be allowed for the Registration.



UNCLASSIFIED


4.3.6-500 If the value of Collateral Type for the Registration is Consumer, then there must not be any NewGrantors in GrantorsToAdd with GrantorType that is not Individual.

Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetailAddedGrantorValidationErrorsError Number: 32132

4.3.6-510 The value provided for GrantorType in a NewGrantor must not be Unsupported. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailAddedGrantorValidationErrorsError Number: 32016

4.3.6-520 If the value provided for GrantorType in a NewGrantor is Organisation, then a value must not be provided for Individual.


4.3.6-530 If the value provided for GrantorType in a NewGrantor is Organisation, then a value must be provided for Organisation and a value must be provided for either OrganisationName or OrganisationNumber where the value is not an empty string.


4.3.6-540 If a value is provided for Organisation in a NewGrantor, then a value must not be provided for both OrganisationName and OrganisationNumber.


4.3.6-550 If a value is provided for OrganisationNumber in a NewGrantor, then a value must also be provided for OrganisationNumberType.


4.3.6-560 If a value is not provided for OrganisationNumber in a NewGrantor, then a value must not be provided for OrganisationNumberType.



UNCLASSIFIED


4.3.6-570 If a value is provided for OrganisationNumberType in a NewGrantor, the value must not be Unsupported.


4.3.6-581 If a value provided for OrganisationNumber in a NewGrantor is ABN, the value must be 11 digits.


4.3.6-592 If a value provided for OrganisationNumber in a NewGrantor is ACN, ARSN or ARBN, the value must be 9 digits.


4.3.6-600 If a value is provided for OrganisationName in a NewGrantor, then the value provided must only contain 7-bit ASCII characters (see section 6 Allowable Characters for Grantor Names for the list of allowable characters).


4.3.6-610 If the value provided for GrantorType in a NewGrantor is Individual, then a value must not be provided for the Organisation element.


4.3.6-620 If the value provided for GrantorType in a NewGrantor is Individual, then a value must be provided for the Individual element with values provided for both FamilyName and GivenNames that are not empty strings.


4.3.6-630 If the value provided for GrantorType in a NewGrantor is Individual, then the value provided for FamilyName must only contain 7-bit ASCII characters (see section 6 Allowable Characters for Grantor Names for the list of allowable characters).



UNCLASSIFIED


4.3.6-640 If the value provided for GrantorType in a NewGrantor is Individual, then the value provided for GivenNames must only contain 7-bit ASCII characters (see section 6 Allowable Characters for Grantor Names for the list of allowable characters).


4.3.6-650 If a value is provided for Individual in a NewGrantor, and a value has been provided for DateOfBirth, then the value must not be later than the current date (as per Canberra time).


4.3.6-660 If a value is provided for Individual in a NewGrantor, and a value has been provided for DateOfBirth, then the calculated age (as per Canberra time) must not be more than 120 years old.


4.3.6-670 If more than one NewGrantor is provided, then each NewGrantor must have a unique NewGrantorSequenceNumber.


4.3.6-680 If more than one NewGrantor is provided, then a NewGrantor must not be an exact replica (i.e. have all the same values) of another NewGrantor in the request message.


4.3.6-690 If any NewGrantors are provided, then a NewGrantor must not be an exact replica (i.e. have all the same values) of an existing Grantor recorded for the Registration.


4.3.6-700 If more than one RemovedGrantor is provided, then each RemovedGrantor must have a unique RemovedGrantorSequenceNumber.

Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetailRemovedGrantorValidationErrorsError Number: 32148


UNCLASSIFIED


4.3.6-710 The value provided for GrantorType in a RemovedGrantor must not be Unsupported. Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailRemovedGrantorValidationErrorsError Number: 32016

4.3.6-720 If the value provided for GrantorType in a RemovedGrantor is Organisation, then a value must not be provided for Individual.


4.3.6-730 If the value provided for GrantorType in a RemovedGrantor is Organisation, then a value must be provided for Organisation and a value must be provided for either OrganisationName or OrganisationNumber where the value is not an empty string.


4.3.6-740 If a value is provided for Organisation in a RemovedGrantor, then a value must not be provided for both OrganisationName and OrganisationNumber.


4.3.6-750 If a value is provided for OrganisationNumber in a RemovedGrantor, then a value must also be provided for OrganisationNumberType.


4.3.6-760 If a value is not provided for OrganisationNumber in a RemovedGrantor, then a value must not be provided for OrganisationNumberType.


4.3.6-770 If a value is provided for OrganisationNumberType in a RemovedGrantor, the value must not be Unsupported.

Fault Detail Type: PpsrCollateralRegistrationCreateValidationFaultDetailRemovedGrantorValidationErrorsError Number: 32017


UNCLASSIFIED


4.3.6-780 If the value provided for GrantorType in a RemovedGrantor is Individual, then a value must not be provided for the Organisation element.


4.3.6-790 If the value provided for GrantorType in a RemovedGrantor is Individual, then a value must be provided for the Individual element with values provided for both FamilyName and GivenNames that are not empty strings.


4.3.6-800 If more than one RemovedGrantor is provided, then a RemovedGrantor must not be an exact replica (i.e. have all the same values) of another RemovedGrantor in the request message.


4.3.6-810 If any RemovedGrantors are provided, then a RemovedGrantor must be an exact match (i.e. have all the same values) of an existing Grantor recorded for the Registration.


4.3.6-820 If a Grantor is mandatory for the Registration, then after all RemovedGrantors have been removed and all NewGrantors have been added, there must be at least one Grantor for the Registration.


4.3.6-830 Cannot amend a registration for an inactive Secured Party group. Fault Detail Type: PpsrCollateralRegistrationAccessExceptionError Number: 33077

4.3.6-840 There must be no validation errors from the request. Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetailError Number: 679

4.3.6-850 A grantor validation error. Violation details are provided in the error message. Fault Detail Type: PpsrCollateralRegistrationAmendValidationFaultDetailAddedGrantorValidationErrorsError Number: 35108


UNCLASSIFIED

4.3.7 Discharge Registration

This operation is used to immediately expire (i.e. discharge) an existing Registration. Only current Registrations can be discharged, that is, only Registrations that have not already expired or been removed from PPSR. To discharge a current Registration that has been marked by the Registrar as “access is restricted”, the Registrar must be contacted to arrange for the Registration to be discharged by the Registrar.

PPSR will discharge the Registration by setting the end time of the Registration to the current date and time.

Once a Registration has been discharged, it cannot be retrieved, amended, transferred, or discharged again.

While migrated Registrations that have an unknown Collateral Type or Collateral Class cannot be amended using the Amend Registration operation, they can be discharged.



Operation Name: DischargeRegistration

Request: DischargeRegistrationRequestMessage

Response: DischargeRegistrationResponseMessage


UNCLASSIFIED


4.3.7.2.1 DischargeRegistrationRequestMessage

DischargeRegistrationRequestMessage


DischargeRegistrationRequestType



DischargeRegistrationRequest


DischargeRegistrationRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 DischargeRegistrationRequest DischargeRegistrationRequestType

DischargeRegistrationRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 RegistrationNumber string(20) The Registration Number of the Registration to be discharged.

0..1 RegistrationToken string(50) The Registration Token for the Registration to be discharged.

0..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group for the Registration to be discharged. Only provide the SecuredPartyGroupNumber if the RegistrationToken is not provided.


UNCLASSIFIED



1..1 ChangeNumber long The Change Number of the current version of the Registration.This is used to prevent discharging a Registration that has since been changed (e.g. amended, transferred, discharged) by another user via any channel.

4.3.7.2.2 DischargeRegistrationResponseMessage

DischargeRegistrationResponseMessageClass

DischargeRegistrationResponseType


PropertiesChangeNumber : longPpsrTransactionId : longRegistrationEndTime : DateTimeRegistrationNumber : string

DischargeRegistrationResponse


DischargeRegistrationResponseMessag 1..1 DischargeRegistrationResponse DischargeRegistrationResponseType


UNCLASSIFIED


e

DischargeRegistrationResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 RegistrationNumber string(20) The Registration Number of the Registration that was discharged.

1..1 ChangeNumber long The new Change Number assigned by PPSR to the discharged version of the Registration.


1..1 RegistrationEndTime dateTime The date and time that the registration was discharged. The value will reflect the PPSR system date and time that this operation was performed.


4.3.7.3.1 PpsrCollateralRegistrationDischargeFaultDetail

PpsrCollateralRegistrationDischargeFaultDetail




PpsrCollateralRegistrationDischargeFaultDetail




UNCLASSIFIED



4.3.7-10 The DischargeRegistrationRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005













4.3.7-90 The ChangeNumber provided must be the current ChangeNumber for the Registration. Fault Detail Type: PpsrCollateralRegistrationDischargeFaultDetailError Number: 32094


UNCLASSIFIED


4.3.7-100 The Registration must not be removed. Fault Detail Type: PpsrCollateralRegistrationDischargeFaultDetailError Number: 32097

4.3.7-110 The Registration must not already be expired/discharged. Fault Detail Type: PpsrCollateralRegistrationDischargeFaultDetailError Number: 32098

4.3.7-120 The Registration must not be marked as “access is restricted”. Fault Detail Type: PpsrCollateralRegistrationDischargeFaultDetailError Number: 32002

4.3.7-130 The Registration must not be archived. Fault Detail Type: PpsrCollateralRegistrationDischargeFaultDetailError Number: 32096


UNCLASSIFIED

4.3.8 Transfer Single Registration

This operation is used to transfer a single Registration from one Secured Party Group to another Secured Party Group. Only current Registrations can be transferred; that is, only Registrations that have not expired, been discharged or removed from PPSR. A current Registration that has been marked by the Registrar as “access is restricted” can be transferred.

The transfer of a single Registration occurs immediately when the request message is processed.

A copy of the Verification Statement that is produced for the transferred Registration is sent to the Address for Service for both the original and the new Secured Party Groups.

A new Registration Token is generated by PPSR and sent to the Address for Service for the new Secured Party Group. In order to make future amendments to the Registration or discharge the Registration, the new Registration Token or the Secured Party Group Access Code for the new Secured Party Group must be provided.



Operation Name: TransferSingleRegistration

Request: TransferSingleRegistrationRequestMessage

Response: TransferSingleRegistrationResponseMessage


UNCLASSIFIED


4.3.8.2.1 TransferSingleRegistrationRequestMessage

TransferSingleRegistrationRequestMessage


TransferSingleRegistrationRequestType


PropertiesRegistrationNumber : stringRegistrationToken : stringTransferFromSecuredPartyGroupAccessCode : stringTransferFromSecuredPartyGroupNumber : stringTransferToSecuredPartyGroupNumber : string

TransferSingleRegistrationRequest


TransferSingleRegistrationRequestMessage


1..1 TransferSingleRegistrationRequest TransferSingleRegistrationRequestType

TransferSingleRegistrationRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 RegistrationNumber string(20) The Registration Number of the Registration to be transferred.

0..1 RegistrationToken string(50) The Registration Token for the Registration to be transferred.

1..1 TransferFromSecuredPartyGroupNumber

string(20) The Secured Party Group Number of the Secured Party Group from which the Registration is to be


UNCLASSIFIED


transferred.

0..1 TransferFromSecuredPartyGroupAccessCode

string(50) The Secured Party Group Access Code for the Secured Party Group from which the Registration is to be transferred. Only provide the TransferFromSecuredPartyGroupAccessCode if the RegistrationToken is not provided.

1..1 TransferToSecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group to which the Registration is to be transferred.

4.3.8.2.2 TransferSingleRegistrationResponseMessage

TransferSingleRegistrationResponseMessageClass

TransferSingleRegistrationResponseType


PropertiesChangeNumber : longIsAccessIsRestricted : boolPpsrTransactionId : longRegistrationChangeTime : DateTimeRegistrationNumber : string

TransferSingleRegistrationResponse


UNCLASSIFIED


TransferSingleRegistrationResponseMessage

1..1 TransferSingleRegistrationResponse TransferSingleRegistrationResponseType

TransferSingleRegistrationResponseType



1..1 RegistrationNumber string(20) The Registration Number of the Registration that was transferred.

0..1 ChangeNumber long The new Change Number assigned by PPSR to the transferred version of the Registration.This will be null if the Registration has been marked as Access is Restricted.

0..1 RegistrationChangeTime dateTime The date and time that the registration was transferred in PPSR. Shows the day, month, year, hour, minute and second. The value is set by the system when the transfer is recorded in the Register. This will be null if the Registration has been marked as Access is Restricted.

1..1 IsAccessRestricted boolean Indicates whether the Registration has been marked as Access is Restricted.


UNCLASSIFIED


4.3.8.3.1 PpsrCollateralRegistrationTransferSingleFaultDetail

PpsrCollateralRegistrationTransferSingleFaultDetail


PropertiesRegistrationNumber : stringTransferFromSecuredPartyGroupNumber : stringTransferToSecuredPartyGroupNumber : string


PpsrCollateralRegistrationTransferSingleFaultDetail




string(20) The Secured Party Group Number of the Secured Party Group from which the Registration is to be transferred.

1..1 TransferToSecuredPartyGroupNumber

string(20) The Secured Party Group Number of the Secured Party Group to which the Registration is to be transferred.



4.3.8-10 The TransferSingleRegistrationRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


UNCLASSIFIED




4.3.8-40 If the RegistrationToken is provided, the TransferFromSecuredPartyGroupAccessCode must not be provided.


4.3.8-50 If the RegistrationToken is not provided, the TransferFromSecuredPartyGroupAccessCode must be provided and the value must not be an empty string.




4.3.8-70 The TransferFromSecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationTransferSingleFaultDetailError Number: 32175

4.3.8-80 The TransferFromSecuredPartyGroupNumber must be the correct SecuredPartyGroupNumber for the Registration.

Fault Detail Type: PpsrCollateralRegistrationTransferSingleFaultDetailError Number: 32176

4.3.8-91 The TransferFromSecuredPartyGroupNumber must not be for a migrated Secured Party Group.


4.3.8-100 If the TransferFromSecuredPartyGroupAccessCode is provided, the TransferFromSecuredPartyGroupAccessCode must be correct for the TransferFromSecuredPartyGroupNumber.


4.3.8-110 The TransferToSecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationTransferSingleFaultDetailError Number: 32178

4.3.8-120 The value of TransferToSecuredPartyGroupNumber must be for an existing Secured Party Group.



UNCLASSIFIED


4.3.8-131 The TransferToSecuredPartyGroupNumber must not be migrated Secured Party Group. Fault Detail Type: PpsrCollateralRegistrationTransferSingleFaultDetailError Number: 32199

4.3.8-140 The Registration must not be removed. Fault Detail Type: PpsrCollateralRegistrationTransferSingleFaultDetailError Number: 32097

4.3.8-150 The Registration must not already be expired/discharged. Fault Detail Type: PpsrCollateralRegistrationTransferSingleFaultDetailError Number: 32098

4.3.8-160 The Registration must not be archived. Fault Detail Type: PpsrCollateralRegistrationTransferSingleFaultDetailError Number: 32096

4.3.8-170 The TransferFromSecuredPartyGroupNumber and the TransferToSecuredPartyGroupNumber must not be the same Secured Party Group Number.


4.3.8-175 Cannot transfer a registration to an inactive Secured Party group. Fault Detail Type: PpsrCollateralRegistrationAccessExceptionError Number: 33076

4.3.8-180 A secured party validation error. Violation details are provided in the error message. Fault Detail Type: PpsrCollateralRegistrationTransferSingleFaultDetailError Number: 35127


UNCLASSIFIED

4.3.9 Transfer All Registrations

This operation is used to transfer all current Registrations belonging to a Secured Party Group to another Secured Party Group. Only current Registrations can be transferred; that is, only Registrations that have not expired, been discharged or removed from PPSR will be included in the transfer of all registrations. A current Registration that has been marked by the Registrar as “access is restricted” will be included in the transfer.

Note that transferring all Registrations for a Secured Party Group will result in an amendment being made to all the current Registrations for the Secured Party Group.

When transferring all Registrations for a Secured Party Group, all current Registrations for the Secured Party Group need to be updated to reflect the new Secured Party Group. As there could potentially be a large number of current Registrations, all current Registrations are updated as a background task that commences once the synchronous response message is returned. Depending on the number of Registrations to be transferred, there could be a delay between the response message being sent and updating all associated Registrations. An optional notification email can be sent when all current Registrations have been updated.

Only current Registrations that exist on PPSR at the time the request for transfer is received by PPSR will be transferred. If any new Registrations are created for the original Secured Party Group after the request for transfer has been received by PPSR, they will not be included in the transfer.

While the transfer of the Registrations for a Secured Party Group is in progress, the following operations are allowed:

Create a new Registration for the original Secured Party Group. Note that the new Registration will not be transferred;

Retrieve a Registration associated with the original Secured Party Group that has not yet been transferred. Note however that if a request to update this Registration is made after it has been transferred, the update will fail – it will be necessary to retrieve the Registration again using the new Registration Token for the transferred Registration, or the Secured Party Group Access Code for the new Secured Party Group;

Amend a Registration associated with the original Secured Party Group. Note however that the amendment must be made before the transfer has been made for this Registration;

Discharge a Registration associated with the original Secured Party Group. Note however that the discharge must be made before the transfer has been made for this Registration and the Registration will not be transferred as the transfer only affects current Registrations;


UNCLASSIFIED

Search for Registrations associated with the original Secured Party Group.

While the transfer of the Registrations for a Secured Party Group is in progress, the following operations are not allowed:

Make another request to transfer Registrations for the original Secured Party Group;

Make a request to transfer Registrations from any other Secured Party Group to the original Secured Party Group;

Make a request to transfer Registrations from the new Secured Party Group;

Updating the Address for Service for the original Secured Party Group;

Updating the Address for Service for the new Secured Party Group.

When the transfer of Registrations for the Secured Party Group is complete, a Verification Statement is produced listing all the transferred Registrations. A copy of this Verification Statement is sent to the Address for Service for both the original and new Secured Party Groups.

A new Registration Token is generated by PPSR for each transferred Registration and sent to the Address for Service for the new Secured Party Group. In order to make future amendments to the transferred Registrations or to discharge the transferred Registrations, the new Registration Token or the Secured Party Group Access Code for the new Secured Party Group must be provided.



Operation Name: TransferAllRegistrations

Request: TransferAllRegistrationsRequestMessage

Response: TransferAllRegistrationsResponseMessage


UNCLASSIFIED


4.3.9.2.1 TransferAllRegistrationsRequestMessage

TransferAllRegistrationsRequestMessage


TransferAllRegistrationsRequestType


PropertiesCompletionNotificationEmailAddress : stringTransferFromSecuredPartyGroupAccessCode : stringTransferFromSecuredPartyGroupNumber : stringTransferToSecuredPartyGroupNumber : string

TransferAllRegistrationsRequest


TransferAllRegistrationsRequestMessage


1..1 TransferAllRegistrationsRequest TransferAllRegistrationsRequestType

TransferAllRegistrationsRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.


string(20) The Secured Party Group Number of the Secured Party Group for the Registrations to be transferred from.


string(50) The Secured Party Group Access Code for the Secured Party Group.

1..1 TransferToSecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group for the Registrations to be transferred to.


UNCLASSIFIED


0..1 CompletionNotificationEmailAddress string(250) An optional email address to receive a notification from PPSR when the transfer has been completed for all Registrations.

4.3.9.2.2 TransferAllRegistrationsResponseMessage

TransferAllRegistrationsResponseMessageClass

TransferAllRegistrationsResponseType


PropertiesNumberOfCurrentRegistrations : intPpsrTransactionId : long

TransferAllRegistrationsResponse


TransferAllRegistrationsResponseMessage

1..1 TransferAllRegistrationsResponse TransferAllRegistrationsResponseType

TransferAllRegistrationsResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


1..1 NumberOfCurrrentRegistrations int The number of current registrations that belong to the transfer from Secured Party Group at the time the request to transfer registrations is received. The calculation of the fee charged for the transfer is based in this number.


UNCLASSIFIED


Note: The number may not be the same as the actual number of registrations that is finally included in the transfer. This is because some of the current registrations at the time the request to transfer registrations is received may have expired by the time the transfer is complete.


4.3.9.3.1 PpsrCollateralRegistrationTransferAllFaultDetail

PpsrCollateralRegistrationTransferAllFaultDetail


PropertiesTransferFromSecuredPartyGroupNumber : stringTransferToSecuredPartyGroupNumber : string


PpsrCollateralRegistrationTransferAllFaultDetail




1..1 TransferToSecuredPartyGroupNumber

string(20) The Secured Party Group Number of the Secured Party Group for the Registrations to be transferred to.


UNCLASSIFIED



4.3.9-10 The TransferAllRegistrationsRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.3.9-20 The TransferFromSecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationTransferAllFaultDetailError Number: 32175

4.3.9-30 The value of TransferFromSecuredPartyGroupNumber must be for an existing Secured Party Group.

Fault Detail Type: PpsrCollateralRegistrationTransferAllFaultDetailError Number: 32183



4.3.9-50 The TransferFromSecuredPartyGroupAccessCode must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationTransferAllFaultDetailError Number: 32184

4.3.9-60 The TransferFromSecuredPartyGroupAccessCode must be correct for the TransferFromSecuredPartyGroupNumber.


4.3.9-71 The TransferFromSecuredPartyGroupNumber must have at least one registration to transfer.


4.3.9-80 The TransferToSecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationTransferAllFaultDetailError Number: 32178




UNCLASSIFIED


4.3.9-101 The TransferToSecuredPartyGroupNumber must not be migrated Secured Party Group. Fault Detail Type: PpsrCollateralRegistrationTransferAllFaultDetailError Number: 32199



4.3.9-120 The From Secured Party Group must not be participating in any of the following operations (i.e. a PPSR operation has been started but not yet complete when validating this Request message): Updating the Address for Service for this Secured Party Group Transfer of Registrations from this Secured Party Group to another Secured Party

Group Transfer of Registrations from another Secured Party Group to this Secured Party

Group


4.3.9-130 The To Secured Party Group must not be participating in any of the following operations (i.e. a PPSR operation has been started but not yet complete when validating this Request message): Updating the Address for Service for this Secured Party Group Transfer of Registrations from this Secured Party Group to another Secured Party

Group


4.3.9-140 If a value is provided for the CompletionNotificationEmailAddress element, then the value must be in a valid format for an email address.


4.3.9-135 Cannot transfer a registration to an inactive Secured Party group. Fault Detail Type: PpsrCollateralRegistrationTransferAllExceptionError Number: 33076

4.3.9-150 A secured party validation error. Violation details are provided in the error message. Fault Detail Type: PpsrCollateralRegistrationTransferAllFaultDetailError Number: 35127


UNCLASSIFIED


UNCLASSIFIED

4.3.10 Reset Registration Token

This operation is used to reset the Registration Token for a Registration. A Secured Party Group can use this operation if they have forgotten the Registration Token for one of their Registrations or believe the current Registration Token has been compromised.

When this operation is called, PPSR generates a new Registration Token for the specified Registration and sends it to the Secured Party Group’s Address for Service.



Operation Name: ResetRegistrationToken

Request: ResetRegistrationTokenRequestMessage

Response: ResetRegistrationTokenResponseMessage


UNCLASSIFIED


4.3.10.2.1 ResetRegistrationTokenRequestMessage

ResetRegistrationTokenRequestMessage


ResetRegistrationTokenRequestType


PropertiesRegistrationNumber : stringSecuredPartyGroupAccessCode : stringSecuredPartyGroupNumber : string

ResetRegistrationTokenRequest


ResetRegistrationTokenRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 ResetRegistrationTokenRequest ResetRegistrationTokenRequestType

ResetRegistrationTokenRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 RegistrationNumber string(20) The Registration Number of the Registration to reset the Registration Token.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group for the Registration to reset the Registration Token.

1..1 SecuredPartyGroupAccessCode string(50) The Secured Party Group Access Code for the Secured Party Group.


UNCLASSIFIED

4.3.10.2.2 ResetRegistrationTokenResponseMessage

ResetRegistrationTokenResponseMessageClass

ResetRegistrationTokenResponseType


PropertiesPpsrTransactionId : long

ResetRegistrationTokenResponse


ResetRegistrationTokenMessage 1..1 ResetRegistrationTokenResponse ResetRegistrationTokenResponseType

ResetRegistrationTokenResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.



UNCLASSIFIED


4.3.10.3.1 PpsrCollateralRegistrationResetRegistrationTokenFaultDetail

PpsrCollateralRegistrationResetRegistrationTokenFaultDetail




PpsrCollateralRegistrationResetRegistrationFaultDetail





4.3.10-10 The ResetRegistrationTokenRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005




UNCLASSIFIED



4.3.10-50 The value provided for SecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationAccessFaultDetailError Number: 32139

4.3.10-61 The value provided for the SecuredPartyGroupNumber must not be migrated Secured Party Group.


4.3.10-70 The value provided for SecuredPartyGroupAccessCode must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationAccessFaultDetailError Number: 32140

4.3.10-80 The SecuredPartyGroupNumber must be the correct SecuredPartyGroupNumber for the Registration and the SecuredPartyGroupAccessCode must be correct for the SecuredPartyGroupNumber.


4.3.10-90 The Registration must not be removed. Fault Detail Type: PpsrCollateralRegistrationResetRegistrationTokenFaultDetailError Number: 32097

4.3.10-100 The Registration must not be expired/discharged. Fault Detail Type: PpsrCollateralRegistrationResetRegistrationTokenFaultDetailError Number: 32098

4.3.10-110 The Registration must not be marked as “access is restricted”. Fault Detail Type: PpsrCollateralRegistrationResetRegistrationTokenFaultDetailError Number: 32002

4.3.10-120 The Registration must not be archived. Fault Detail Type: PpsrCollateralRegistrationResetRegistrationTokenFaultDetailError Number: 32096


UNCLASSIFIED

4.3.11 Reissue Verification Statement

This operation is used to resend a Verification Statement for a specified version of a Registration to the Secured Party Group’s Address for Service.



Operation Name: ReissueVerificationStatement

Request: ReissueVerificationStatementRequestMessage

Response: ReissueVerificationStatementResponseMessage


UNCLASSIFIED


4.3.11.2.1 ReissueVerificationStatementRequestMessage

ReissueVerificationStatementRequestMessage


ReissueVerificationStatementRequestType



ReissueVerificationStatementRequest


ReissueVerificationStatementRequestMessage


1..1 ReissueVerificationStatementRequest ReissueVerificationStatementRequestType

ReissueVerificationStatementRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 RegistrationNumber string(20) The Registration Number of the Registration to reissue the Verification Statement.

0..1 RegistrationToken string(50) The Registration Token of the Registration to reissue the Verification Statement.

0..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group of the Registration to


UNCLASSIFIED


reissue the Verification Statement. Only provide the SecuredPartyGroupNumber if the RegistrationToken is not provided.


1..1 ChangeNumber long The Change Number identifying the version of the Registration and its corresponding Verification Statement.Every time a Registration is changed, PPSR creates a new version of the Registration. Each Registration version is identified by a system generated unique Change Number, along with its own Verification Statement.To reissue a Verification Statement for a specific version of a Registration, use the Change Number that corresponds to that version of the Registration.

4.3.11.2.2 ReissueVerificationStatementResponseMessage

ReissueVerificationStatementResponseMessageClass

ReissueVerificationStatementResponseType



ReissueVerificationStatementResponse


UNCLASSIFIED


ReissueVerificationStatementResponseMessage

1..1 ReissueVerificationStatementResponse

ReissueVerificationStatementResponseType

ReissueVerificationStatementResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.



4.3.11.3.1 PpsrCollateralRegistrationReissueVerificationStatementFaultDetail

PpsrCollateralRegistrationReissueVerificationStatementFaultDetail




PpsrCollateralRegistrationReissueVerificationStatementFaultDetail




UNCLASSIFIED



4.3.11-10 The ReissueVerificationStatementRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005








4.3.11-71 If the RegistrationToken is not provided, the SecuredPartyGroupNumber must be provided and the value must not be migrated Secured Party Group.









UNCLASSIFIED


4.3.11-110 The ChangeNumber provided must exist for the Registration. Fault Detail Type: PpsrCollateralRegistrationReissueVerificationStatementFaultDetailError Number: 32106

4.3.11-120 The Registration must not be removed. Fault Detail Type: PpsrCollateralRegistrationReissueVerificationStatementFaultDetailError Number: 32097

4.3.11-130 The Registration must not be expired/discharged. Fault Detail Type: PpsrCollateralRegistrationReissueVerificationStatementFaultDetailError Number: 32098

4.3.11-140 The Registration must not be marked as “access is restricted”. Fault Detail Type: PpsrCollateralRegistrationReissueVerificationStatementFaultDetailError Number: 32002

4.3.11-150 The Registration must not be archived. Fault Detail Type: PpsrCollateralRegistrationReissueVerificationStatementFaultDetailError Number: 32096

4.3.11-160 The Verification Statement for the specified RegistrationNumber and ChangeNumber must have already been produced.

Fault Detail Type: PpsrCollateralRegistrationReissueVerificationStatementFaultDetailError Number: 32192


UNCLASSIFIED

4.3.12 Transfer Multiple Registrations

This operation is used to transfer a set of Registrations belonging to a Secured Party Group to another Secured Party Group. Only current Registrations can be transferred; that is, only Registrations that have not expired, been discharged or removed from PPSR will be included in the transfer of all registrations. A current Registration that has been marked by the Registrar as “access is restricted” can be included in the transfer.

Note that transferring a set of Registrations for a Secured Party Group will result in an amendment being made to all the Registrations in that set for the Secured Party Group.

When transferring a set of Registrations for a Secured Party Group, that set of Registrations for the Secured Party Group need to be updated to reflect the new Secured Party Group. As there could potentially be a large number of these Registrations, the Registrations are updated as a background task that commences once the synchronous response message is returned. Depending on the number of Registrations to be transferred, there could be a delay between the response message being sent and updating all associated Registrations. An optional notification email can be sent when all Registrations have been updated.

Only current Registrations that exist on PPSR at the time the request for transfer is received by PPSR can be specified.

While the transfer of the Registrations for a Secured Party Group is in progress, the following operations are not allowed:

Updating the Address for Service for the original Secured Party Group;

Updating the Address for Service for the new Secured Party Group.

When the transfer of Registrations for the Secured Party Group is complete, a Verification Statement is produced listing all the transferred Registrations. A copy of this Verification Statement is sent to the Address for Service for both the original and new Secured Party Groups.

A new Registration Token is generated by PPSR for each transferred Registration and sent to the Address for Service for the new Secured Party Group. In order to make future amendments to the transferred Registrations or to discharge the transferred Registrations, the new Registration Token or the Secured Party Group Access Code for the new Secured Party Group must be provided.


UNCLASSIFIED



Operation Name: TransferMultipleRegistrations

Request: TransferMultipleRegistrationsRequestMessage

Response: TransferMultipleRegistrationsResponseMessage


TransferMultipleRegistrationsRequestMessage


UNCLASSIFIED


TransferMultipleRegistrationsRequestMessage


1..1 TransferMultipleRegistrationsRequest TransferMultipleRegistrationsRequestType

TransferMultipleRegistrationsRequestType





string(50) The Secured Party Group Access Code for the From Secured Party Group.

1..1 TransferToSecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group for the Registrations to be transferred to.

0..1 CompletionNotificationEmailAddress string(250) An optional email address to receive a notification from PPSR when the transfer has been completed for all Registrations.

1..* RegistrationNumbers List<string(20)> List of registration numbers to transfer. The registration numbers must be current and belong to the Transfer From Secured Party Group


UNCLASSIFIED

4.3.12.2.1 TransferMultipleRegistrationsResponseMessage


TransferMultipleRegistrationsResponseMessage

1..1 TransferMultipleRegistrationsResponse TransferMultipleRegistrationsResponseType

TransferMultipleRegistrationsResponseType



1..1 NumberOfCurrrentRegistrations int This number of registrations that will be transferred (this will be the same as the number of registration numbers in the RegistrationNumbers field in the request. The calculation of the fee charged for the transfer is based in this number.Note: The number may not be the same as the actual number of registrations that is finally included in the transfer. This is because some of the current registrations at the time the request to transfer registrations is received may have expired by the


UNCLASSIFIED


time the transfer is complete.


4.3.12.3.1 PpsrCollateralRegistrationTransferMultipleFaultDetail


PpsrCollateralRegistrationTransferMultipleFaultDetail


1..* CollateralRegistrationTransferMultipleValidationErrors

List<PpsrValidationError> A list of validation errors in the request message.


UNCLASSIFIED






4.3.12-10 The TransferMultipleRegistrationsRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.3.12-20 The TransferFromSecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationTransferMultipleFaultDetailCollateralRegistrationTransferMultipleValidationErrorsError Number: 32175

4.3.12-30 The value of TransferFromSecuredPartyGroupNumber must be for an existing Secured Party Group.

Fault Detail Type: PpsrCollateralRegistrationTransferMultipleFaultDetail CollateralRegistrationTransferMultipleValidationErrorsError Number: 32183



4.3.12-50 The TransferFromSecuredPartyGroupAccessCode must not be an empty string.


4.3.12-60 The TransferFromSecuredPartyGroupAccessCode must be correct for the TransferFromSecuredPartyGroupNumber.

Fault Detail Type: PpsrSecuredPartyGroupAccessFaultDetail CollateralRegistrationTransferMultipleValidationErrorsError Number: 32177


UNCLASSIFIED


4.3.12-71 The TransferFromSecuredPartyGroupNumber must have at least one registration to transfer.


4.3.12-80 The TransferToSecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationTransferMultipleFaultDetail CollateralRegistrationTransferMultipleValidationErrorsError Number: 32178



4.3.12-101 The TransferToSecuredPartyGroupNumber must not be migrated Secured Party Group.




4.3.12-120 The From Secured Party Group must not be participating in any of the following operations (i.e. a PPSR operation has been started but not yet complete when validating this Request message): Updating the Address for Service for this Secured Party Group Transfer of Registrations from this Secured Party Group to another

Secured Party Group Transfer of Registrations from another Secured Party Group to this

Secured Party Group


4.3.12-130 The To Secured Party Group must not be participating in any of the following operations (i.e. a PPSR operation has been started but not yet complete when validating this Request message): Updating the Address for Service for this Secured Party Group Transfer of Registrations from this Secured Party Group to another

Secured Party Group



UNCLASSIFIED


4.3.12-140 If a value is provided for the CompletionNotificationEmailAddress element, then the value must be in a valid format for an email address.


4.3.12-150 Cannot transfer a registration to an inactive Secured Party group. Fault Detail Type: PpsrCollateralRegistrationTransferMultipleFaultDetail CollateralRegistrationTransferMultipleValidationErrorsError Number: 33076

4.3.12-160 Each registration number must be a current registration in the from secured party group


4.3.12-170 Each registration number must exist in the register. Fault Detail Type: PpsrCollateralRegistrationTransferMultipleFaultDetail CollateralRegistrationTransferMultipleValidationErrorsError Number: 01355

4.3.12-180 At least one registration must be specified for the transfer. Fault Detail Type: PpsrCollateralRegistrationTransferMultipleFaultDetail CollateralRegistrationTransferMultipleValidationErrorsError Number: 01356

4.3.12-190 The value provided for each RegistrationNumber must not be an empty string.


4.3.12-200 There must be no validation errors from the request Fault Detail Type: PpsrCollateralRegistrationTransferMultipleFaultDetail Error Number: 1357

4.3.12-210 Each registration number must be a Registration Number for a registration that is still current (i.e. not archived, expired, discharged or removed).


4.3.12-220 There must be no duplicate registration numbers specified for the transfer in the request



UNCLASSIFIED


4.3.12-240 A secured party validation error. Violation details are provided in the error message.



UNCLASSIFIED

4.4 Secured Party Group Service

The Secured Party Group Service has a number of operations that support the creation and maintenance of Secured Party Groups for use within the Register. They include:

Create Secured Party Group

Retrieve Secured Party Group

Retrieve Secured Party Group History

Update Secured Party Group

Reset Access Code (for a Secured Party Group)

Change Access Code (for a Secured Party Group)

The details of these operations are given below.


UNCLASSIFIED


4.4.1.1 PpsrSecuredPartyGroupAccessFaultDetail

This class is used when an existing Secured Party Group is accessed or acted upon using a Secured Party Group Number and Access Code which are not supplied or are supplied but are invalid.

PpsrSecuredPartyGroupAccessFaultDetail


PropertiesSecuredPartyGroupNumber : string


PpsrSecuredPartyGroupAccessFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number that resulted in the error.If no Secured Party Group Number was provided, this will be an empty string.


UNCLASSIFIED

4.4.2 Create Secured Party Group

This operation is used to add a new Secured Party Group to PPSR.

The request message for this operation must provide all the information required to create the new Secured Party Group record in PPSR. This includes the Address for Service and the details of one or more Secured Parties.

The request message for the Create Secured Party Group operation has data elements that are always mandatory, optionally mandatory, always optional, and optionally relevant. The schema for the request message for the Create Secured Party Group operation only identifies “always mandatory” data elements as mandatory. Only provide values for all other data elements when the data elements are relevant.

PPSR will validate the data provided in each call to the Create Secured Party Group operation to ensure: all mandatory data is provided; that data is not provided when it is not relevant; and that the provided data contains acceptable values.

Once a Secured Party Group is created, amendments are restricted to the following:

changing the Secured Party Group’s address for service

re-verifying an identifier for an organisational Secured Party (e.g. ACN, ARBN, ARSN, ABN)

changing the Secured Party Group’s access code

changing the contact details for a Secured Party


Service Name: SecuredPartyGroup

Operation Name: CreateSecuredPartyGroup

Request: CreateSecuredPartyGroupRequestMessage

Response: CreateSecuredPartyGroupResponseMessage


UNCLASSIFIED


4.4.2.2.1 CreateSecuredPartyGroupRequestMessage

CreateSecuredPartyGroupRequestMessage


CreateSecuredPartyGroupRequestType


NewAddressForServiceClass

PropertiesAddressee : stringB2GAccountCustomerNumber : stringEmailAddress : stringFaxNumber : string

NewAddressClass

PropertiesISO3166CountryCode : stringLine1 : stringLine2 : stringLine3 : stringLocality : stringPostcode : stringState : string

NewSecuredPartyClass

PropertiesContactName : stringContactPhone : stringEmailAddress : stringNewSecuredPartySequenceNumber : short

SecuredPartyIndividualClass

PropertiesFamilyName : stringGivenNames : string

SecuredPartyOrganisationClass


SecuredPartyTypeEnum




CreateSecuredPartyGroupRequest

SecuredParties : List<NewSecuredParty>

AddressForService

PhysicalAddress

MailingAddress

SecuredPartyType

Individual

Organisation

MailingAddress



UNCLASSIFIED


CreateSecuredPartyGroupRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.


UNCLASSIFIED


1..1 CreateSecuredPartyGroupRequest CreateSecuredPartyGroupRequestType

CreateSecuredPartyGroupRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..* SecuredParties List<NewSecuredParty> One or more Secured Parties that make up the Secured Party Group.Each Secured Party in this list will be created and used only by this Secured Party Group. That is, another Secured Party with exactly the same details may exist for another Secured Party Group.Secured Parties with exactly the same details (i.e. duplicates) are not allowed within this list for the same Secured Party Group.

1..1 AddressForService NewAddressForService The Address for Service for the Secured Party Group.

NewSecuredParty 1..1 NewSecuredPartySequenceNumber short A unique sequence number must be provided for each Secured Party in order to uniquely identify each Secured Party in a single request message.The first Secured Party in a request message should have a NewSecuredPartySequenceNumber value of 1; the second Secured Party should have a NewSecuredPartySequenceNumber value of 2, and so on.The sequence number will be used to associate business rule violations (if any) with a particular Secured Party. In the SOAP fault, the fault detail will include the NewSecuredPartySequenceNumber value for any violations related to this Secured Party.This number is not stored in PPSR as part of the Secured Party Group record.

1..1 SecuredPartyType SecuredPartyType Indicates whether the Secured Party is an organisation or an individual. See section 5.21 SecuredPartyType for details.

0..1 Organisation SecuredPartyOrganisation If the Secured Party is an organisation, a value for Organisation must be provided.If the Secured Party is not an organisation, a value for Organisation must not be provided.


UNCLASSIFIED


0..1 Individual SecuredPartyIndividual If the Secured Party is an individual, a value for Individual must be provided.If the Secured Party is not an individual, a value for Individual must not be provided.

1..1 MailingAddress Address The mailing address for the Secured Party.The MailingAddress, EmailAddress, ContactName and ContactPhone for a Secured Party are not used for regular communication with the Secured Party Group. The Address for Service is used for this purpose. The MailingAddress, EmailAddress, ContactName and ContactPhone provide alternate means for the Registrar to contact the Secured Party and will not be disclosed to the public or to anyone searching PPSR.

0..1 EmailAddress string(250) The email address for the Secured Party.See note on MailingAddress.An email address is mandatory for all Secured Parties when creating a Secured Party Group through the B2G Channel.

1..1 ContactName string(120) The contact name for the Secured Party. See note on MailingAddress.

1..1 ContactPhone string(20) The contact phone number for the Secured Party. See note on MailingAddress.

SecuredPartyOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.Only provide a value for OrganisationNumberType if the Secured Party is an organisation that will be identified in PPSR by its organisation number.If a value is provided for OrganisationNumberType then a value must also be provided for OrganisationNumber and a value must not be provided for OrganisationName.If a value is not provided for OrganisationName then a value must be provided for


UNCLASSIFIED


OrganisationNumberType.

0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.Only provide a value for OrganisationNumber if the Secured Party is an organisation that will be identified in PPSR by its organisation number.If a value is provided for OrganisationNumber then a value must also be provided for OrganisationNumberType and a value must not be provided for OrganisationName.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumber.

0..1 OrganisationName string(250) The name of the organisation.Only provide a value for OrganisationName if the Secured Party is an organisation that will not be identified in PPSR by an organisation number.If a value is provided for OrganisationName then a value must not be provided for OrganisationNumberType or OrganisationNumber.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumberType and OrganisationNumber.



NewAddressForService 0..1 Addressee string(50) The name to be used with the postal mailing address and the fax number for the Address for Service for the Secured Party Group.For the postal mailing address it will be included as a line before the first line of the address. For the fax number it will be included as the attention line.

0..1 B2GAccountCustomerNumber string(20) If the Address for Service for this Secured Party Group is a B2G address, then provide the Account Customer Number of the B2G Account Customer in the B2GAccountCustomerNumber element.


UNCLASSIFIED


Notifications sent by PPSR to the Address for Service will be sent to the email address specified in the EmailAddress element and a copy of the notification will be provided in the B2G Mailbox for the specified B2G Account Customer.Do not provide a value if the Address for Service of the Secured Party Group is not a B2G address.

0..1 EmailAddress string(250) The email address used for the Address for Service for the Secured Party Group.An email address is mandatory in the Address for Service when creating a Secured Party Group through the B2G Channel.

0..1 FaxNumber string(20) The fax number used for the Address for Service for the Secured Party Group.

1..1 MailingAddress NewAddress The postal mail address used for the Address for Service for the Secured Party Group.

0..1 PhysicalAddress NewAddress The geographical address (e.g. the street address of a building) used for the Address for Service for the Secured Party Group.

NewAddress 1..1 ISO3166CountryCode string(2) The ISO 3166 country code of the country for the address. The value must be a valid ISO 3166-1-alpha-2 code.








UNCLASSIFIED

4.4.2.2.2 CreateSecuredPartyGroupResponseMessage

CreateSecuredPartyGroupResponseMessageClass

CreateSecuredPartyGroupResponseType


PropertiesPpsrTransactionId : longSecuredPartyGroupNumber : string

CreateSecuredPartyGroupResponse


CreateSecuredPartyGroupResponseMessage

1..1 CreateSecuredPartyGroupResponse CreateSecuredPartyGroupResponseType

CreateSecuredPartyGroupResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number assigned by PPSR to the Secured Party Group.



UNCLASSIFIED


4.4.2.3.1 PpsrSecuredPartyGroupCreateValidationFaultDetail

PpsrSecuredPartyGroupCreateValidationFaultDetail






AddressForServiceValidationErrors : List<PpsrValidationError>

SecuredPartyGroupValidationErrors : List<PpsrValidationError>

SecuredPartyValidationErrors : List<PpsrValidationErrorGroup> ValidationErrors : List<PpsrValidationError>


PpsrSecuredPartyGroupCreateValidationFaultDetail


0..1 SecuredPartyGroupValidationErrors List<PpsrValidationError> A list of validation errors in the data for the Secured Party Group in the request message.

0..1 SecuredPartyValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data for Secured Parties in the request message.

0..1 AddressForServiceValidationErrors List<PpsrValidationError> A list of validation errors in the data for the Address for Service in the request message.

PpsrValidationErrorGroup 1..1 SequenceNumber short Identifies the sequence number of the element in the request message for which validation errors have occurred. For example, if the PpsrValidationErrorGroup is for validation errors associated with a NewSecuredParty in the request message, the value of SequenceNumber will be the value of the NewSecuredPartySequenceNumber of the NewSecuredParty in the request message.


UNCLASSIFIED






Many business rule violations will be returned as a SOAP Fault where the content of the SOAP fault detail element is PpsrSecuredPartyGroupCreateValidationFaultDetail and the value of the ErrorNumber is 676. The PpsrSecuredPartyGroupCreateValidationFaultDetail allows multiple business rule violations to be reported. In the following table, the value in the SOAP Fault column indicates which group of errors in the PpsrSecuredPartyGroupCreateValidationFaultDetail that a violation of the business rule will be reported in (SecuredPartyGroupValidationErrors, SecuredPartyValidationErrors or AddressForServiceValidationErrors), as well as the value of the ErrorNumber for the business rule that has been violated.


4.4.2-10 The CreateSecuredPartyGroupRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.4.2-20 The SecuredParties element must contain at least one NewSecuredParty element. Fault Detail Type: PpsrSecuredPartyGroupCreateValidationFaultDetailSecuredPartyGroupValidationErrorsError Number: 33012

4.4.2-30 The value provided for the SecuredPartyType element must not be Unsupported. Fault Detail Type: PpsrSecuredPartyGroupCreateValidationFaultDetailSecuredPartyValidationErrorsError Number: 33041


UNCLASSIFIED


4.4.2-40 If the value provided for the SecuredPartyType element is Organisation, then a value must not be provided for the Individual element.

Fault Detail Type: PpsrSecuredPartyGroupCreateValidationFaultDetailSecuredPartyValidationErrorsError Number: 33021

4.4.2-50 If the value provided for the SecuredPartyType element is Organisation, then a value must be provided for the Organisation element and a value must be provided for either OrganisationName or OrganisationNumber where the value is not an empty string.


4.4.2-60 If a value is provided for the Organisation element, then a value must not be provided for both OrganisationName and OrganisationNumber.








4.4.2-101 If a value provided for OrganisationNumberType element is ABN, the value must be 11 digits.



UNCLASSIFIED


4.4.2-112 If a value provided for OrganisationNumberType element is ACN, ARSN or ARBN, the value must be 9 digits.


4.4.2-120 If the value provided for the SecuredPartyType element is Individual, then a value must not be provided for the Organisation element.


4.4.2-130 If the value provided for the SecuredPartyType element is Individual, then a value must be provided for the Individual element with values provided for both FamilyName and GivenNames that are not empty strings.

Fault Detail Type: PpsrSecuredPartyGroupCreateValidationFaultDetailSecuredPartyGroupValidationErrors Error Number: 33016

4.4.2-140 The value provided for ContactName for the NewSecuredParty element must not be an empty string.


4.4.2-150 The value provided for ContactPhone for the NewSecuredParty element must not be an empty string.


4.4.2-160 A value for the EmailAddress element must be provided for the NewSecuredParty element and the value must not be an empty string.


4.4.2-170 The value provided for the EmailAddress element for the NewSecuredParty element must be in a valid format for an email address.



UNCLASSIFIED


4.4.2-180 A value must be provided for the MailingAddress element in the NewSecuredParty element.


4.4.2-190 For the MailingAddress element in the NewSecuredParty element, the value provided for the ISO3166CountryCode element must be a valid ISO 3166-1-alpha-2 code.


4.4.2-200 For the MailingAddress element in the NewSecuredParty element, the value provided for the Line1 element must not be an empty string.


4.4.2-210 For the MailingAddress element in the NewSecuredParty element, the value provided for the Postcode element must not be an empty string.


4.4.2-220 If more than one NewSecuredParty is provided, then each NewSecuredParty must have a unique NewSecuredPartySequenceNumber.

Fault Detail Type: PpsrSecuredPartyGroupCreateValidationFaultDetailSecuredPartyGroupValidationErrors Error Number: 33038

4.4.2-230 If more than one NewSecuredParty is provided, then a NewSecuredParty must not identify the same Secured Party as another NewSecuredParty already provided. The check is based on the identifying fields of the Secured Party (e.g. organisation number or name for a Secured Party that is an organisation), not on the contact or address fields.


4.4.2-240 A value must be provided for the AddressForService element. Fault Detail Type: PpsrSecuredPartyGroupCreateValidationFaultDetailAddressForServiceValidationErrorsError Number: 33018


UNCLASSIFIED


4.4.2-250 If a value is provided for the B2GAccountCustomerNumber element in the AddressForService element, then the value must be the B2G Account Customer Number of a current B2G Account Customer.

Fault Detail Type: PpsrSecuredPartyGroupCreateValidationFaultDetailAddressForServiceValidationErrorsError Number: 33036

4.4.2-260 A value for the EmailAddress element must be provided for the AddressForService element and the value must not be an empty string.


4.4.2-270 The value provided for the EmailAddress element for the AddressForService element must be in a valid format for an email address.


4.4.2-280 A value must be provided for the MailingAddress element in the AddressForService element.


4.4.2-290 For the MailingAddress element in the AddressForService element, the value provided for the ISO3166CountryCode element must be a valid ISO 3166-1-alpha-2 code.


4.4.2-300 For the MailingAddress element in the AddressForService element, the value provided for the Line1 element must not be an empty string.


4.4.2-310 For the MailingAddress element in the AddressForService element, the value provided for the Postcode element must not be an empty string.



UNCLASSIFIED


4.4.2-320 If a value is provided in the PhysicalAddress element in the AddressForService element, then the value provided for the ISO3166CountryCode element must be a valid ISO 3166-1-alpha-2 code.


4.4.2-330 If a value is provided in the PhysicalAddress element in the AddressForService element, then the value provided for the Line1 element must not be an empty string.


4.4.2-340 If a value is provided in the PhysicalAddress element in the AddressForService element, then the value provided for the Postcode element must not be an empty string.


4.4.2-350 There must be no validation errors from the request. Fault Detail Type: PpsrSecuredPartyGroupCreateValidationFaultDetailError Number: 676


UNCLASSIFIED

4.4.3 Retrieve Secured Party Group

This operation is used to retrieve the current version of a Secured Party Group. This allows the secured party to review the current information held in PPSR for the Secured Party Group prior to performing some other action, such as updating the Secured Party Group.

The Secured Party Group Number of the Secured Party Group needs to be provided in the request to identify the specific Secured Party Group to be retrieved.

Access to retrieve the specific Secured Party Group needs to be authorised. To authorise access, the request message must include the Secured Party Group Access Code.



Operation Name: RetrieveSecuredPartyGroup

Request: RetrieveSecuredPartyGroupRequestMessage

Response: RetrieveSecuredPartyGroupResponseMessage


UNCLASSIFIED


4.4.3.2.1 RetrieveSecuredPartyGroupRequestMessage

RetrieveSecuredPartyGroupRequestMessage


RetrieveSecuredPartyGroupRequestType


PropertiesSecuredPartyGroupAccessCode : stringSecuredPartyGroupNumber : string

RetrieveSecuredPartyGroupRequest


RetrieveSecuredPartyGroupRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RetrieveSecuredPartyGroupRequest RetrieveSecuredPartyGroupRequestType

RetrieveSecuredPartyGroupRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group to be retrieved.


4.4.3.2.2 RetrieveSecuredPartyGroupResponseMessage


UNCLASSIFIED


UNCLASSIFIED


RetrieveSecuredPartyGroupResponseMessage

1..1 RetrieveSecuredPartyGroupResponse

RetrieveSecuredPartyGroupResponseType

RetrieveSecuredPartyGroupResponseType



1..1 SecuredPartyGroup SecuredPartyGroupWithVerification The Secured Party Group for the requested SecuredPartyGroupNumber.

SecuredPartyGroupWithVerification 1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group.

1..1 SecuredPartyGroupVersionId string(16) A unique identifier assigned by PPSR to the Secured Party Group to facilitate concurrency control during updates.The value must be provided when the UpdateSecuredPartyGroup operation is called. If the value of the SecuredPartyGroupVersionId provided in the update request does not match the current value in PPSR the update request will be rejected.

1..1 AddressForService AddressForServiceWithAdditionalNotificationAddresses

The Address for Service for the Secured Party Group.

1..* SecuredParties List<SecuredPartyWithVerification> The Secured Parties that make up the Secured Party Group.

SecuredPartyWithVerification 1..1 SecuredPartyType SecuredPartyType Indicates whether the Secured Party is an organisation or an individual. See 5.21 SecuredPartyType for details.

0..1 Organisation SecuredPartyOrganisationWithVerification If the Secured Party is an organisation, the details of the organisation.


1..1 MailingAddress Address The mailing address for the Secured Party.

1..1 ContactName string(120) The contact name for the Secured Party.

1..1 ContactPhone string(20) The contact phone number for the Secured Party.

0..1 EmailAddress string(250) The email address for the Secured Party.


UNCLASSIFIED


SecuredPartyOrganisationWithVerification 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details. There is a value for OrganisationNumberType only if the Secured Party is an organisation that is identified in PPSR by its organisation number.


0..1 OrganisationName string(250) The name of the organisation.There is a value for OrganisationName only if: the Secured Party is an organisation that is

identified in PPSR by its organisation name, or

the Secured Party is an organisation that is identified in PPSR by its organisation number, the organisation number exists on ASIC for (ACN, ARSN or ARBN) or ABR (for ABN) and the name of the organisation has been successfully retrieved from ASIC/ABR.


IdentifierVerificationStatusType If the Secured Party is an organisation that is identified in PPSR by its organisation number, this indicates the status of the verification of the organisation number with either ASIC for (ACN, ARSN or ARBN) or ABR (for ABN). See 5.8 IdentifierVerificationStatusType for details.If the VerificationStatus is “NotVerified” and the B2G Account Customer wishes to convey this information to the end user (e.g. on a screen or printed report), the form of words used in the explanation will need to be in an approved form agreed with the Registrar.The approved form for the conveying of data under this note is the way the data would appear on a search certificate or verification statement including any disclaimers and interpretive notes. This means that either a search certificate or verification statement provided in .pdf format


UNCLASSIFIED


over the B2G channel would suffice for the purposes of this note.

0..1 OrganisationNumberVerificationDateTime

dateTime If the Secured Party is an organisation that is identified in PPSR by its organisation number, this is the date and time that the OrganisationNumber was verified with either ASIC for (ACN, ARSN or ARBN) or ABR (for ABN), or verification was last attempted if the identifier has not yet been verified successfully.



AddressForServiceWithAdditionalNotificationAddresses

0..1 Addressee string(50) If an addressee has been specified in the Address for Service, this will be the addressee.If an addressee has not been specified in the Address for Service, this will be null.





1..1 MailingAddress Address The postal mail address of the Address for Service.


UNCLASSIFIED



3..3 AdditionalNotificationAddressDetails

List<AdditionalNotificationAddressDetail> The additional notification addresses for the address for service.There are always 3 additional notification AdditionalNotificationAddressDetail rows. If additional notifications are not to be sent for a notification category then the row will still be returned, but the EmailAddress and B2GMailboxAccountCustomerNumber will be null or empty.









AdditionalNotificationAddressDetail 1..1 NotificationCategory String(40) The category of notification that this AdditionalNotificationAddressDetail applies to.One of the following values: VerificationStatement AccessCode Token

1..1 IsSendToCCAddressAllowed boolean A flag to control whether the user performing an operation is able to receive a copy of notification of this NotificationCategory type.If true then any user who performs an action can request a copy of the verification statement, access code or token.


UNCLASSIFIED


0..1 EmailAddress String(250) If provided, then a copy of the notification will always be sent to the email address. This always occurs regardless of the value of IsSendToCCAddressAllowed.

0..1 B2GMailboxAccountCustomerNumber

String(20) If provided, then a copy of the notification will always be sent to B2G mailbox of this account customer number. This always occurs regardless of the value of IsSendToCCAddressAllowed.



4.4.3-10 The RetrieveSecuredPartyGroupRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.4.3-20 The value provided for SecuredPartyGroupNumber must not be an empty string. Fault Detail Type: PpsrSecuredPartyGroupAccessFaultDetailError Number: 33042

4.4.3-30 The value provided for SecuredPartyGroupAccessCode must not be an empty string.


4.4.3-40 The SecuredPartyGroupNumber must be for an existing Secured Party Group. Fault Detail Type: PpsrSecuredPartyGroupAccessFaultDetailError Number: 33000

4.4.3-50 The SecuredPartyGroupAccessCode must be correct for the SecuredPartyGroupNumber.



UNCLASSIFIED

4.4.4 Retrieve Secured Party Group History

This operation is used to retrieve the history of changes to a Secured Party Group, including the details of its creation and all (if any) subsequent changes.

Changes to a Secured Party Group include amendments to both the Address for Service and the contact details for the Secured Parties in the Secured Party Group. Even though a Secured Party’s contact details are never shown as part of Registration details, changing the contact details are tracked and recorded in the history as a change to the Secured Party Group.

Changes to a Secured Party Group also include changes when a request is made to reverify the Organisation Number of a Secured Party. While the structure of a Secured Party Group cannot be changed, it is possible to get the Organisation Number of a Secured Party reverified with ASIC (for ACN, ARBN or ARSN) or ABR (for ABN). When a Secured Party Group is first saved, the Organisation Number of each Secured Party that is identified by an ACN, ARBN, ARSN or ABN will be verified with ASIC or ABR and the name of the organisation as recorded on ASIC or ABR will be stored as part of the Secured Party Group details. If an organisation legally changes it name, an ability to ‘reverify’ the Secured Party can be done to reflect these changes. The updated name retrieved from these external registers will be used to update the Secured Party Group record in PPSR.

This operation returns a list of SecuredPartyGroupChange elements, where each element relates to a transaction that either created the Secured Party Group or made updates to the Secured Party Group. For each SecuredPartyGroupChange, the details returned show the information recorded for the Secured Party Group as a result of the change. Each SecuredPartyGroupChange also includes the PPSR Transaction Id of the transaction that created or updated the Secured Party Group.

The elements are ordered in the list in descending chronological order (i.e. most recent change first).



Operation Name: RetrieveSecuredPartyGroupHistory

Request: RetrieveSecuredPartyGroupHistoryRequestMessage

Response: RetrieveSecuredPartyGroupHistoryResponseMessage


UNCLASSIFIED


UNCLASSIFIED

4.4.4.2.2 RetrieveSecuredPartyGroupHistoryResponseMessage

RetrieveSecuredPartyGroupHistoryResponseMessageClass

RetrieveSecuredPartyGroupHistoryResponseType



SecuredPartyGroupChangeClass

PropertiesChangePpsrTransactionId : longChangeTime : DateTime

AddressForServiceClass

PropertiesAddressee : stringB2GAccountCustomerName : stringB2GAccountCustomerNumber : stringEmailAddress : stringFaxNumber : string

SecuredPartyClass

PropertiesContactName : stringContactPhone : stringEmailAddress : string





AddressClass

PropertiesCountryName : stringISO3166CountryCode : stringLine1 : stringLine2 : stringLine3 : stringLocality : stringPostcode : stringState : string





RetrieveSecuredPartyGroupHistoryResponse

SecuredPartyGroupHistory : List<SecuredPartyGroupChange>

AddressForService

SecuredParties : List<SecuredParty>

PhysicalAddress

MailingAddress

SecuredPartyType

Individual

Organisation

MailingAddress



UNCLASSIFIED


RetrieveSecuredPartyGroupHistoryResponseMessage

1..1 RetrieveSecuredPartyGroupHistoryResponse





1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group

1..1 SecuredPartyGroupHistory List<SecuredPartyGroupChange> A list of all Secured Party Group change details for the requested Secured Party Group.

SecuredPartyGroupChange 1..1 ChangeDateTime dateTime The date and time of the change to the Secured Party Group.

1..1 ChangePpsrTransactionId long The identifier of the transaction in PPSR that resulted in the change to the Secured Party Group.

1..1 AddressForService AddressForService The Address for Service recorded for the Secured Party Group as a result of the change.

1..* SecuredParties List<SecuredParty> The Secured Party information recorded for the Secured Party Group as a result of the change.

SecuredParty 1..1 SecuredPartyType SecuredPartyType Indicates whether the Secured Party is an organisation or an individual. See 5.21 SecuredPartyType for details.



1..1 MailingAddress Address The mailing address for the Secured Party.

1..1 ContactName string(120) The contact name for the Secured Party.

1..1 ContactPhone string(20) The contact phone number for the Secured Party.

0..1 EmailAddress string(250) The email address for the Secured Party.

SecuredPartyOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.


UNCLASSIFIED


There is a value for OrganisationNumberType only if the Secured Party is an organisation that is identified in PPSR by its organisation number.


0..1 OrganisationName string(250) The name of the organisation.If the Secured Party is an organisation that is identified in PPSR by its organisation number and the number did not exist in ASIC (for ACN, ARBN and ARSN) or ABR (for ABN) at the time of the changes, or at the time of the change ASIC/ABR had not been contacted yet to verify the organisation number, then the OrganisationName will be null.



AddressForService 0..1 Addressee string(50) If an addressee has been specified in the Address for Service, this will be the addressee.If an addressee has not been specified in the Address for Service, this will be null.



0..1 EmailAddress string(250) If an email address has been specified in the Address for Service, this will be the email


UNCLASSIFIED


address.If an email address has not been specified in the Address for Service, this will be null.


1..1 MailingAddress Address The postal mail address of the Address for Service.












UNCLASSIFIED


4.4.4-10 The RetrieveSecuredPartyGroupHistoryRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


4.4.4-30 The value provided for SecuredPartyGroupAccessCode must not be an empty string.


4.4.4-40 The SecuredPartyGroupNumber must be for an existing Secured Party Group and the SecuredPartyGroupAccessCode must be correct for the SecuredPartyGroupNumber.


4.4.4-50 The SecuredPartyGroupAccessCode must be correct for the SecuredPartyGroupNumber,





UNCLASSIFIED

4.4.5 Update Secured Party Group

This operation is used to update an existing Secured Party Group.

Not all attributes of a Secured Party Group can be updated. Once a Secured Party Group has been created, the structure of the Secured Party Group cannot be changed. That is, new Secured Parties cannot be added to the Secured Party Group, existing Secured Parties cannot be removed from the Secured Party Group, and the identity of the existing Secured Parties cannot be changed. If the structure of the Secured Party Group needs to be changed it will be necessary to create a new Secured Party Group with the required Secured Party details and transfer any Registrations to this new Secured Party Group.

The contact details for each Secured Party in a Secured Party Group can be updated. Only values for attributes that are to be updated need to be provided in the corresponding data elements in the request message. For any data element that is missing or has a null value in the request message, the value of the corresponding attribute will be left unchanged. Data elements for attributes that are not being changed can optionally be provided. However, if any fields in the Mailing Address for a Secured Party need to be updated, the full details of the Mailing Address need to be provided.

The Address for Service for a Secured Party Group can be updated. Note that the individual fields of the Address for Service, including fields in the Mailing Address or Physical Address, cannot be updated. If any of the fields in the Address for Service need to be changed, the full details of the Address for Service need to be provided.

If an Address for Service is provided in the request message, PPSR will assume the Address for Service is being changed. PPSR will not examine the individual fields in the Address for Service to see whether or not any fields have actually been changed. Note that providing an Address for Service in the request message will result in an amendment being made to all the current Registrations for the Secured Party Group, so only provide the Address for Service if the Address for Service actually needs to be updated.

While the structure of a Secured Party Group cannot be changed, it is possible to get the Organisation Number of a Secured Party reverified with ASIC (for ACN, ARBN or ARSN) or ABR (for ABN). When a Secured Party Group is first saved, the Organisation Number of each Secured Party that is identified by an ACN, ARBN, ARSN or ABN will be verified with ASIC or ABR and the name of the organisation as recorded on ASIC or ABR will be stored as part of the Secured Party details for the Secured Party Group. If an organisation legally changes it name, an ability to ‘reverify’ the Secured Party can be done to reflect these changes. The updated name retrieved from these external registers will be used to update the Secured Party Group record in PPSR.


UNCLASSIFIED

When the Address for Service is changed for the Secured Party Group, all current Registrations for the Secured Party Group also need to be updated to reflect the new Address for Service. As there could potentially be a large number of associated Registrations, all associated Registrations are updated as a background task. For this case, the Response message returned from PPSR indicates that the Address for Service for the Secured Party Group was changed, but associated Registrations will be updated as a separate background task. Depending on the number of Registrations to be updated, this could result in a delay between updating the Secured Party Group and updating all associated Registrations. An optional notification email can be sent when all associated Registrations have been updated.

Registrations created after changing the Address for Service of a Secured Party Group will reference the new Address for Service, even prior to the completion of the update of all associated existing Registrations.

While the Address for Service for the Registrations for a Secured Party Group are being changed, the following operations are allowed:

Create a new Registration for this Secured Party Group. Note that the Address for Service for this new Registration will be the new Address for Service for this Secured Party Group;

Retrieve a Registration associated with this Secured Party Group;

Amend a Registration associated with this Secured Party Group. Note that if the Address for Service change for this Registration is still pending, then the Amend operation will send the verification statement to the old Address for Service, and the amended Registration will still participate in the Address for Service change;

Discharge a Registration associated with this Secured Party Group. Note that if the Address for Service change for this Registration is still pending, then the Discharge operation will send the Verification Statement to the old Address for Service, and the Registration will not participate in the Address For Service change as the Address for Service change only affects current Registrations;

Search for Registrations associated with this Secured Party Group;

A further update to the details for this Secured Party Group, provided the Address for Service is not being changed again.

While the Address for Service for the Registrations for a Secured Party Group are being changed, the following operations are not allowed:

Changing (again) the Address for Service for this Secured Party Group;

The transfer of Registrations from this Secured Party Group to any other Secured Party Group;

The transfer of Registrations from any other Secured Party Group to this Secured Party Group.


UNCLASSIFIED

When the Address for Service change is completed for all Registrations for the Secured Party Group, a Verification Statement is produced listing all the affected Registrations. A copy of this Verification Statement is sent to both the old and new Address for Service.

Before calling the UpdateSecuredPartyGroup operation, it is necessary to first call the RetrieveSecuredPartyGroup operation to ensure you have the latest version of the information recorded in PPSR for the Secured Party Group. The response message to the RetrieveSecuredPartyGroup operation provides a SecuredPartyGroupVersionId that needs to be provided in the request message for the UpdateSecuredPartyGroup operation. The SecuredPartyGroupVersionId value is used to ensure that another update to the Secured Party Group has not been made between retrieving the Secured Party Group and updating the Secured Party Group.



Operation Name: UpdateSecuredPartyGroup

Request: UpdateSecuredPartyGroupRequestMessage

Response: UpdateSecuredPartyGroupResponseMessage


4.4.5.2.1 UpdateSecuredPartyGroupRequestMessage


UNCLASSIFIED


UNCLASSIFIED


UpdateSecuredPartyGroupRequestMessage


1..1 UpdateSecuredPartyGroupRequest UpdateSecuredPartyGroupRequestType

UpdateSecuredPartyGroupRequestType


1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group to be updated.


1..1 SecuredPartyGroupVersionId string(16) A unique string that identifies the current version of the Secured Party Group.This is used to prevent concurrent updates in case more than one user (over all channels) is attempting to update the same Secured Party Group at the same time.

0..1 UpdatedAddressForService UpdatedAddressForService The details of the updated Address for Service for the Secured Party Group.Only needs to be provided if the Address for Service is being changed. If no value is provided, then PPSR will retain the current details of the Address for Service for this Secured Party Group (i.e. the Address for Service of this Secured Party Group will not be updated).If provided, then all Address for Service details must be provided.If a value is provided for the UpdatedAddressForService element, PPSR will assume the Address for Service is being changed. PPSR will not examine the individual fields in the AddressForService within the UpdatedAddressForService to see whether or not any fields have actually been changed. Note that providing an Address for Service in the request message will result in an amendment being made to all the current Registrations for the Secured Party Group, so only provide the Address for Service if the Address for Service actually needs to be updated.


UNCLASSIFIED


0..* UpdatedSecuredParties List<UpdatedSecuredParty> The details of any Secured Parties to be updated.Only needs to be provided for each Secured Party to be updated. That is, do not provide Secured Parties that are not to be updated.Secured Parties cannot be added or deleted from an existing Secured Party Group.Only the contact details for a Secured Party can be updated.Only provide the contact details that are being updated. That is, do not provide any contact detail data elements that are not being changed. Note that this is different to updating the Address for Service where all data elements must be provided, even if some have not changed.Data elements for the Secured Party that are not contact details (e.g. OrganisationNumber) still must be provided to identify the Secured Party being updated.

0..* ReverifySecuredParties List<ReverifySecuredParty> The identifying details of any Secured Parties whose Organisation Number is to be reverified.Only needs to be provided for each Secured Party whose Organisation Number is to be reverified.The fields used to identify the Secured Party (i.e. OrganisationNumber and OrganisationNumberType) must be provided in order to identify the Secured Party whose Organisation Number is being reverified.

UpdatedSecuredParty 1..1 UpdatedSecuredPartySequenceNumber

short A unique sequence number must be provided for each updated Secured Party in order to uniquely identify each Secured Party to be updated in this request message.The first Secured Party to be updated in this request message should have a UpdatedSecuredPartySequenceNumber value of 1; the second Secured Party should have a UpdatedSecuredPartySequenceNumber value of 2, and so on.The sequence number will be used to associate business rule violations (if any) with a particular Secured Party. In the SOAP fault, the fault detail will include the UpdatedSecuredPartySequenceNumber value for any violations related to this Secured Party.


UNCLASSIFIED


This number is not stored in PPSR as part of the Secured Party Group record.

1..1 SecuredPartyType SecuredPartyType Indicates whether the Secured Party to be updated is an organisation or an individual. See section 5.21 SecuredPartyType for details.

0..1 Organisation SecuredPartyOrganisation If the Secured Party to be updated is an organisation, a value for Organisation must be provided.If the Secured Party to be updated is not an organisation, a value for Organisation must not be provided.

0..1 Individual SecuredPartyIndividual If the Secured Party to be updated is an individual, a value for Individual must be provided.If the Secured Party to be updated is not an individual, a value for Individual must not be provided.

0..1 MailingAddress NewAddress The mailing address for the Secured Party.Only needs to be provided if the mailing address for the Secured Party is being changed. If no value is provided, then PPSR will retain the current details of the mailing address for this Secured Party, that is, the mailing address of this Secured Party will not be updated.If provided, then all mailing address details must be provided.

0..1 EmailAddress string(250) The email address for the Secured Party.Only needs to be provided if the email address for the Secured Party is being changed. If no value is provided, then PPSR will retain the current value of the email address for this Secured Party.If a value is provided, it must not be an empty string.

0..1 ContactName string(120) The contact name for the Secured Party. Only needs to be provided if contact name for the Secured Party is being changed. If no value is provided, then PPSR will retain the current value of the contact name for this Secured Party.If a value is provided, it must not be an empty string.

0..1 ContactPhone string(20) The contact phone number for the Secured Party. Only needs to be provided if contact phone number


UNCLASSIFIED


for the Secured Party is being changed. If no value is provided, then PPSR will retain the current value of the contact phone number for this Secured Party.If a value is provided, it must not be an empty string.

ReverifySecuredParty 1..1 ReverifySecuredPartySequenceNumber

short A unique sequence number must be provided for each Secured Party in order to uniquely identify each Secured Party in this request message whose Organisation Number is to be reverified.The first Secured Party in this request message whose Organisation Number is to be reverified should have a ReverifySecuredPartySequenceNumber value of 1; the second Secured Party should have a ReverifySecuredPartySequenceNumber value of 2, and so on.The sequence number will be used to associate business rule violations (if any) with a particular Secured Party. In the SOAP fault, the fault detail will include the ReverifySecuredPartySequenceNumber value for any violations related to this Secured Party.This number is not stored in PPSR as part of the Secured Party Group record.

1..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.

1..1 OrganisationNumber string(50) The value of the number used to identify the organisation whose Organisation Number is to be reverified.

SecuredPartyOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.Only provide a value for OrganisationNumberType if the Secured Party is an organisation that is identified in PPSR by its organisation number.If a value is provided for OrganisationNumberType then a value must also be provided for OrganisationNumber and a value must not be provided for OrganisationName.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumberType.


UNCLASSIFIED


0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.Only provide a value for OrganisationNumber if the Secured Party is an organisation that is identified in PPSR by its organisation number.If a value is provided for OrganisationNumber then a value must also be provided for OrganisationNumberType and a value must not be provided for OrganisationName.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumber.

0..1 OrganisationName string(250) The name of the organisation.Only provide a value for OrganisationName if the Secured Party is an organisation that is not identified in PPSR by an organisation number.If a value is provided for OrganisationName then a value must not be provided for OrganisationNumberType or OrganisationNumber.If a value is not provided for OrganisationName then a value must be provided for OrganisationNumberType and OrganisationNumber.



UpdatedAddressForService 1..1 AddressForService NewAddressForServiceWithAdditionalNotificationAddresses

The details of the updated Address for Service for the Secured Party Group. All Address for Service details must be provided.

0..1 CompletionNotificationEmailAddress string(250) An optional email address to receive a notification from PPSR when the update to the Address for Service has been applied to all Registrations for the Secured Party Group.

NewAddressForServiceWithAdditionalNotificationAddresses

0..1 Addressee string(50) The addressee used for the Address for Service for the Secured Party Group.To remove the addressee, do not provide a value for the Addressee element.

0..1 B2GAccountCustomerNumber string(20) If the Address for Service for this Secured Party Group is a B2G address, then provide the Account Customer Number of the B2G Account Customer in the B2GAccountCustomerNumber element.Notifications sent by PPSR to the Address for


UNCLASSIFIED


Service will be sent to the email address specified in the EmailAddress element and a copy of the notification will be provided in the B2G Mailbox for the specified B2G Account Customer.Do not provide a value if the Address for Service of the Secured Party Group is not a B2G address.To remove the B2G address, do not provide a value for the B2GAccountCustomerNumber element.

0..1 EmailAddress string(250) The email address used for the Address for Service for the Secured Party Group.An email address is mandatory in the Address for Service when a Secured Party Group is updated through the B2G Channel.

0..1 FaxNumber string(20) The fax number used for the Address for Service for the Secured Party Group.To remove the fax number, do not provide a value for the FaxNumber element.

1..1 MailingAddress NewAddress The postal mail address used for the Address for Service for the Secured Party Group.

0..1 PhysicalAddress NewAddress The geographical address (e.g. the street address of a building) used for the Address for Service for the Secured Party Group. To remove the physical address, do not provide a value for the PhysicalAddress element.

0..3 AdditionalNotificationAddressDetails List<AdditionalNotificationAddressDetail>

The additional notification addresses for the address for service.There are always 3 additional notification addresses. To not use them, set the B2GMailboxs and email addresses to an empty string.

NewAddress 1..1 ISO3166CountryCode string(2) The ISO 3166 country code of the country for the address.







UNCLASSIFIED



AdditionalNotificationAddressDetail 1..1 NotificationCategory String(40) The category of notification that this AdditionalNotificationAddressDetail applies to.One of the following values:

VerificationStatementAccessCodeToken

1..1 IsSendToCCAddressAllowed boolean Whether the user performing an operation that result is a notification of this category being sent to this address for service is able to receive a copy of the notification.If true then any user who performs an action can request a copy of the verification statement, access code or token.

0.,1 EmailAddress String(250) If provided, then a copy of the notification will always be sent to the email address. This always occurs regardless of the value of IsSendToCCAddressAllowed.

0..1 B2GMailboxAccountCustomerNumber String(20) If provided, then a copy of the notification will always be sent to B2G mailbox of this account customer number. This always occurs regardless of the value of IsSendToCCAddressAllowed.


UNCLASSIFIED

4.4.5.2.2 UpdateSecuredPartyGroupResponseMessage

UpdateSecuredPartyGroupResponseMessageClass

UpdateSecuredPartyGroupResponseType



UpdateSecuredPartyGroupResponse


UpdateSecuredPartyGroupResponseMessage

1..1 UpdateSecuredPartyGroupResponse

UpdateSecuredPartyGroupResponseType

UpdateSecuredPartyGroupResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group that was updated.



UNCLASSIFIED


4.4.5.3.1 PpsrSecuredPartyGroupUpdateFaultDetail

PpsrSecuredPartyGroupUpdateFaultDetail




PpsrSecuredPartyGroupUpdateFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number that resulted in the error.

4.4.5.3.2 PpsrSecuredPartyGroupUpdateValidationFaultDetail

PpsrSecuredPartyGroupUpdateValidationFaultDetail






AddressForServiceValidationErrors : List<PpsrValidationError>

SecuredPartyGroupValidationErrors : List<PpsrValidationError>

ReverifySecuredPartyValidationErrors : List<PpsrValidationErrorGroup>

UpdatedSecuredPartyValidationErrors : List<PpsrValidationErrorGroup>ValidationErrors : List<PpsrValidationError>


UNCLASSIFIED


PpsrSecuredPartyGroupUpdateValidationFaultDetail


0..1 SecuredPartyGroupValidationErrors List<PpsrValidationError> A list of validation errors in the data for the Secured Party Group in the request message.

0..1 UpdatedSecuredPartyValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data for updated Secured Parties in the request message.

0..1 ReverifySecuredPartyValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the data for Secured Parties in the request message whose Organisation Number is to be reverified.

0..1 AddressForServiceValidationErrors List<PpsrValidationError> A list of validation errors in the data for the Address for Service in the request message.

PpsrValidationErrorGroup 1..1 SequenceNumber short Identifies the sequence number of the element in the request message for which validation errors have occurred. For example, if the PpsrValidationErrorGroup is for validation errors associated with an UpdatedSecuredParty in the request message, the value of SequenceNumber will be the value of the UpdatedSecuredPartySequenceNumber of the UpdatedSecuredParty in the request message.





UNCLASSIFIED


Many business rule violations will be returned as a SOAP Fault where the content of the SOAP fault detail element is PpsrSecuredPartyGroupUpdateValidationFaultDetail and the value of the ErrorNumber is 677. The PpsrSecuredPartyGroupUpdateValidationFaultDetail allows multiple business rule violations to be reported. In the following table, the value in the SOAP Fault column indicates which group of errors in the PpsrSecuredPartyGroupUpdateValidationFaultDetail that a violation of the business rule will be reported in (SecuredPartyGroupValidationErrors, UpdatedSecuredPartyValidationErrors, ReverifySecuredPartyValidationErrors or AddressForServiceValidationErrors), as well as the value of the ErrorNumber for the business rule that has been violated.


4.4.5-10 The UpdateSecuredPartyGroupRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


4.4.5-30 The value provided for SecuredPartyGroupAccessCode must not be an empty string. Fault Detail Type: PpsrSecuredPartyGroupAccessFaultDetailError Number: 33022




4.4.5-50 The SecuredPartyGroupAccessCode must be correct for the SecuredPartyGroupNumber.


4.4.5-60 The SecuredPartyGroupVersionId provided must be the current SecuredPartyGroupVersionId for the Secured Party Group.

Fault Detail Type: PpsrSecuredPartyGroupUpdateFaultDetailError Number: 33003


UNCLASSIFIED


4.4.5-70 The UpdateSecuredPartyGroupRequest element must contain at least one of the following elements:

UpdatedSecuredParties element containing at least one UpdatedSecuredParty element

ReverifySecuredParties element containing at least one ReverifySecuredParty element.

UpdatedAddressForService element

Fault Detail Type: PpsrSecuredPartyGroupUpdateValidationFaultDetailSecuredPartyGroupValidationErrorsError Number: 33002

4.4.5-80 If more than one UpdatedSecuredParty is provided, then each UpdatedSecuredParty must have a unique UpdatedSecuredPartySequenceNumber.

Fault Detail Type: PpsrSecuredPartyGroupUpdateValidationFaultDetailUpdatedSecuredPartyValidationErrorsError Number: 33038

4.4.5-90 The value provided for SecuredPartyType in an UpdatedSecuredParty must not be Unsupported.


4.4.5-100 If the value provided for SecuredPartyType in an UpdatedSecuredParty is Organisation, then a value must not be provided for the Individual element.


4.4.5-110 If the value provided for SecuredPartyType in an UpdatedSecuredParty is Organisation, then a value must be provided for the Organisation element and a value must be provided for either OrganisationName or OrganisationNumber where the value is not an empty string.


4.4.5-120 If a value is provided for Organisation in an UpdatedSecuredParty, then a value must not be provided for both OrganisationName and OrganisationNumber.



UNCLASSIFIED


4.4.5-130 If a value is provided for OrganisationNumber in an UpdatedSecuredParty, then a value must also be provided for OrganisationNumberType.


4.4.5-140 If a value is not provided for OrganisationNumber in an UpdatedSecuredParty, then a value must not be provided for OrganisationNumberType.


4.4.5-150 If a value is provided for OrganisationNumberType in an UpdatedSecuredParty, the value must not be Unsupported.


4.4.5-160 If the value provided for SecuredPartyType in an UpdatedSecuredParty is Individual, then a value must not be provided for the Organisation element.


4.4.5-170 If the value provided for SecuredPartyType in an UpdatedSecuredParty is Individual, then a value must be provided for the Individual element with values provided for both FamilyName and GivenNames that are not empty strings.


4.4.5-180 If more than one UpdatedSecuredParty is provided, then an UpdatedSecuredParty must not identify the same Secured Party as another UpdatedSecuredParty already provided. The check is based on the identifying fields of the Secured Party (e.g. organisation number or name for a Secured Party that is an organisation), not on the contact or address fields.


4.4.5-190 For each UpdatedSecuredParty element provided, the Secured Party identified by the UpdatedSecuredParty must be an exact match (i.e. have all the same values for identifying elements) of an existing Secured Party recorded for the Secured Party Group.



UNCLASSIFIED


4.4.5-200 For each UpdatedSecuredParty element provided, either the MailingAddress element must be provided or at least one of the following elements must be provided and contain a value that is not an empty string: EmailAddress element, ContactName element, ContactPhone element.


4.4.5-210 If a value for the ContactName element is provided for an UpdatedSecuredParty element, then the value for the ContactName element must not be an empty string.


4.4.5-220 If a value for the ContactPhone element is provided for an UpdatedSecuredParty element, then the value for the ContactPhone element must not be an empty string.


4.4.5-230 If a value for the EmailAddress element is provided for an UpdatedSecuredParty element, then the value for the EmailAddress element must not be an empty string.


4.4.5-240 If a value for the EmailAddress element is provided for an UpdatedSecuredParty element, then the value must be in a valid format for an email address.


4.4.5-250 If a value for the MailingAddress element is provided for an UpdatedSecuredParty element, then the value provided for the ISO3166CountryCode element must be a valid ISO 3166-1-alpha-2 code.


4.4.5-260 If a value for the MailingAddress element is provided for an UpdatedSecuredParty element, then the value for the Line1 element must not be an empty string.



UNCLASSIFIED


4.4.5-270 If a value for the MailingAddress element is provided for an UpdatedSecuredParty element, then the value for the Postcode element must not be an empty string.


4.4.5-280 If more than one ReverifySecuredParty is provided, then each ReverifySecuredParty must have a unique ReverifySecuredPartySequenceNumber.

Fault Detail Type: PpsrSecuredPartyGroupUpdateValidationFaultDetailReverifySecuredPartyValidationErrorsError Number: 33038

4.4.5-290 For each ReverifySecuredParty element provided, the value provided for OrganisationNumberType must not be Unsupported.


4.4.5-300 For each ReverifySecuredParty element provided, the value provided for the OrganisationNumber must not be an empty string.


4.4.5-310 If more than one ReverifySecuredParty is provided, then a ReverifySecuredParty must not identify the same Secured Party as another ReverifySecuredParty already provided. The check is based on the identifying fields of the secured party (i.e. organisation number and organisation number type).


4.4.5-320 For each ReverifySecuredParty element provided, the Secured Party identified by the ReverifySecuredParty must be an exact match (i.e. have the same values for organisation number and organisation number type) of an existing Secured Party recorded for the Secured Party Group.



UNCLASSIFIED


4.4.5-330 If a value is provided for the UpdatedAddressForService element, then this Secured Party Group must not be participating in any of the following operations (i.e. a PPSR operation has been started but not yet complete when validating this Request message): Updating the Address for Service for the Registrations for this Secured Party Group Transfer of Registrations from this Secured Party Group to another Secured Party

Group Transfer of Registrations from another Secured Party Group to this Secured Party

Group

Fault Detail Type: PpsrSecuredPartyGroupUpdateFaultDetailError Number: 33004

4.4.5-340 If a value is provided for the UpdatedAddressForService element, and if a value is provided for the CompletionNotificationEmailAddress element, then the value must be in a valid format for an email address.

Fault Detail Type: PpsrSecuredPartyGroupUpdateValidationFaultDetailAddressForServiceValidationErrorsError Number: 33026

4.4.5-350 If a value is provided for the UpdatedAddressForService element, then a value must be provided for the AddressForService element.


4.4.5-360 If a value is provided for the UpdatedAddressForService element, and if a value is provided for the B2GAccountCustomerNumber element of the AddressForService element, then the value must be the B2G Account Customer Number of a current B2G Account Customer.


4.4.5-370 If a value is provided for the UpdatedAddressForService element, then a value must be provided for the EmailAddress element of the AddressForService element and the value must not be an empty string.


4.4.5-380 If a value is provided for the EmailAddress element of the AddressForService element, then the value must be in a valid format for an email address.



UNCLASSIFIED


4.4.5-390 If a value is provided for the UpdatedAddressForService element, then a value must be provided for the MailingAddress element in the AddressForService element.


4.4.5-400 If a value is provided for the UpdatedAddressForService element, then for the MailingAddress element of the AddressForService element, the value provided for the ISO3166CountryCode element must be a valid ISO 3166-1-alpha-2 code.


4.4.5-410 If a value is provided for the UpdatedAddressForService element, then for the MailingAddress element of the AddressForService element, the value provided for the Line1 element must not be an empty string.


4.4.5-420 If a value is provided for the UpdatedAddressForService element, then for the MailingAddress element of the AddressForService element, the value provided for the Postcode element must not be an empty string.


4.4.5-430 If a value is provided for the UpdatedAddressForService element, and a value is provided for the PhysicalAddress element of the AddressForService element, then the value provided for the ISO3166CountryCode element must be a valid ISO 3166-1-alpha-2 code.


4.4.5-440 If a value is provided for the UpdatedAddressForService element, and a value is provided for the PhysicalAddress element of the AddressForService element, then the value provided for the Line1 element must not be an empty string.


4.4.5-450 If a value is provided for the UpdatedAddressForService element, and if a value is provided for the PhysicalAddress element of the AddressForService element, then the value provided for the Postcode element must not be an empty string.



UNCLASSIFIED


4.4.5-460 Cannot update an inactive Secured Party Group. Fault Detail Type: PpsrSecuredPartyGroupUpdateValidationFaultDetailError Number: 33075

4.4.5-470 There must be no validation errors from the request. Fault Detail Type: PpsrSecuredPartyGroupUpdateValidationFaultDetailError Number: 677

4.4.5-480 A value must be provided for the NotificationCategory element. Fault Detail Type: PpsrSecuredPartyGroupUpdateValidationFaultDetailError Number: 35300

4.4.5-490 A value of the NotificationCategory element can only occur once in the AdditionalNotificationAddressDetails in the list.

Fault Detail Type: PpsrSecuredPartyGroupUpdateValidationFaultDetailError Number: 35301

4.4.5-500 The value of the NotificationCategory element must be one of VerificationStatement, AccessCode or Token.


4.4.5-510 If a value is provided for the B2GAccountCustomerNumber element, then the value must be for an existing B2G account customer.


4.4.5-520 If a value is provided for the EmailAddress element, then the value must be in a valid format for an email address.



UNCLASSIFIED

4.4.6 Reset Access Code

This operation is used to reset the Access Code for a Secured Party Group. A Secured Party Group can use this operation if they have forgotten their Access Code or believe the current Access Code has been compromised.

When this operation is called, PPSR generates a new Access Code for the specified Secured Party Group and sends it to the Secured Party Group’s Address for Service.



Operation Name: ResetAccessCode

Request: ResetAccessCodeRequestMessage

Response: ResetAccessCodeResponseMessage


UNCLASSIFIED


4.4.6.2.1 ResetAccessCodeRequestMessage

ResetAccessCodeRequestMessage


ResetAccessCodeRequestType



ResetAccessCodeRequest


ResetAccessCodeRequestMessage


1..1 ResetAccessCodeRequest ResetAccessCodeRequestType

ResetAccessCodeRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group to reset the Access Code.


UNCLASSIFIED

4.4.6.2.2 ResetAccessCodeResponseMessage

ResetAccessCodeResponseMessageClass

ResetAccessCodeResponseType



ResetAccessCodeResponse


ResetAccessCodeResponseMessage 1..1 ResetAccessCodeResponse ResetAccessCodeResponseType

ResetAccessCodeResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.




4.4.6-10 The ResetAccessCodeRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.4.6-20 The value provided for the SecuredPartyGroupNumber must not be an empty string.



UNCLASSIFIED


4.4.6-30 The SecuredPartyGroupNumber must exist for a Secured Party Group. Fault Detail Type: PpsrSecuredPartyGroupAccessFaultDetailError Number: 33000



4.4.6-50 Cannot update an inactive Secured Party Group. Fault Detail Type: PpsrSecuredPartyGroupAccessFaultDetailError Number: 33075


UNCLASSIFIED

4.4.7 Change Access Code

This operation is used to change the current Access Code for a Secured Party Group to a new value specified by the Secured Party Group. A Secured Party Group can use this operation if they want to change the Access Code from a value that has been generated by PPSR to a value that is easier for the Secured Party Group to remember, or if they believe the current Access Code has been compromised.

When this operation is called, PPSR changes the Access Code for the specified Secured Party Group to the new value provided by the Secured Party Group and sends the new value to the Secured Party Group’s Address for Service.



Operation Name: ChangeAccessCode

Request: ChangeAccessCodeRequestMessage

Response: ChangeAccessCodeResponseMessage


UNCLASSIFIED


4.4.7.2.1 ChangeAccessCodeRequestMessage

ChangeAccessCodeRequestMessage


ChangeAccessCodeRequestType


PropertiesCurrentSecuredPartyGroupAccessCode : stringNewSecuredPartyGroupAccessCode : stringSecuredPartyGroupNumber : string

ChangeAccessCodeRequest


ChangeAccessCodeRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 ChangeAccessCodeRequest ChangeAccessCodeRequestType

ChangeAccessCodeRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number of the Secured Party Group to change its Access Code.

1..1 CurrentSecuredPartyGroupAccessCode string(50) The current Secured Party Group Access Code for the Secured Party Group.

1..1 NewSecuredPartyGroupAccessCode string(50) The new Secured Party Group Access Code for the Secured Party Group.


UNCLASSIFIED

4.4.7.2.2 ChangeAccessCodeResponseMessage

ChangeAccessCodeResponseMessageClass

ChangeAccessCodeResponseType



ChangeAccessCodeResponse


ChangeAccessCodeResponseMessage 1..1 ChangeAccessCodeResponse ChangeAccessCodeResponseType

ChangeAccessCodeResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.



UNCLASSIFIED


4.4.7.3.1 PpsrSecuredPartyGroupChangeAccessCodeValidationFaultDetail

PpsrSecuredPartyGroupChangeAccessCodeValidationFaultDetail




PpsrSecuredPartyGroupChangeAccessCodeValidationFaultDetail


1..1 SecuredPartyGroupNumber string(20) The Secured Party Group Number that resulted in the error.



4.4.7-10 The ChangeAccessCodeRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.4.7-20 The value provided for the SecuredPartyGroupNumber must not be an empty string.


4.4.7-30 The value provided for CurrentSecuredPartyGroupAccessCode must not be an empty string.



UNCLASSIFIED





4.4.7-60 The CurrentSecuredPartyGroupAccessCode must be correct for the SecuredPartyGroupNumber.


4.4.7-70 The value provided for NewSecuredPartyGroupAccessCode must not be an empty string.

Fault Detail Type: PpsrSecuredPartyGroupChangeAccessCodeValidationFaultDetailError Number: 33043

4.4.7-80 The value provided in NewSecuredPartyGroupAccessCode must meet the following rules: not contain space characters have at least a minimum number of characters (to be determined) have no more than a maximum number of characters (to be determined) have at least one upper case character have at least one lower case character have at least one numeric character have at least one of the following special characters:

]~@#^:;<>,.[()|\"`'*$-+?_&=!%{}/

Fault Detail Type: PpsrSecuredPartyGroupChangeAccessCodeValidationFaultDetailError Number: 33010

4.4.7-80 Cannot update an inactive Secured Party Group. Fault Detail Type: PpsrSecuredPartyGroupChangeAccessCodeValidationFaultDetailError Number: 33075


UNCLASSIFIED

4.5 Collateral Registration Search Service

The Collateral Registration Search Service has a number of operations that allow searching the Register, working with search results and requesting search certificates.

There are four primary search operations that correspond to the four different types of search that can be performed on the Register. They are:

Search By Registration Number

Search By Serial Number

Search By Grantor

Ordinal Search

There is a fifth primary search operation that corresponds to a variation of the Search By Grantor search type:

Search By Grantor And Event Date Range

The Search By Grantor And Event Date Range operation has been explicitly separated from Search By Grantor to simplify the definition and provision of the search criteria for this variation of Search By Grantor.

The remaining operations are used to work with the search results returned from one of the search type operations. They include:

Retrieve Search Result

Retrieve Search Result Registration Attachment

Retrieve Grantor Search Result Detail

Filter Grantor Search Result

Filter Grantor And Event Date Range Search Result

Retrieve Registration History Detail

Request Search Certificate

Request Search Certificates


UNCLASSIFIED

Retrieve Search Certificate

Retrieve Search Certificate Registration Attachment

The business scenario for using each of these operations is specified in section 4.2.2 Finding Things.

An Account Customer may not be given authorisation to perform all search types. Further, an account customer will not be given authorisation to specify certain search criteria. A number of search actions are only available to some internal users such as Registrar Office staff or Contact Centre staff.

A B2G Account Customer can also perform transactions using the Web Channel. The customer may determine that it is more efficient to partially implement the search functionality using the B2G Channel but use the Web Channel to complete uncommon tasks. A search that was performed through the B2G Channel can be accessed later through the Web Channel, and vice-versa.

4.5.1 Important concepts

This section identifies important concepts used within the Collateral Registration Search Service that must be understood to successfully use the search operations.

4.5.1.1 Search Number

Each search undertaken against the Register is allocated a unique Search Number. This Search Number must be provided when performing subsequent operations on the search result such as:

retrieving attachments for registrations included in the search result

retrieving details of earlier versions of registrations included in the search result (when the registration has been amended)

filtering the search result (Grantor searches only)

requesting a search certificate

retrieving the result at a later time

The Search Number is returned from most operations provided by the Collateral Registration Search Service, and is required to be provided as input for many of the operations used after the initial search request.


UNCLASSIFIED

Note that a Search Number from a search performed through the B2G Channel can be used to later access the search result through the Web Channel, and vice-versa.

4.5.1.2 Declaration of Authorised Purpose

When a user searches the PPSR for Registrations against a Grantor that is an individual (not an organisation), they are required to make a declaration stating they are doing so for an authorised purpose as set out in the PPS Act. When the Search By Grantor operation is used to search for an individual Grantor, a field must be provided indicating the person conducting the search has made this declaration. It is a requirement that B2G Account Customers using the Search By Grantor operation build provision into their systems to ensure their users make this declaration when performing searches for individual Grantors2.

4.5.1.3 Point-in-Time Search

In general, searches of the Register will search against the current information in the Register at the time the search is executed, However, Search By Serial Number and Search By Grantor can be executed as a “point-in-time” search. This is a search that reflects the Register at a point in time in the past. The details of the Registrations returned in the search result will be the details that were current at the point in time of the search. Only authorised internal users are able to perform point-in-time searches.

4.5.1.4 Access Restrictions

A Registration may have access restrictions placed upon it. These restrictions are used by the PPS Registrar if it is necessary to remove a registration from the Register or to limit the details of a registration that are returned in a search of the Register. In general, searches of the Register will only return current Registrations. Only authorised internal users are able to retrieve details for registrations that have restrictions applied.

If, when retrieving a search result, access restrictions have been placed on a Registration since the time of the original search, the Registration will still be included in the search result. However the details of the Registration will be limited by the level of authorisation for the user.

2 Note that the search declaration may also be required when searching for an organisation Grantor described by ABN. If this becomes the case it will be included in a later release of this document.


UNCLASSIFIED

4.5.1.5 “Exact” Match

In general, Registrations must match specified search criteria exactly in order to be returned in a search result. However, some leeway is provided for some search criteria for Search By Grantor and Search By Serial Number to return “close” matches.

However, it is important to note that searches do not allow for the use of wild cards as search criteria. This is particularly important, for example, when searching by individual Grantors where Family Name, Given Names and Date of Birth must all be provided as search criteria.

4.5.1.6 Search Result Access Expiry and Search Certificate Access Expiry

When a search is executed, the search result will be available for processing on PPSR for a period of time. During this time the search result can be retrieved again, filtered, and the attachments downloaded. This time is called the search result access period. The expiry time of the search result access period may be returned in the response message for a search. This expiry time may not be shown while there is no fee charged for retrieving the search result after the search result access period has expired.

After the search result access period has expired, a call to the Retrieve Search Result operation must be used before any further processing on the PPSR of the search result. This will establish a further search result access period. The expiry time of the new search result access period will be returned in the response message for the Retrieve Search Result operation. Note that if the Retrieve Search Result operation is called before the end of the current search result access period, the expiry time of the search result access period returned will be the current expiry time.

Calling an operation to work with a search result when the search result access period has expired will result in an error. The Retrieve Search Result operation must be called to begin a new search result access period.

It is possible that a fee may be charged to retrieve a search result from PPSR at a time after the original search was performed. If such a fee is charged, it will only be charged if the search result is retrieved after the expiry of the search result access period.

When a search certificate is requested, the search certificate will remain available on PPSR for retrieval at a later time. It is possible that a fee may be charged to retrieve a search certificate from PPSR at a later time. At the time the search certificate is requested, the expiry time of the search certificate access period will be returned in the response message. The expiry time of the search certificate access period will also be returned in the response message for the Retrieve Search Certificate operation. If a fee is charged to retrieve a search certificate at a later time, it will only be charged if the search certificate is retrieved after the expiry of the search certificate access period.


UNCLASSIFIED

During the search certificate access period, the search certificate can be downloaded multiple times. If the search certificate is for a single registration that has one or more attachments, the attachments can be downloaded during the search certificate access period.

If a search certificate is retrieved after the search certificate access period, a further search certificate access period will be established. The expiry time of the new search certificate access period will be returned in the response message for the Retrieve Search Certificate operation. Calling the Retrieve Search Certificate Registration Attachment operation when the search certificate access period has expired will result in an error. The Retrieve Search Certificate operation must be called to begin a new search certificate access period.

4.5.1.7 Search Operation Usage

Each of the five search type operations has different messages, but all follow a common structure.

Each type of search is performed synchronously and has a request message and a response message:

The request message contains the search criteria for the required search

The response message contains a number of fields that are common to all search types, such as the Search Number and search result expiry time, and result details that are specific to the type of search

For some search types the response message will contain all the information required for the search and no further operations need to be called. For some search types, separate operations may need to be called to retrieve all the details available.

The response message for Ordinal Search contains the full search result details and no further information is available for the search result. Further information about a Registration in an Ordinal Search can be found by performing a Search By Registration Number, however this is treated as a completely separate search.

The response message for Search By Registration Number contains the full current details of the Registration and a summary of the change history of the Registration. In order to return an attachment for a Registration or the full details of an earlier version of the Registration from the change history, it is necessary to call separate operations (Retrieve Search Result Registration Attachment, Retrieve Registration History Detail).

The response message for Search By Serial Number contains the full current details of all Registrations that matched the search criteria and a summary of the change history of each Registration. In order to return an attachment for one of the Registrations or the full details of an earlier


UNCLASSIFIED

version of one of the Registrations, it is necessary to call separate operations (Retrieve Search Result Registration Attachment, Retrieve Registration History Detail).

The response message for both Search By Grantor and Search By Grantor And Event Date Range only contains a count of the number of Registrations that matched the search criteria. In order to retrieve the full current details of matching Registrations it is necessary to call a separate operation (Retrieve Grantor Search Result Detail), which can be used to retrieve the Registrations in the search result. In order to return an attachment for one of the Registrations or the full details of an earlier version of one of the Registrations, it is necessary to call separate operations (Retrieve Search Result Registration Attachment, Retrieve Registration History Detail). A feature of working with the search result for Search By Grantor or Search By Grantor And Event Date Range is the ability to filter the search result, using a separate operation (Filter Grantor Search Result or Filter Grantor And Event Date Range Search Result).

For any search type, a search certificate can be requested using the Request Search Certificate operation. The search certificate will be produced asynchronously. Production of the search certificate will be queued for immediate processing and most certificates should be available within a matter of seconds. However, as many search certificates will require verifications to be undertaken with systems external to PPSR (e.g. verification of Grantor ACNs with ASIC) the time required to produce the certificate will depend upon the number of verifications required for the certificate and the overall demand for verifications with external systems. The search certificate can be retrieved using the Retrieve Search Certificate operation. If the search certificate is for a single registration that has one or more attachments, the attachments can be downloaded using the Retrieve Search Certificate Registration Attachment operation.


UNCLASSIFIED


4.5.2.1 PpsrCollateralRegistrationSearchFaultDetail

PpsrCollateralRegistrationSearchFaultDetail



PpsrCollateralRegistrationSearchFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

4.5.2.2 PpsrCollateralRegistrationSearchValidationFaultDetail

PpsrCollateralRegistrationSearchValidationFaultDetail






PpsrCollateralRegistrationSearchValidationFaultDetail



UNCLASSIFIED


1..1 ValidationErrors List<PpsrValidationError> A list of validation errors related to the search or filter criteria.




UNCLASSIFIED

4.5.3 Common Search Classes

This section describes classes that are common to more than one Collateral Registration Search Service operation.

4.5.3.1 Search Summary

The SearchSummary class contains information that is common to all search types and is provided in the response message to the initial search and also when search results are retrieved at a later time.

The SearchSummary includes the date and time of expiry of the search result access period (see section 4.5.1.6 Search Result Access Expiry and Search Certificate Access Expiry).

If a request to work with the search result (e.g. retrieving a previous version of a Registration in the search result, retrieving an attachment for a Registration in the search result, filtering the search result) is made after the search result access period expires, it will be necessary to call the Retrieve Search Result operation. This will begin a new access period. The new search result access expiry time will be included in the SearchSummary returned in the response to the Retrieve Search Result operation.

SearchSummaryClass

PropertiesAccessToSearchResultExpiryTime : DateTimeResultCount : intSearchExecutedDateTime : DateTimeSearchNumber : string

SearchTypeEnum

UnsupportedSearchByRegistrationNumberSearchBySerialNumberSearchByGrantorSearchByGrantorAndEventDateRangeOrdinalSearch

SearchType


SearchSummary 1..1 SearchNumber string(16) The Search Number of the search. This number can be used to retrieve a search result at a later time. The Search Number is also used to


UNCLASSIFIED

perform other operations related to the search result.

1..1 SearchExecutedDateTime dateTime The date and time the search was executed on PPSR.

1..1 ResultCount int The number of registrations returned from the search.For Search by Registration Number the result count will be either 1 or 0. If the registration Number specified in the search criteria does not exist on the Register the result count will be 0.For Ordinal Search the result count will always be 1.

0..1 AccessToSearchResultExpiryTime dateTime The date and time of expiry of the search result access period. See section 4.5.1.6 Search Result Access Expiry and Search Certificate Access Expiry for details.

1..1 SearchType SearchType The type of search executed. See section 5.20 SearchType for details.

4.5.3.2 Filter Summary

The FilterSummary class contains information that is common to the Filter Grantor Search Result and Filter Grantor And Event Date Range Search Result operations and is provided in the response message for these operations.

FilterSummaryClass

PropertiesFilterExecutedDateTime : DateTimeFilterNumber : intResultCount : intSearchNumber : string


UNCLASSIFIED


FilterSummary 1..1 SearchNumber string(16) The Search Number of the search that has been filtered.

1..1 FilterNumber int The Filter Number that applies to the filtering of the search result. See section 4.5.6 Search By Grantor for an explanation of Filter Number.

1..1 FilterExecutedDateTime dateTime The date and time the filter was executed on PPSR.

1..1 ResultCount int The number of registrations returned from the filtering of the search result.

4.5.3.3 Result Detail

The ResultDetail class contains information for a single Registration that is returned in a search result. Where more than one Registration is returned by a search, the ResultDetail will be provided for each Registration.

The structure is illustrated in the diagram below. The following describes the four main elements of the ResultDetail class:

4.5.3.3.1 ResultSequenceNumber

The ResultSequenceNumber is an integer that uniquely identifies the position of the Registration in the ordered sequence of all Registrations included in the search result, or after applying a filter to the search result (Search By Grantor and Search By Grantor and Event Date Range only).

For Search By Registration Number, the ResultSequenceNumber will always be 1.

For Search By Serial Number, Search By Grantor and Search By Grantor and Event Date Range, the ResultSequenceNumber of the first Registration in the search result (or filtered search result) will be 1, and then continue in an unbroken sequence incremented by 1 for each Registration, such that the last Registration in the result has a ResultSequenceNumber equal to the total number of Registrations returned by the search or filter operation.


UNCLASSIFIED

The ResultSequenceNumber will be null when the ResultDetail is included in the response to the Retrieve Registration History Detail operation.

4.5.3.3.2 RestrictionDetail

A Registration may have a number of flags associated with it that describe the state of the Registration. Generally a Registration that has any of these flags set is not returned in a search result unless that state is specifically requested in the search criteria. Usually Registrations with any of these states are only accessible to the Registrar, but a subset of the Registration data can be returned for certain search types (in particular Search By Registration Number).

If, when retrieving a search result, access restrictions have been placed on a Registration since the time of the original search, the Registration will still be included in the search result however the details of the Registration will be limited by the level of authorisation for the user.

The restriction flags are:

IsRemoved – indicates that the Registrar has removed the Registration from the Register. If a user that has not been authorised for access to removed Registrations performs a Search By Registration Number for a removed Registration, they will be informed that the Registration has been removed but will not be able to retrieve any details for the Registration unless that registration has been made available for searching by the Registrar.

IsArchived – indicates that the Registration has been archived and is no longer generally available for searching. If a user that has not been authorised for access to archived Registrations performs a Search By Registration Number for an archived Registration, they will be informed that the Registration has been archived but will not be able to retrieve any details for the Registration.

IsAccessRestricted – indicates that the Registrar has marked the Registration as “access is restricted”. Restricted access Registrations can be included in a search result for all users of PPSR. However, full details of a restricted access Registration can only be made available to users that have been authorised by the Registrar. If a user has not been authorised for access to restricted access Registrations, the only information provided about the Registration is the Registration Number and the Registration End Time.

4.5.3.3.3 RegistrationDetail

The RegistrationDetail class contains the current details of the Registration returned in a search result. The RegistrationDetail class will be populated for a Registration that is included in the search result unless there is a restriction flag set and the Account Customer is not authorised to access Registrations with the particular restriction.


UNCLASSIFIED

If the search result is for a point-in-time search (a search that reflects the Register at a time in the past) the “current” details of the Registration will be the details that were current at the point in time of the search.

If the search result is for a Search By Grantor And Event Date Range search, the “current” details of the Registration will be the details that were current at the time of the Registration event (that is, the details of version of the Registration in its Registration history as a result of the Registration event).

The RegistrationDetail class is also used for the earlier versions of a Registration when retrieved using the Retrieve Registration History Detail operation. The “current” details of the Registration will be the details of the specific version of the Registration.

4.5.3.3.4 ChangeHistory

The ChangeHistory class contains a summary list of all the changes that have been made to the Registration returned in a search result. This includes the initial creation of the Registration on the Register. The only details included in the summary are the Change Number, the type of change, and the date and time of the change. The Change Number of a change can be used to drill down to retrieve the details of the Registration after each change. The only changes included in the list of changes are the changes up to and including the current information, as at the time of the search, for the Registration. Even if the search result is retrieved at a time after the initial search time, when further changes have been made to a Registration included in the search result, only changes up to the time the initial search was performed will be included in the list of changes.

If the search result is for a “point-in-time” search (a search that reflects the Register at a time in the past) the list of changes will only include changes up to the point-in-time of the search.

If the search result is for a Search By Grantor And Event Date Range, (a search that returns the version of a registration as at the time of an event that occurred for that registration during a specified date range – see section 4.5.7 Search By Grantor And Event Date Range), the list of changes will only include changes up to the version of the registration that is included in the search result.

The ChangeHistory class will be populated for a Registration that is included in the search result unless there is a restriction flag set and the Account Customer is not authorised to access Registrations with the particular restriction.

The ChangeHistory class will not be populated for a Registration when the ResultDetail is included in the response to the Retrieve Registration History Detail operation.


UNCLASSIFIED

ResultDetailClass

PropertiesRegistrationDetail : RegistrationDetailResultSequenceNumber : short?

ChangeHistoryClass

RestrictionDetailClass

PropertiesIsAccessRestricted : bool?IsArchived : boolIsRemoved : boolRegistrationNumber : string

RemovalDetailClass

PropertiesRemovalReasonDescription : stringRemovalReasonFurtherDetails : string

ChangeDetailClass

PropertiesChangeNumber : longRegistrationChangeTime : DateTime

RestrictedAccessDetailClass

PropertiesRegistrationEndTime : DateTime?RestrictedAccessReasonDescription : string

ChangeTypeEnum

UnsupportedCreateAmendDischargeRemoveReinstateAddressForServiceChangeTransfer

RestrictionDetail

ChangeHistory ChangeDetails : List<ChangeDetail>

RemovalDetail

RestrictedAccessDetail

ChangeType


UNCLASSIFIED


UNCLASSIFIED

CollateralRegistrationSecuredPartyClass









SecuredPartyType

Individual Organisation



UNCLASSIFIED


UNCLASSIFIED

GrantorSearchDetailClass

GrantorIndividualSearchDetailClass




GrantorTypeEnum




GrantorType




ResultDetail 0..1 ResultSequenceNumber short The sequence number of the registration in the search result.This will be null when the ResultDetail is included in the response to the Retrieve Registration History Detail operation.

0..1 RestrictionDetail RestrictionDetail The details of any restrictions on the registration.These restrictions include Removed, Archived or Access is Restricted.


UNCLASSIFIED


0..1 RegistrationDetail RegistrationDetail The current details of the registration.This will be null if there is a restriction flag set and the Account Customer is not authorised to access Registrations with the particular restriction.Note that if the search is a point-in-time search, the details will be those that were current at the point in time.If the RegistrationDetail is returned for an earlier version of a registration from its change history, this will be the details that were current at the time of the change.

0..1 ChangeHistory ChangeHistory The change history of the registration returned from the search.This will be null if there is a restriction flag set and the Account Customer is not authorised to access Registrations with the particular restriction.This will be null when the ResultDetail is included in the response to the Retrieve Registration History Detail operation.

RestrictionDetail 1..1 RegistrationNumber string(20) The Registration Number of the registration.

1..1 IsRemoved boolean Indicates whether the registration has been removed.

1..1 IsArchived boolean Indicates whether the registration is archived.

0..1 IsAccessRestricted boolean Indicates whether the registration has been marked as Access is Restricted.This will be null if the registration has been removed or is archived and the Account Customer is not authorised to access removed or archived registrations.

0..1 RestrictedAccessDetail RestrictedAccessDetail If IsAccessRestricted is “true”, this contains the limited details that can be provided for restricted access Registrations.If IsAccessRestricted is “false” or null, this will be null.

0..1 RemovalDetail RemovalDetail If IsRemoved is “true” this provides details of the reason for removal.

If IsRemoved is “false” this will be null.


UNCLASSIFIED


RestrictedAccessDetail 0..1 RegistrationEndTime dateTime The date and time that the registration will expire. This will be null if the end time of the registration is not stated.

0..1 RestrictedAccessReasonDescription

string(200) The reason the registration has been marked Access is Restricted.If the B2G Account Customer is not authorised to access a restricted access registration, this will be null.

RemovalDetail 0..1 RemovalReasonDescription string(200) The reason why the registration was removed.If the B2G Account Customer is not authorised to access removed registrations, this will be null.

0..1 RemovalReasonFurtherDetails string(200) Optional additional information related to the removal of the registration.If the B2G Account Customer is not authorised to access removed registrations, this will be null.

RegistrationDetail 1..1 RegistrationNumber string(20) The Registration Number of the registration.

1..1 ChangeNumber long The Change Number of the current version of the registration.

0..1 EarlierRegistrationNumber string(20) The Registration Number of an earlier registration where the earlier registration relates to the same security interest.

1..1 IsTransitional boolean Indicates if the registration is for an interest that existed prior to the registration commencement time of PPSR.

1..1 IsMigrated boolean Indicates if the registration was migrated from an existing register.

1..1 RegistrationStartTime dateTime The date and time the registration was first registered in PPSR.

0..1 RegistrationEndTime dateTime The date and time that the registration will expire. This will be null if the end time of the registration is not stated.

1..1 RegistrationChangeTime dateTime The date and time that this version of the registration was amended (or created if this is the first version of the registration).

1..* SecuredParties List<CollateralRegistrationSecuredParty> The Secured Parties for the registration.

0..* Grantors List<GrantorSearchDetail> The Grantors for the registration.


UNCLASSIFIED


0..1 GivingOfNoticeIdentifier string(50) An optional identifier that a Secured Party Group has specified for the registration.

1..1 AddressForService AddressForServiceSearchDetail The Address for Service for the registration.

1..1 RegistrationKind string(200) The RegistrationKind of the registration. See section 2.2.9 Registration Kinds for details.

1..1 IsSecurityInterestRegistrationKind boolean Indicates whether the registration is for a security interest.If “true”, the Registration Kind is a security interest.If “false”, the Registration Kind is not a security interest.

1..1 CollateralType CollateralType The Collateral Type of the registration. See section 5.5 CollateralType for details.

1..1 CollateralClassType CollateralClassType The Collateral Class of the registration. See section 5.4 CollateralClassType for details.

1..1 CollateralClassDescription string(200) This provides a description of the Collateral Class of the registration, including any parent class. For example, if the registration is for a Trade Mark, the description of the collateral would be “Intangible property / Intellectual property / Trade mark”.

0..1 SerialNumberDetails SerialisedCollateralDescription If the collateral in the registration is described by a serial number, the SerialNumberDetails element contains the details of the serial number.

0..1 CollateralDescription string(500) A free text description of the collateral.

0..1 IsPMSI ExtendedBooleanType Whether the registration is a purchase money security interest (PMSI).See section 5.6 ExtendedBooleanType.If not specified, whether the registration is a PMSI is not relevant.

0..1 IsInventory ExtendedBooleanType Whether the collateral is inventory. See section 5.6 ExtendedBooleanType.If not specified, whether the collateral is inventory is not relevant.

0..1 AreAssetsSubjectToControl ExtendedBooleanType Whether the collateral is an asset subject to control. See section 5.6 ExtendedBooleanType.If not specified, whether the collateral is an asset subject to control is not relevant.


UNCLASSIFIED


0..1 AreProceedsClaimed ExtendedBooleanType Whether or not proceeds are claimed. See section 5.6 ExtendedBooleanType.If not specified, whether or not proceeds are claimed is not relevant.

0..1 ProceedsClaimedDescription string(500) A free text description of the proceeds claimed.

1..1 IsSubordinate boolean Whether the registration is subordinate to another security interest. A value of “true” indicates the registration is subordinate to another security interest. A value of “false” indicates that whether or not the registration is subordinate to another security interest is not stated.

0…* Attachments List<AttachmentDetail> If the registration has any attachments, the Attachments element contains details of the attachments.Note that this element does not contain the actual attachment file. The RetrieveSearchResultRegistrationAttachment operation is used to retrieve the actual attachment file. See section 4.5.10 Retrieve Search Result RegistrationAttachment.

0..1 MigrationDetail MigrationDetail If the registration is a migrated registration (IsMigrated will be “true”), this will contain further details that relate to migrated registrations.

0..1 RegistrarAlert string(2000) A message giving details of abnormal changes to the registration.

SerialisedCollateralDescription 1..1 SerialNumberType SerialNumberType The type of the serial number used to describe the collateral. See section 5.23 SerialNumberType for details.


0..1 AdditionalVehicleDetails AdditionalVehicleCollateralDescription If the collateral being described by serial number is for the Collateral Class of Motor Vehicle, the AdditionalVehicleDetails will be populated.If the collateral being described by serial number is for any other Collateral Class, the AdditionalVehicleDetails will be null.


UNCLASSIFIED


0..1 AdditionalAircraftDetails AdditionalAircraftCollateralDescription If the collateral being described by serial number is for one of the following Collateral Classes: Aircraft Engine Airframe Helicopter Small Aircraftthe AdditionalAircraftDetails will be populated.If the collateral being described by serial number is for any other Collateral Class, the AdditionalAircraftDetails will be null.

AdditionalVehicleCollateralDescription 0..1 VehicleRegistrationNumber string(20) The registration plate number of the vehicle.

0..1 VehicleDescriptiveText string(500) If the type of serial number used to describe the collateral is a Motor Vehicle Manufacturer's Number, a free text description of the vehicle.

AdditionalAircraftCollateralDescription 0..1 ManufacturersName string(100) The name of the manufacturer.

0..1 ManufacturersModel string(50)




CollateralRegistrationSecuredParty 1..1 SecuredPartyType SecuredPartyType Indicates whether the Secured Party is an organisation or an individual. See section 5.21 SecuredPartyType for details.



SecuredPartyOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details. There is a value for OrganisationNumberType only if the Secured Party is an organisation that is identified in PPSR by its organisation number.


UNCLASSIFIED



0..1 OrganisationName string(250) The name of the organisation.If the Secured Party is an organisation that is identified in PPSR by its organisation name, this will be the name of the organisation specified when the Secured Party Group for the registration was created.If the Secured Party is an organisation that is identified in PPSR by its organisation number, this will be the name of the organisation retrieved from ASIC (for ACN, ARSN, ARBN) or ABR (for ABN) for the organisation number. If the organisation number does not exist in ASIC or ABR, or ASIC/ABR has not been successfully contacted yet to verify the organisation number, then the OrganisationName will be null.



GrantorSearchDetail 1..1 GrantorType GrantorType Indicates whether the Grantor is an organisation or an individual. See section 5.7 GrantorType for details.

0..1 Organisation GrantorOrganisation If the grantor is an organisation, the details of the organisation.

0..1 Individual GrantorIndividualSearchDetail If the grantor is an individual, the details of the individual.

GrantorOrganisation 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.There is a value for OrganisationNumberType only if the Grantor is an organisation that is identified in PPSR by its organisation number.

0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.There is a value for OrganisationNumber only if the Grantor is an organisation that is identified in PPSR by its organisation number.


UNCLASSIFIED


0..1 OrganisationName string(250) The name of the organisation. There is a value for OrganisationName only if the Grantor is an organisation that is identified in PPSR by its organisation name.


IdentifierVerificationStatusType Indicates whether ASIC/ABR was able to be contacted to verify the organisation number, and if ASIC/ABR was able to be contacted, indicates whether the organisation number was verified as valid by ASIC/ABR.See section 5.8 IdentifierVerificationStatusType for details.

GrantorIndividualSearchDetail 0..1 FamilyName string(40) The family name of the grantor.This will be populated only when the Collateral Type of the registration is Commercial and the grantor is the grantor that was specified in the search criteria.In all other cases for an individual grantor, the family name will not be populated. The presence of the GrantorIndividualSearchDetail indicates that there is an individual grantor recorded for the registration, but no details of the individual grantor will be displayed.

0..1 GivenNames string(80) The given names of the grantor.This will be populated only when the Collateral Type of the registration is Commercial and the grantor is the grantor that was specified in the search criteria.In all other cases for an individual grantor, the given names will not be populated. The presence of the GrantorIndividualSearchDetail indicates that there is an individual grantor recorded for the registration, but no details of the individual grantor will be displayed.

AddressForServiceSearchDetail 0..1 Addressee string(50) If an addressee has been specified in the Address for Service, this will be the addressee.If an addressee has not been specified in the Address for Service, this will be null.



UNCLASSIFIED



1..1 MailingAddress Address The postal mail address specified in the Address for Service.





0..1 Line2 string(50) The second line of the address.

0..1 Line3 string(50) The third line of the address.









UNCLASSIFIED


1..1 IsMigratedAttachment boolean For registrations that were migrated from other registers prior to commencement of PPSR, an attachment may have been created when the Registration was migrated from its source register that contains additional data provided by the source register that is not supported by PPSR.IsMigratedAttachment indicates whether the attachment is such an attachment.Note that attachments that existed in source registers prior to migration to PPSR and have been brought across to PPSR are not migrated attachments and the value of IsMigratedAttachment will be “false”.

MigrationDetail 1..1 SourceRegister string(200) The name of the register the registration was migrated from.

0..1 OriginalStartDate dateTime(40) The original start date of the registration as recorded on the source register.Note that null value may be returned if there is non-conformant source data.

ChangeHistory 0..* ChangeDetails List<ChangeDetail> A summary list of all the changes that have been made to the Registration.

ChangeDetail 1..1 ChangeNumber long The Change Number for this change.

1..1 ChangeType ChangeType The type of change to the Registration. See section 5.1 ChangeType for details.

1..1 RegistrationChangeTime dateTime The date and time of this change.


UNCLASSIFIED

4.5.4 Search By Registration Number

This operation is used to search the Register for a Registration with a specific Registration Number.

If there is no Registration on the Register with the specified Registration Number, the Result Count in the Search Summary of the response message will be 0 and the Result Detail in the response message will be empty.

If there is a Registration on the Register with the specified Registration Number, the Result Count in the Search Summary of the response message will be 1 and the Result Detail in the response message will be populated. However, the Registration Detail in the Result Detail will only be populated if the Registration is:

a current, expired (including discharged) Registration,

the Registration has a restriction flag set and the Account Customer is authorised to access Registrations with the particular restriction or

the Registration has been Removed and made available for searching by the Registrar.


Service Name: CollateralRegistrationSearch

Operation Name: SearchByRegistrationNumber

Request: SearchByRegistrationNumberRequestMessage

Response: SearchByRegistrationNumberResponseMessage


UNCLASSIFIED

4.5.4.2 Common Search By Registration Number Classes

4.5.4.2.1 SearchByRegistrationNumberSearchCriteria

This class contains the criteria used to search for a Registration with a specific Registration Number. The sole criteria for Search By Registration Number is the Registration Number of the Registration to return.

SearchByRegistrationNumberSearchCriteriaClass



SearchByRegistrationNumberSearchCriteria 1..1 RegistrationNumber string(20) The Registration Number of the Registration to return.

4.5.4.2.2 SearchByRegistrationNumberSearchResult

SearchByRegistrationNumberSearchResultClass

PropertiesResultDetail : ResultDetailSearchResultRetrievedDateTime : DateTime


UNCLASSIFIED


SearchByRegistrationNumberSearchResult 0..1 ResultDetail ResultDetail See section 4.5.3.3 Result Detail for details.If there is no Registration on the Register with the specified Registration Number, the Result Detail in the response message will be null.If there is a Registration on the Register with the specified Registration Number, the Result Detail in the response message will be populated.

1..1 SearchResultRetrievedDateTime dateTime The date and time the result of the search was retrieved. This is not the date and time the search was executed (which will be in the SearchSummary in the response message). The search result may be retrieved at a time after the search was executed.


4.5.4.3.1 SearchByRegistrationNumberRequestMessage

SearchByRegistrationNumberRequestMessage


SearchByRegistrationNumberRequestType


PropertiesSearchCriteria : SearchByRegistrationNumberSearchCriteria

SearchByRegistrationNumberRequest


UNCLASSIFIED


SearchByRegistrationNumberRequestMessage


1..1 SearchByRegistrationNumberRequest

SearchByRegistrationNumberRequestType

SearchByRegistrationNumberRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SearchCriteria SearchByRegistrationNumberSearchCriteria

See section 4.5.4.2.1 SearchByRegistrationNumberSearchCriteria for details.

4.5.4.3.2 SearchByRegistrationNumberResponseMessage

SearchByRegistrationNumberResponseMessageClass

SearchByRegistrationNumberResponseType


PropertiesPpsrTransactionId : longSearchCriteria : SearchByRegistrationNumberSearchCriteriaSearchResult : SearchByRegistrationNumberSearchResultSearchSummary : SearchSummary

SearchByRegistrationNumberResponse


SearchByRegistrationNumberResponseMessage

1..1 SearchByRegistrationNumberResponse



UNCLASSIFIED





1..1 SearchSummary SearchSummary See section 4.5.3.1 Search Summary for details.

1..1 SearchCriteria SearchByRegistrationNumberSearchCriteria See section 4.5.4.2.1 SearchByRegistrationNumberSearchCriteria for details.This is a repeat of the search criteria in the request message.

1..1 SearchResult SearchByRegistrationNumberSearchResult See section 4.5.4.2.2 SearchByRegistrationNumberSearchResult for details.



4.5.4-10 The SearchByRegistrationNumberRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.5.4-20 The SearchCriteria element must be provided. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41052

4.5.4-30 The value provided for RegistrationNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41000

4.5.4-41 The value provided for the RegistrationNumber must be a 15 digit number. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41100


UNCLASSIFIED

4.5.5 Search By Serial Number

This operation is used to retrieve Registrations for an item of collateral that is described by a specific serial number. Normally this search only returns current registrations and limited details for restricted access Registrations. Only authorised users can retrieve expired/discharged, removed and archived Registrations.

Note that there can be multiple current registrations against a single serial number (though in most circumstances it is expected there will only be a single current registration).

Search By Serial Number can be executed as a “point-in-time” search. This is a search that reflects the Register at a point in time in the past. The details of Registrations included in the search result will be the details that were current at the point in time of the search. Only authorised users are able to perform point-in-time searches.

A search result for a Search By Serial Number for a motor vehicle may include data from NEVDIS (National Exchange of Vehicle and Driver Information System) for the specified serial number. Whether NEVDIS is called for a particular search will depend on the type of motor vehicle serial number entered in the search criteria and also upon the Registrations that are matched against the search criteria. NEVDIS will always be called when the search criteria is for a VIN or Chassis Number. NEVDIS will not normally be called when the search criteria is for a Motor Vehicle Manufacturer’s Number, unless there is a Registration with a VIN, Chassis Number or Unknown Motor Vehicle Identifier that is the same value as the Motor Vehicle Manufacturer’s Number specified in the search criteria.

NEVDIS will never be called when the search is a point-in-time search. This is because NEVDIS only provides current information and not information that was current at the point in time of the search.

PPSR will only make one attempt to contact NEVDIS for the search result. If NEVDIS does not respond, the NEVDIS data in the response will not be populated and a message advising this will be provided.



Operation Name: SearchBySerialNumber


UNCLASSIFIED

Request: SearchBySerialNumberRequestMessage

Response: SearchBySerialNumberResponseMessage

4.5.5.2 Common Search By Serial Number Classes

4.5.5.2.1 SearchBySerialNumberSearchCriteria

This class contains the criteria used to search for Registrations for an item of collateral that is described by a specific serial number.

The main criteria are the type of serial number and the value of the serial number.

Authorised users also have the option to specify the point in time to search the Register, and whether the search results should include expired/discharged, removed or archived Registrations.

SearchBySerialNumberSearchCriteriaClass

PropertiesIncludeArchived : boolIncludeCurrent : boolIncludeExpired : boolIncludeRemoved : boolPointInTimeDateTime : DateTime?SerialNumber : string

SerialNumberSearchCriteriaTypeEnum

UnsupportedVINChassisNumberMotorVehicleManufacturersNumberHINOfficialNumberAircraftEngineManufacturersNumberAirframeManufacturersNumberHelicopterManufacturersNumberAircraftNationalityCodeAndRegistrationMarkPatentNumberTradeMarkNumberDesignNumberPlantBreedersRightNumber

SerialNumberType


UNCLASSIFIED


SearchBySerialNumberSearchCriteria 1..1 SerialNumberType SerialNumberSearchCriteriaType The type of the serial number to search for. See section 5.22 SerialNumberSearchCriteriaType for details.

1..1 SerialNumber string(50) The value of the serial number to search for.

0..1 PointInTimeDateTime dateTime A date and time in the past that is the point in time to search the register.A value can only be provided if the Account Customer is authorised to perform point-in-time searches.

1..1 IncludeCurrent boolean If “true”, current registrations will be included in the search result.If “false”, current registrations will not be included in the search result.If an Account Customer is not authorised to retrieve expired/discharged, archived or removed registrations, then IncludeCurrent must be “true”.

1..1 IncludeExpired boolean If “true”, expired/discharged registrations will be included in the search result.If “false”, expired/discharged registrations will not be included in the search result.If an Account Customer is not authorised to retrieve expired/discharged registrations, then IncludeExpired must be “false”.

1..1 IncludeArchived boolean If “true”, archived registrations will be included in the search result.If “false”, archived registrations will not be included in the search result.If an Account Customer is not authorised to retrieve archived registrations, then IncludeArchived must be “false”.

1..1 IncludeRemoved boolean If “true”, removed registrations will be included in the search result.If “false”, removed registrations will not be included in the search result.If an Account Customer is not authorised to retrieve removed registrations, then IncludeRemoved must be “false”.


UNCLASSIFIED

4.5.5.2.2 SearchBySerialNumberSearchResult

SearchBySerialNumberSearchResultClass

PropertiesNevdisData : NevdisDataResultDetails : List<ResultDetail>SearchResultRetrievedDateTime : DateTimeTransitionalPeriodMessage : string


SearchBySerialNumberSearchResult 0..* ResultDetails List<ResultDetail> A list of registrations that match the search criteria.See section 4.5.3.3 Result Detail.

1..1 SearchResultRetrievedDateTime dateTime The date and time the result of the search was retrieved. This is not the date and time the search was executed (which will be in the SearchSummary in the response message). The search result may be retrieved at a time after the search was executed.

0..1 TransitionalPeriodMessage string(200) A message that will only be included during the transitional period. This message is used to indicate that some registrations may not be on the register.After the end of the transitional period this will always be null.

0..1 NevdisData NevdisData If the search is for a motor vehicle and NEVDIS has been called, this will contain the data retrieved from NEVDIS.See section 4.5.5.2.3 NevdisData for details of the NEVDIS data.


UNCLASSIFIED

4.5.5.2.3 NevdisData

The NevdisData class is used to return data received by PPSR from NEVDIS. This is used to provide information from NEVDIS in a search result for a Search By Serial Number for a motor vehicle search.

If a B2G Account Customer wants to convey any of the information related to NEVDIS to the end user (e.g. on a screen or printed report), the B2G Account Customer will need to provide information in a form approved by the Registrar.


UNCLASSIFIED

NevdisDataClass

NevdisVehicleClass

NevdisVehicleDetailClass

PropertiesJurisdiction : stringJurisdictionParticipation : bool

NevdisVehicleIdentifierClass

PropertiesIdentifierValue : string

NevdisRegistrationClass

PropertiesExpiryDate : stringPlateNumber : string

NevdisVehicleDescriptionClass

PropertiesBodyType : stringColour : stringComplianceYearMonth : stringEngineNumber : stringMake : stringManufactureYear : stringModel : stringVehicleType : string

IdentifierVerificationStatusTypeEnum

UnsupportedFoundNotFoundNotVerifiedNotPerformed

NevdisVehicleIdentifierTypeEnum

UnsupportedVINChassisNumber

StolenDetailClass

PropertiesStolenSummary : string

WrittenOffDetailClass

PropertiesWrittenOffSummary : string

VerificationStatus

NevdisVehicles : List<NevdisVehicle>

VehicleIdentifier

VehicleDetail

VehicleDescriptionRegistration

IdentifierType

StolenDetails : List<StolenDetail>

WrittenOffDetails : List<WrittenOffDetail>


UNCLASSIFIED


NevdisData 1..1 VerificationStatus IdentifierVerificationStatusType Indicates whether NEVDIS was able to be contacted to verify the vehicle identifier, and if NEVDIS was able to be contacted, indicates whether a matching vehicle record was found. If at least one matching vehicle record was found, the details of each matching vehicle will be provided in the NevdisVehicles element.See section 5.8 IdentifierVerificationStatusType for details.If the VerificationStatus is “NotVerified” and the B2G Account Customer wishes to convey this information to the end user (e.g. on a screen or printed report), the form of words used in the explanation will need to be in an approved form agreed with the Registrar.If the Verification Status is “Found” and the B2G Account Customer wishes to convey ‘NEVDIS Data’ data to the end user (e.g. on a screen or printed report), the form of words used will need to be in an approved form agreed with the Registrar.The approved form for the conveying of data under this note is the way the data would appear on a search certificate or verification statement including any disclaimers and interpretive notes. This means that either a search certificate or verification statement provided in .pdf format over the B2G channel would suffice for the purposes of this note.

0..* NevdisVehicles List<NevdisVehicle> If verification with NEVDIS was successful (VerificationStatus is either “Found” or “NotFound”), this will contain a list of all matching vehicles returned from NEVDIS. The list will be empty if the VerificationStatus is “NotFound”.If verification with NEVDIS was unsuccessful (VerificationStatus is “NotVerified”) the NevdisVehicles element will be null,

NevdisVehicle 1..1 VehicleIdentifier NevdisVehicleIdentifier Provides the identifier of the matched vehicle.

1..1 VehicleDetail NevdisVehicleDetail Provides details of the matched vehicle.

0..* StolenDetails List<StolenDetail> Provides a list of stolen restriction records related to the matched vehicle. If the vehicle or


UNCLASSIFIED


some component of the vehicle (e.g. plates, engine) has been reported as stolen, there can be a separate stolen restriction against each identifier related to the vehicle.The list will be empty if there are no stolen restriction records returned from NEVDIS.

0..* WrittenOffDetails List<WrittenOffDetail> Provides a list of written-off records related to the matched vehicle. A vehicle can be written-off as a repairable write-off, repaired and then written-off again, so there can be multiple records for a vehicle.The list will be empty if there are no written-off records returned from NEVDIS.

NevdisVehicleIdentifier 1..1 IdentifierType NevdisVehicleIdentifierType Indicates whether the matched vehicle was matched on a VIN or Chassis Number.See section 5.9 NevdisVehicleIdentifierType for details.

1..1 IdentifierValue string(50) The value of the VIN or Chassis Number of the matched vehicle.

NevdisVehicleDetail 0..1 Jurisdiction string(3) The state or territory of the most recent vehicle registration recorded for the vehicle.The value can be null if the vehicle has never been registered.

0..1 JurisdictionParticipation boolean Indicated whether or not the state or territory of the most recent vehicle registration recorded for the vehicle has agreed to participate in providing vehicle and registration information for PPSR.If the value is “false”, the Registration and VehicleDescription elements will not be populated.The value can be null if the vehicle has never been registered.

0..1 Registration NevdisRegistration Details of the most recent vehicle registration recorded for the vehicle.The value can be null if the vehicle registration details are not returned from NEVDIS.

0..1 VehicleDescription NevdisVehicleDescription Details that describe the particular vehicle. The value can be null if the vehicle description


UNCLASSIFIED


details are not returned from NEVDIS.

NevdisRegistration 0.1 ExpiryDate string(50) The registration expiry date of the most recent vehicle registration recorded for the vehicle.The value can be null if the expiry date is not returned from NEVDIS.

0..1 PlateNumber string(20) The registration plate number of the most recent vehicle registration recorded for the vehicle. The value can be null if the plate number is not returned from NEVDIS.

NevdisVehicleDescription 0..1 Make string(100) The make of the vehicle. The value can be null if the make is not returned from NEVDIS.

0..1 Model string(100) The model of the vehicle. The value can be null if the make is not returned from NEVDIS.

0..1 Colour string(100) The colour of the vehicle. The value can be null if the colour is not returned from NEVDIS.

0..1 BodyType string(100) The body type of the vehicle. The value can be null if the body type is not returned from NEVDIS.

0..1 VehicleType string(100) The type of the vehicle. The value can be null if the type is not returned from NEVDIS.

0..1 ManufactureYear string(4) The year of manufacture of the vehicle. The value can be null if the year of manufacture is not returned from NEVDIS.

0..1 ComplianceYearMonth string(7) The year and month on the compliance plate of the vehicle. The value can be null if the year and month of compliance is not returned from NEVDIS.

0..1 EngineNumber string(100) The engine number of the vehicle. The value can be null if the engine number is not returned from NEVDIS.


UNCLASSIFIED


StolenDetail 0..1 StolenSummary string(100) Provides a summary of the information for the stolen restriction record.

WrittenOffDetail 0..1 WrittenOffSummary string(100) Provides a summary of the information for the written-off record.


4.5.5.3.1 SearchBySerialNumberRequestMessage

SearchBySerialNumberRequestMessage


SearchBySerialNumberRequestType


PropertiesSearchCriteria : SearchBySerialNumberSearchCriteria

SearchBySerialNumberRequest


SearchBySerialNumberRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 SearchBySerialNumberRequest SearchBySerialNumberRequestType

SearchBySerialNumberRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SearchCriteria SearchBySerialNumberSearchCriteria See section 4.5.5.2.1 SearchBySerialNumberSearchCriteria.


UNCLASSIFIED

4.5.5.3.2 SearchBySerialNumberResponseMessage

SearchBySerialNumberResponseMessageClass

SearchBySerialNumberResponseType


PropertiesPpsrTransactionId : longSearchCriteria : SearchBySerialNumberSearchCriteriaSearchResult : SearchBySerialNumberSearchResultSearchSummary : SearchSummary

SearchBySerialNumberResponse


SearchBySerialNumberResponseMessage

1..1 SearchBySerialNumberResponse SearchBySerialNumberResponseType

SearchBySerialNumberResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.



1..1 SearchCriteria SearchBySerialNumberSearchCriteria See section 4.5.5.2.1 SearchBySerialNumberSearchCriteria for details.This is a repeat of the search criteria in the request message.

1..1 SearchResult SearchBySerialNumberSearchResult See section 4.5.5.2.2 SearchBySerialNumberSearchResult for details.


UNCLASSIFIED



4.5.5-10 The SearchBySerialNumberRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


4.5.5-30 The value provided for SerialNumberType must not be Unsupported. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41093

4.5.5-40 The value provided for SerialNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41001

4.5.5-50 If the SerialNumberType provided is “VIN”, then the SerialNumber provided must be 17 characters in length, excluding white spaces.

Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41003

4.5.5-60 If IncludeExpired is “true”, the Account Customer must be authorised to perform a search on expired/discharged registrations.


4.5.5-70 If IncludeRemoved is “true”, the Account Customer must be authorised to perform a search on removed registrations.


4.5.5-80 If IncludeArchived is “true”, the Account Customer must be authorised to perform a search on archived registrations.


4.5.5-90 At least one of IncludeCurrent, IncludeExpired, IncludeRemoved and IncludeArchived must be “true”.


4.5.5-100 If PointInTimeDateTime is provided, the Account Customer must be authorised to perform a point-in-time search.


4.5.5-110 If PointInTimeDateTime is provided, the date/time must be less than the current date/time.



UNCLASSIFIED

4.5.6 Search By Grantor

This operation is used to retrieve Registrations where one of the Grantors matches a specified Grantor. Normally this search only returns current registrations and limited details for restricted access Registrations. Only authorised users can retrieve expired/discharged, removed and archived Registrations.

Search By Grantor provides additional search criteria to the user to allow them, for example, to only return Registrations for specified Collateral Classes.

Search By Grantor is the search with the potential to include the largest number of Registration in the result (possibly thousands of Registrations against a single company). After the initial search, the PPSR provides functionality to filter the results to reduce the number of Registrations that need to be returned. The initial search result can be filtered multiple times if required.

Search By Grantor can be executed as a “point-in-time” search. This is a search that reflects the Register at a point in time in the past. The details of Registrations included in the search result will be the details that were current at the point in time of the search. Only authorised users are able to perform point-in-time searches.

Search By Grantor uses a multi-step process to retrieve the search results. The initial request (using the Search By Grantor operation) returns the number of Registrations that match the search criteria. A second operation, the Retrieve Grantor Search Result Detail operation, is used to return details of the Registrations. The Retrieve Grantor Search Result Detail operation has a limit on the number of Registrations that can be retrieved in a single request. If the number of Registrations that match the search criteria is greater than the maximum number that can be retrieved in one request, the Retrieve Grantor Search Result Detail operation will need to be called more than once to retrieve all the matching Registrations. The maximum number of Registrations that can be retrieved in a single call to the Retrieve Grantor Search Result Detail operation is provided in the search result for the Search By Grantor operation.

Before calling the Retrieve Grantor Search Result Detail operation, if the number of Registrations that match the search criteria is very large, the Account Customer may choose to filter the Registrations in the initial search result. As well as the initial search criteria, additional filtering criteria can be used to reduce the number of Registrations that might need to be returned. The Filter Grantor Search Result operation is used to filter the search result. The response message for the Filter Grantor Search Result operation returns the number of Registrations from the initial search that match the filter criteria. The Retrieve Grantor Search Result Detail operation can then be used to retrieve Registrations that match the filter criteria.


UNCLASSIFIED

Using the Filter Grantor Search Result operation does not need to occur immediately after the initial Search By Grantor. It can be used after the Retrieve Grantor Search Result Detail operation has been used to retrieve some or all of the Registrations in the search result. Further, after calling the Filter Grantor Search Result operation to apply a filter, the Filter Grantor Search Result operation can be called again to apply a different filter. Each time a filter is applied using the Filter Grantor Search Result operation, the filter is applied to the complete initial search result from the Search By Grantor.

Filtering does not entail an additional fee; it is part of retrieving the results of the initial search. However, all filtering and retrieval of search results needs to be completed before the search result expiry time, otherwise an additional fee will apply.

Whenever a call to the Filter Grantor Search Result operation is called, PPSR will assign a new Filter Number to the application of the filter criteria. This Filter Number must be provided in requests to return the Registrations in the search result using the Retrieve Grantor Search Result Detail operation.

Note that a Filter Number is always assigned by PPSR to the full search result from a Search By Grantor, even though the search result has not yet been filtered. The initial search result is assigned a Filter Number of 1. Subsequent calls to the Filter Grantor Search Result operation will result in sequential Filter Numbers being assigned. When a call is made to the Retrieve Search Result operation at a time after access to the initial search result has expired, a new Filter Number will be assigned to the full search result from the original search, even though the search result has not yet been filtered during the subsequent access to the search result.

If the Search By Grantor request specified an organisation identified by a number (ACN, ARBN, ARSN or ABN), PPSR will attempt to verify the number using an external register. If this verification is successful and the number exists on the external register, the name of the organisation will be returned as part of the search results. Note that PPSR will not search the PPS Register for Registrations using this name, it will only search for Registrations where the Grantor is identified by the specified number.



Operation Name: SearchByGrantor

Request: SearchByGrantorRequestMessage

Response: SearchByGrantorResponseMessage


UNCLASSIFIED

4.5.6.2 Common Search By Grantor Classes

4.5.6.2.1 SearchByGrantorSearchCriteria

SearchByGrantorSearchCriteriaClass

PropertiesIncludeArchived : boolIncludeCurrent : boolIncludeExpired : boolIncludeMigratedTransitional : boolIncludeNonMigratedTransitional : boolIncludeNonTransitional : boolIncludeRemoved : boolPointInTimeDateTime : DateTime?SecurityInterestsOnly : bool

GrantorIndividualSearchCriteriaClass


GrantorOrganisationSearchCriteriaClass


GrantorTypeEnum


SearchSelectionFlagTypeEnum

UnsupportedIncludeExcludeEither

CollateralClassSearchCriteriaTypeEnum

UnsupportedMotorVehicleWatercraftAircraftAircraftEngineAirframeHelicopterSmallAircraftAgricultureCropsLivestockOtherGoodsFinancialPropertyChattelPaperCurrencyDocumentOfTitleIntermediatedSecurityInvestmentInstrumentNegotiableInstrumentIntangiblePropertyAccountGeneralIntangibleIntellectualPropertyCircuitLayoutCopyrightPatentDesignTradeMarkPlantBreedersRightAllPapNoExceptAllPapWithExcept

SortOrderTypeEnum

UnsupportedAscendingDescending



GrantorOrganisationSearchCriteria GrantorIndividualSearchCriteria

CollateralClassSearchCriteria : List<CollateralClassSearchCriteriaType>

IsPMSISearchCriteria

RegistrationNumberSortOrder

GrantorType



UNCLASSIFIED


SearchByGrantorSearchCriteria 1..1 GrantorType GrantorType Indicates whether the grantor is an organisation or an individual. See section 5.7 GrantorType for details.

0..1 GrantorOrganisationSearchCriteria GrantorOrganisationSearchCriteria If the grantor is an organisation, a value for GrantorOrganisationSearchCriteria must be provided.If the grantor is not an organisation, a value for GrantorOrganisationSearchCriteria must not be provided.

0..1 GrantorIndividualSearchCriteria GrantorIndividualSearchCriteria If the grantor is an individual, a value for GrantorIndividualSearchCriteria must be provided.If the grantor is not an individual, a value for GrantorIndividualSearchCriteria must not be provided.

0..1 PointInTimeDateTime dateTime If the search is to be executed as a “point-in-time” search, the date and time for the point in time.

1..1 SecurityInterestsOnly boolean If “true”, only registrations that are security interests will be included in the search result.If “false”, registrations for all registration kinds will be included in the search result.

0..* CollateralClassSearchCriteria List<CollateralClassSearchCriteriaType> An optional list of collateral classes. If provided, the registrations in the search result will be for one of the provided collateral classes. See section 5.3 CollateralClassSearchCriteriaType for details.

1..1 IsPMSISearchCriteria SearchSelectionFlagType Indicates whether registrations that are returned should be based on whether or not they are a PMSI.See section 5.19 SearchSelectionFlagType for details.

1..1 IncludeNonTransitional boolean If “true”, registrations that are not transitional will be included in the search result.If “false”, registrations that are not transitional will be excluded from the search result.

1..1 IncludeNonMigratedTransitional boolean If “true”, registrations that are transitional but not migrated will be included in the search


UNCLASSIFIED


result.If “false”, registrations that are transitional but not migrated will be excluded from the search result.

1..1 IncludeMigratedTransitional boolean If “true”, registrations that are migrated transitional will be included in the search result.If “false”, registrations that are migrated transitional will be excluded from the search result.

1..1 IncludeCurrent boolean If “true”, current registrations will be included in the search result.If “false”, current registrations will not be included in the search result.If an Account Customer is not authorised to retrieve expired/discharged, archived or removed registrations, then IncludeCurrent must be “true”.

1..1 IncludeExpired boolean If “true”, expired/discharged registrations will be included in the search result.If “false”, expired/discharged registrations will not be included in the search result.If an Account Customer is not authorised to retrieve expired/discharged registrations, then IncludeExpired must be “false”.

1..1 IncludeArchived boolean If “true”, archived registrations will be included in the search result.If “false”, archived registrations will not be included in the search result.If an Account Customer is not authorised to retrieve archived registrations, then IncludeArchived must be “false”.

1..1 IncludeRemoved boolean If “true”, removed registrations will be included in the search result.If “false”, removed registrations will not be included in the search result.If an Account Customer is not authorised to retrieve removed registrations, then IncludeRemoved must be “false”.

1..1 RegistrationNumberSortOrder SortOrderType Indicates the order in which registrations are


UNCLASSIFIED


included in the search result in ascending or descending order. See section 5.24 SortOrderType for details.

GrantorOrganisationSearchCriteria 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details. A value for OrganisationNumberType should only be specified if the grantor to be searched for is identified in PPSR by its organisation number.

0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.A value for OrganisationNumber should only be specified if the grantor to be searched for is identified in PPSR by its organisation number.

0..1 OrganisationName string(250) The name of the organisation.A value for OrganisationName should only be specified if the grantor to be searched for is identified in PPSR by its organisation name.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

GrantorIndividualSearchCriteria 1..1 FamilyName string(40) The family name of the individual grantor to search for.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

1..1 GivenNames string(80) The given names of the individual grantor to search for.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

1..1 DateOfBirth dateTime The date of birth of the individual grantor to search for.Note: A time should not be specified. However, if a time component is specified it is ignored by


UNCLASSIFIED


PPSR.

4.5.6.2.2 SearchByGrantorSearchResult


UNCLASSIFIED


SearchByGrantorSearchResult 1..1 FilterNumber int The Filter Number that applies to the search result.


UNCLASSIFIED


1..1 MaximumNumberOfReturnedRegistrationsPerRetrieve

int The maximum number of registrations that can be returned in a single call to the Retrieve Grantor Search Result Detail operation.

0..1 TransitionalPeriodMessage string(200) A message that will only be included during the transitional period. This message is used to indicate that some registrations may not be on the register.After the end of the transitional period this will always be null.

0..1 GrantorOrganisationSearchCriteriaVerificationDetail

GrantorOrganisationWithVerificationStatus

If the search was for a grantor organisation identified by OrganisationNumber and OrganisationNumberType, then this will be details of the external verification with either ASIC or ABR.

1..1 SearchResultSummary SearchByGrantorSearchResultSummary Provides information about the number of registrations in the search result for different collateral classes and collateral types.

GrantorOrganisationWithVerificationStatus 1..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details.

1..1 OrganisationNumber string(50) The value of the number used to identify the organisation.


IdentifierVerificationStatusType Indicates whether ASIC/ABR was able to be contacted to verify the organisation number, and if ASIC/ABR was able to be contacted, indicates whether the organisation number was verified as valid by ASIC/ABR.See section 5.8 IdentifierVerificationStatusType for details.If the VerificationStatus is “NotVerified” and the B2G Account Customer wishes to convey this information to the end user (e.g. on a screen or printed report), the form of words used in the explanation will need to be in an approved form agreed with the Registrar.The approved form for the conveying of data under this note is the way the data would appear on a search certificate or verification statement including any disclaimers and interpretive notes. This means that either a


UNCLASSIFIED


search certificate or verification statement provided in .pdf format over the B2G channel would suffice for the purposes of this note.

0..1 OrganisationName string(250) If the organisation number has been verified as valid with ASIC/ABR, this is the name of the organisation provided by ASIC/ABR.If the organisation number has not been able to be verified as valid with ASIC/ABR, this will be null.


dateTime When the OrganisationNumberVerificationStatus was set.

SearchByGrantorSearchResultSummary 1..1 CollateralTypeSummary List<CollateralTypeSearchSummaryDetail>

A list that contains a record for each collateral type for which there are one or more registrations in the search result.

1..1 CollateralClassSummary List<CollateralClassSearchSummaryDetail>

A list that contains a record for each collateral class for which there are one or more registrations in the search result.

CollateralTypeSearchSummaryDetail 1..1 CollateralType CollateralType See section 5.5 CollateralType for details of the collateral types.

1..1 CollateralTypeResultCount int The number of registrations in the search result for the collateral type.

CollateralClassSearchSummaryDetail 1..1 CollateralClass CollateralClassFilterCriteriaType See section 5.2 CollateralClassFilterCriteriaType for details of the collateral classes.

1..1 CollateralClassResultCount int The number of registrations in the search result for the collateral class.


UNCLASSIFIED

4.5.6.3 Message Contracts4.5.6.3.1 SearchByGrantorRequestMessage

SearchByGrantorRequestMessage


SearchByGrantorRequestType


PropertiesAcceptGrantorIndividualSearchDeclaration : boolSearchCriteria : SearchByGrantorSearchCriteria

SearchByGrantorRequest


SearchByGrantorRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 SearchByGrantorRequest SearchByGrantorRequestType

SearchByGrantorRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SearchCriteria SearchByGrantorSearchCriteria See section 4.5.6.2.1 SearchByGrantorSearchCriteria for details.

0..1 AcceptGrantorIndividualSearchDeclaration

boolean When a user searches the PPSR for registrations against an individual grantor, they are required to make a declaration stating they are doing so for an authorised purpose as set out in the PPS Act.If the grantor type in the search criteria is Individual, a value must be provided indicating whether the user has made the required declaration.If the grantor type in the search criteria is organisation, null must be provided.


UNCLASSIFIED

4.5.6.3.2 SearchByGrantorResponseMessage

SearchByGrantorResponseMessageClass

SearchByGrantorResponseType


PropertiesPpsrTransactionId : longSearchCriteria : SearchByGrantorSearchCriteriaSearchResult : SearchByGrantorSearchResultSearchSummary : SearchSummary

SearchByGrantorResponse


SearchByGrantorResponseMessage 1..1 SearchByGrantorResponse SearchByGrantorResponseType

SearchByGrantorResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.



1..1 SearchCriteria SearchByGrantorSearchCriteria See section 4.5.6.2.1 SearchByGrantorSearchCriteria for details.

1..1 SearchResult SearchByGrantorSearchResult See section 4.5.6.2.2 SearchByGrantorSearchResult for details.


UNCLASSIFIED


Many business rule violations will be returned as a SOAP Fault where the content of the SOAP fault detail element is PpsrCollateralRegistrationSearchValidationFaultDetail and the value of the ErrorNumber is 694. The PpsrCollateralRegistrationSearchValidationFaultDetail allows multiple business rule violations to be reported. In the following table, where the Fault Detail Type in the SOAP Fault column is PpsrCollateralRegistrationSearchValidationFaultDetail, the Error Number is the value that will provided in the ErrorNumber field of the group of errors.


4.5.6-10 The SearchByGrantorRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


4.5.6-30 The value provided for the GrantorType element must not be Unsupported. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 32016

4.5.6-40 If the value provided for the GrantorType element is Organisation, then a value must not be provided for the GrantorIndividualSearchCriteria element.

Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 41032

4.5.6-50 If the value provided for the GrantorType element is Organisation, then a value must be provided for the GrantorOrganisationSearchCriteria element and a value must be provided for either OrganisationName or OrganisationNumber where the value is not an empty string.


4.5.6-60 If a value is provided for the GrantorOrganisationSearchCriteria element, then a value must not be provided for both OrganisationName and OrganisationNumber.





UNCLASSIFIED






4.5.6-101 If a value provided for OrganisationNumber element is ABN, the value must be 11digits.


4.5.6-112 If a value provided for OrganisationNumber element is ACN, ARSN or ARBN, the value must be 9 digits.




4.5.6-130 If the value provided for the GrantorType element is Individual, then a value must not be provided for the GrantorOrganisationSearchCriteria element.


4.5.6-140 If the value provided for the GrantorType element is Individual, then a value must be provided for the GrantorIndividualSearchCriteria element with values provided for both FamilyName and GivenNames that are not empty strings.







UNCLASSIFIED


4.5.6-170 If a value is provided for the GrantorIndividualSearchCriteria element, the value provided for DateOfBirth must not be later than the current date (as per Canberra time).


4.5.6-180 If the value provided for the GrantorType element is Individual, then a value must be provided for AcceptGrantorIndividualSearchDeclaration and the value must be “true”.


4.5.6-190 The value provided for the IsPMSISearchCriteria element must not be Unsupported.


4.5.6-200 If any values are provided in the CollateralClassSearchCriteria element, then all values provided must not be Unsupported.


4.5.6-210 The value provided for the RegistrationNumberSortOrder element must not be Unsupported.


4.5.6-220 At least one of IncludeNonTransitional, IncludeNonMigratedTransitional and IncludeMigratedTransitional must be “true”.


4.5.6-230 If IncludeExpired is “true”, the Account Customer must be authorised to perform a search on expired/discharged registrations.


4.5.6-240 If IncludeRemoved is “true”, the Account Customer must be authorised to perform a search on removed registrations.


4.5.6-250 If IncludeArchived is “true”, the Account Customer must be authorised to perform a search on archived registrations.



UNCLASSIFIED


4.5.6-260 At least one of IncludeCurrent, IncludeExpired, IncludeRemoved and IncludeArchived must be “true”.


4.5.6-270 If PointInTimeDateTime is provided, the Account Customer must be authorised to perform a point-in-time search.


4.5.6-280 If PointInTimeDateTime is provided, the date/time must be less than the current date/time.


4.5.6-290 There must be no validation errors from the request. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 694


UNCLASSIFIED

4.5.7 Search By Grantor And Event Date Range

This operation is used to retrieve Registration events that occurred in a specified date range for Registrations against a specified Grantor that are current at the time the search is undertaken.

An “event” is one of the following:

Initial creation of the Registration on the Register

An amendment to the Registration

A change of address for service for the Secured Party Group recorded on the Registration

A transfer of the Registration from one Secured Party Group to another Secured Party Group.

This search allows the user to find Registration events that occurred in the specified time period for Registrations (against the specified Grantor) that are effective at the time of the search. An example of this would be that there may be 2000 Registrations returned for an organisation Grantor – all are effective at time of search. However the user is looking for Registrations that they knew were either made or added collateral to during the specified time period. This search allows them to identify those Registrations.

It is important to note that this search only returns events for Registrations that are current at the time the search is undertaken. Therefore this search will never return the “Discharge Registration” event, even if the event occurred in the specified date range. This also applies to the “Remove Registration” event, unless the Registration has been subsequently re-instated (even if the Account Customer is authorised to retrieve removed registrations).

The search result for a Search By Grantor And Event Date Range differs from a Search By Grantor in that the same Registration can be included more than once in the search result for Search By Grantor And Event Date Range. This can occur when the same Registration has more than one event that occurs within the specified date range. In this case, each instance of the Registration (i.e. each Registration event) will include details of the Registration as a result of that event.

Search By Grantor And Event Date Range differs from a Search By Grantor in that Search By Grantor And Event Date Range cannot be executed as a “point-in-time” search.


UNCLASSIFIED

In other respects, Search By Grantor And Event Date Range is used in the same way as Search By Grantor. That is, Search By Grantor And Event Date Range uses a multi-step process to retrieve the search results. In order to filter the search result for Search By Grantor And Event Date Range, the Filter Grantor And Event Date Range Search Result operation is used instead of the Filter Grantor Search Result operation. However, the Retrieve Grantor Search Result Detail operation is used to return details of the Registrations for both Search By Grantor operation and the Search By Grantor And Event Date Range operation.



Operation Name: SearchByGrantorAndEventDateRange

Request: SearchByGrantorAndEventDateRangeRequestMessage

Response: SearchByGrantorAndEventDateRangeResponseMessage


UNCLASSIFIED

4.5.7.2 Common Search By Grantor And Event Date Range Classes4.5.7.2.1 SearchByGrantorAndEventDateRangeSearchCriteria

SearchByGrantorAndEventDateRangeSearchCriteriaClass

PropertiesRegistrationEventFromDate : DateTimeRegistrationEventToDate : DateTime

GrantorIndividualSearchCriteriaClass


GrantorOrganisationSearchCriteriaClass


GrantorTypeEnum




GrantorOrganisationSearchCriteriaGrantorIndividualSearchCriteria

GrantorType



SearchByGrantorAndEventDateRangeSearchCriteria

1..1 GrantorType GrantorType Indicates whether the grantor is an organisation or an individual. See section 5.7 GrantorType for details.

0..1 GrantorOrganisationSearchCriteria GrantorOrganisationSearchCriteria If the grantor is an organisation, a value for GrantorOrganisationSearchCriteria must be provided.If the grantor is not an organisation, a value for GrantorOrganisationSearchCriteria must not be provided.

0..1 GrantorIndividualSearchCriteria GrantorIndividualSearchCriteria If the grantor is an individual, a value for GrantorIndividualSearchCriteria must be provided.If the grantor is not an individual, a value for


UNCLASSIFIED


GrantorIndividualSearchCriteria must not be provided.

1..1 RegistrationEventFromDate dateTime The first date in the date range of events to include in the search.Events that occurred on this date will be included in the search result. Note: A time should not be specified. However, if a time component is specified it is ignored by PPSR.

1..1 RegistrationEventToDate dateTime The second date in the date range of events to include in the search. This must be on or after the RegistrationEventFromDate and must be on or before the current date.Events that occurred on this date will be included in the search result.If RegistrationEventFromDate and RegistrationEventToDate are the same, the search will only look for events that occurred on the specified date.Note: A time should not be specified. However, if a time component is specified it is ignored by PPSR.

GrantorOrganisationSearchCriteria 0..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (e.g. ACN, ARBN, ARSN, ABN). See section 5.14 OrganisationNumberType for details. A value for OrganisationNumberType should only be specified if the grantor to be searched for is identified in PPSR by its organisation number.

0..1 OrganisationNumber string(50) The value of the number used to identify the organisation.A value for OrganisationNumber should only be specified if the grantor to be searched for is identified in PPSR by its organisation number.

0..1 OrganisationName string(250) The name of the organisation.A value for OrganisationName should only be specified if the grantor to be searched for is identified in PPSR by its organisation name.The value provided must contain only 7-bit


UNCLASSIFIED


ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

GrantorIndividualSearchCriteria 1..1 FamilyName string(40) The family name of the individual grantor to search for.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

1..1 GivenNames string(80) The given names of the individual grantor to search for.The value provided must contain only 7-bit ASCII characters. See section 6 Allowable Characters for Grantor Names for the list of allowable characters.

1..1 DateOfBirth dateTime The date of birth of the individual grantor to search for.Note: A time should not be specified. However, if a time component is specified it is ignored by PPSR.


UNCLASSIFIED

4.5.7.3 Message Contracts4.5.7.3.1 SearchByGrantorAndEventDateRangeRequestMessage

SearchByGrantorAndEventDateRangeRequestMessage


SearchByGrantorAndEventDateRangeRequestType


PropertiesAcceptGrantorIndividualSearchDeclaration : boolSearchCriteria : SearchByGrantorAndEventDateRangeSearchCriteria

SearchByGrantorAndEventDateRangeRequest


SearchByGrantorAndEventDateRangeRequestMessage


1..1 SearchByGrantorAndEventDateRangeRequest




1..1 SearchCriteria SearchByGrantorAndEventDateRangeSearchCriteria

See section 4.5.7.2.1 SearchByGrantorAndEventDateRangeSearchCriteria for details.

0..1 AcceptGrantorIndividualSearchDeclaration

boolean When a user searches the PPSR for registrations against an individual grantor, they are required to make a declaration stating they are doing so for an authorised purpose as set out in the PPS Act.If the grantor type in the search criteria is Individual, a value must be provided indicating


UNCLASSIFIED


whether the user has made the required declaration.If the grantor type in the search criteria is organisation, null must be provided.Note: the search declaration may also be required when searching for an organisation Grantor described by ABN. If this becomes the case it will be included in a later release of this document.

4.5.7.3.2 SearchByGrantorAndEventDateRangeResponseMessage

SearchByGrantorAndEventDateRangeResponseMessageClass

SearchByGrantorAndEventDateRangeResponseType


PropertiesPpsrTransactionId : longSearchCriteria : SearchByGrantorAndEventDateRangeSearchCriteriaSearchResult : SearchByGrantorSearchResultSearchSummary : SearchSummary

SearchByGrantorAndEventDateRangeResponse


SearchByGrantorAndEventDateRangeResponseMessage

1..1 SearchByGrantorAndEventDateRangeResponse

SearchByGrantorAndEventDateRangeResponseType

SearchByGrantorAndEventDateRangeRes 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


UNCLASSIFIED


ponseType



1..1 SearchCriteria SearchByGrantorAndEventDateRangeSearchCriteria

See section 4.5.7.2.1 SearchByGrantorAndEventDateRangeSearchCriteria for details.

1..1 SearchResult SearchByGrantorSearchResult See section 4.5.6.2.2 SearchByGrantorSearchResult for details.




4.5.7-10 The SearchByGrantorAndEventDateRangeRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


4.5.7-30 The value provided for the GrantorType element must not be Unsupported. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 32016


UNCLASSIFIED


4.5.7-40 If the value provided for the GrantorType element is Organisation, then a value must not be provided for the GrantorIndividualSearchCriteria element.


4.5.7-50 If the value provided for the GrantorType element is Organisation, then a value must be provided for the GrantorOrganisationSearchCriteria element and a value must be provided for either OrganisationName or OrganisationNumber where the value is not an empty string.


4.5.7-60 If a value is provided for the GrantorOrganisationSearchCriteria element, then a value must not be provided for both OrganisationName and OrganisationNumber.








4.5.7-101 If a value provided for OrganisationNumber element is ABN, the value must be 11 digits.


4.5.7-112 If a value provided for OrganisationNumber element is ACN, ARSN or ARBN, the value must be 9 digits.





UNCLASSIFIED


4.5.7-130 If the value provided for the GrantorType element is Individual, then a value must not be provided for the GrantorOrganisationSearchCriteria element.


4.5.7-140 If the value provided for the GrantorType element is Individual, then a value must be provided for the GrantorIndividualSearchCriteria element with values provided for both FamilyName and GivenNames that are not empty strings.






4.5.7-170 If a value is provided for the GrantorIndividualSearchCriteria element, the value provided for DateOfBirth must not be later than the current date (as per Canberra time).


4.5.7-180 If the value provided for the GrantorType element is Individual, then a value must be provided for AcceptGrantorIndividualSearchDeclaration and the value must be “true”.


4.5.7-190 The date specified in the RegistrationEventToDate must not be later than the current date (as per Canberra time).


4.5.7-200 The date specified in the RegistrationEventToDate must not be before the date specified in the RegistrationEventFromDate.


4.5.77-210 There must be no validation errors from the request. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 694


UNCLASSIFIED


UNCLASSIFIED

4.5.8 Ordinal Search

This operation is used to determine the order of two specified registration events. The search result is whether one of the events occurred before, after, or at the same time as the other event.

The result that two events happened at the same time can only occur if the two events relate to the original creation of transitional Registrations on PPSR.

The event types for each Registration that can be compared are:

The Start Time of the Registration

The Change Number of a change to a Registration (including the original creation of the Registration)

The End Time of the Registration

Note that it is not possible to use Ordinal Search to compare the End Times of two Registrations.

The criteria for each event include the Registration Number and the event type. When the specified event type for a Registration is Start Time or End Time, no further criteria needs to be provided for the Registration. When the specified event type for a Registration is Change Number, the required Change Number must be provided.

It is possible to provide the same Registration Number for both of the registration events.



Operation Name: OrdinalSearch

Request: OrdinalSearchRequestMessage

Response: OrdinalSearchResponseMessage


UNCLASSIFIED

4.5.8.2 Common Ordinal Search Types

4.5.8.2.1 OrdinalSearchSearchCriteria

OrdinalSearchSearchCriteriaClass

RegistrationEventClass

PropertiesChangeNumber : long?RegistrationNumber : string

RegistrationEventTypeEnum

UnsupportedStartTimeEndTimeChangeNumber

RegistrationEventOne

RegistrationEventTwoRegistrationEventType


OrdinalSearchSearchCriteria 1..1 RegistrationEventOne RegistrationEvent The first of the registration events to be included in the ordinal search.Note that the order of inclusion of the two registration events in the search criteria has no bearing on the search result.

1..1 RegistrationEventTwo RegistrationEvent The second of the registration events to be included in the ordinal search.

RegistrationEvent 1..1 RegistrationNumber string(20) The Registration Number of the registration.

1..1 RegistrationEventType RegistrationEventType The type of registration event. See Section 5.15 RegistrationEventType for more details.

0..1 ChangeNumber long If the event type is Change Number, the value of the Change Number must be provided.The value must be null if the event type is not Change Number.


UNCLASSIFIED

4.5.8.2.2 OrdinalSearchSearchResult


OrdinalSearchSearchResult 1..1 OrdinalSearchSearchResultDetail OrdinalSearchSearchResultDetail

1..1 SearchResultRetrievedDateTime dateTime The date and time the result of the search was retrieved. This is not the date and time the search was executed (which will be in the


UNCLASSIFIED


SearchSummary in the response message). The search result may be retrieved at a time after the search was executed.

OrdinalSearchSearchResultDetail 1..1 OrdinalSearchResult OrdinalSearchResultType Indicates whether one registration event occurred before, after or at the same time as the other registration event. See section 5.13 OrdinalSearchResultType for details.

0..1 TransitionalMessage string(200) Where both registrations are transitional registrations (ie. migrated, pre-load or transitional registrations made post registration commencement time); and the event being compared for BOTH registrations is the original registration event in PPSR, a message is returned indicating this fact. For example:“Both registrations are transitional – we cannot determine the order of these registrations”.The TransitionalMessage is populated when the ordinal search result is that both events happened at the same time.

1..1 RegistrationOne OrdinalRegistrationDetail Provides further details about the registration in the first of the registration events specified in the search criteria.

1..1 RegistrationTwo OrdinalRegistrationDetail Provides further details about the registration in the first of the registration events specified in the search criteria.

OrdinalRegistrationDetail 1..1 RegistrationEvent RegistrationEvent The registration event included in the search criteria for the ordinal search.

0..1 EventTime dateTime The date and time of the registration event specified in the search criteria.If the event type is Start Time, the value will be the registration Start Time.If the event type is Change Number, the value will be the Change Time for the Change Number.If the event type is End Time, the value will be the registration End Time, unless the registration has a “not stated” end time in which case the value will be null.If the registration is removed, archived and/or marked as “access is restricted” (in which case


UNCLASSIFIED


the IsRemoved, IsArchived and/or IsAccessRestricted element will be “true”) and the Account Customer is not authorised to retrieve the details of registrations with the particular restriction, the EventTime will be null.

0..1 IsAccessRestricted bool Indicates whether the registration is Access is Restricted.This will be null if the registration has been removed or is archived and the Account Customer is not authorised to access removed or archived registrations.

1..1 IsArchived bool Indicates whether the registration is archived.Note: an ordinal search can only be performed for an archived registration if the user is authorised to retrieve archived registrations.

1..1 IsRemoved bool Indicates whether the registration is removed.Note: an ordinal search can only be performed for a removed registration if the user is authorised to retrieve removed registrations or the registration has been made available for searching by the Registrar..

0..1 RegistrarAlert String (20) An indicator of abnormal changes to the registration.If there is a registrar alert recorded against the registration, this field will have the text “Registrar alert”. The text of the registrar alert is not available as part of the ordinal search result.

RegistrationEvent 1..1 RegistrationNumber string(20) The Registration Number of the registration.

1..1 RegistrationEventType RegistrationEventType The type of registration event. See Section 5.15 RegistrationEventType for more details.

0..1 ChangeNumber long If the event type is Change Number, the value of the Change Number.The value will be null if the event type is not Change Number.


UNCLASSIFIED


4.5.8.3.1 OrdinalSearchRequestMessage

OrdinalSearchRequestMessage


OrdinalSearchRequestType


PropertiesSearchCriteria : OrdinalSearchSearchCriteria

OrdinalSearchRequest


OrdinalSearchRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 OrdinalSearchRequest OrdinalSearchRequestType

OrdinalSearchRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SearchCriteria OrdinalSearchSearchCriteria See section for 4.5.8.2.1 OrdinalSearchSearchCriteria details.


UNCLASSIFIED

4.5.8.3.2 OrdinalSearchResponseMessage

OrdinalSearchResponseMessageClass

OrdinalSearchResponseType


PropertiesPpsrTransactionId : longSearchCriteria : OrdinalSearchSearchCriteriaSearchResult : OrdinalSearchSearchResultSearchSummary : SearchSummary

OrdinalSearchResponse


OrdinalSearchResponseMessage 1..1 OrdinalSearchResponse OrdinalSearchResponseType

OrdinalSearchResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.



1..1 SearchCriteria OrdinalSearchSearchCriteria See section 4.5.8.2.1 OrdinalSearchSearchCriteria for details.

1..1 SearchResult OrdinalSearchSearchResult See section 4.5.8.2.2 OrdinalSearchSearchResult for details.


UNCLASSIFIED


4.5.8.4.1 PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetail

PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetail




RegistrationEventOneValidationErrors : List<PpsrValidationError>

RegistrationEventTwoValidationErrors : List<PpsrValidationError>


PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetail


0..1 RegistrationEventOneValidationErrors List<PpsrValidationError> A list of validation errors related to the details provided for registration event one.

0..1 RegistrationEventTwoValidationErrors List<PpsrValidationError> A list of validation errors related to the details provided for registration event two.




UNCLASSIFIED


Many business rule violations will be returned as a SOAP Fault where the content of the SOAP fault detail element is PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetail and the value of the ErrorNumber is 695. The PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetail allows multiple business rule violations to be reported. Two groups of errors are provided: one for business rule violations related to the details provided for registration event one; and a second for business rule violations related to the details provided for registration event two. In the following table, where the Fault Detail Type in the SOAP Fault column is PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetail, the Error Number is the value that will provided in the ErrorNumber field of the relevant group of errors.


4.5.8-10 The OrdinalSearchRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


4.5.8-30 The RegistrationNumber of a RegistrationEvent must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetailError Number: 41007

4.5.88-41 The RegistrationNumber of a RegistrationEvent must be a 15 digit number. Fault Detail Type: PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetailError Number: 41100

4.5.8-50 The RegistrationNumber of a RegistrationEvent must be for an existing Registration.

Fault Detail Type: PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetailError Number: 41008

4.5.8-60 If the RegistrationEventType is EndTime in RegistrationEventOne, the RegistrationEventType must not be EndTime in RegistrationEventTwo.



UNCLASSIFIED


4.5.8-70 If a RegistrationEvent has a RegistrationEventType of ChangeNumber, a value for the ChangeNumber of the RegistrationEvent must be provided.


4.5.8-80 If a RegistrationEvent has a RegistrationEventType of StartTime or EndTime, a value for the ChangeNumber of the RegistrationEvent must not be provided.


4.5.8-90 If a ChangeNumber is provided for a RegistrationEvent, it must be a valid Change Number for the RegistrationNumber.


4.5.8-100 If the RegistrationNumber of a RegistrationEvent is for an archived registration, the Account Customer must be authorised to retrieve archived registrations.


4.5.8-110 If the RegistrationNumber of a RegistrationEvent is for a removed registration, the Account Customer must be authorised to retrieve removed registrations or the registration has been made available for searching by the Registrar.


4.5.88-120 There must be no validation errors from the request. Fault Detail Type: PpsrCollateralRegistrationSearchOrdinalSearchValidationFaultDetailError Number: 695


UNCLASSIFIED

4.5.9 Retrieve Search Result

This operation is used to retrieve a search result subsequent to the initial search. It requires the Search Number to identify the specific search result required.

The response message includes the same search result that was returned in response to the original search request. The search is not executed again. If the original search was a Search By Grantor or Search By Grantor And Event Date Range, this provides access to the full original search result, regardless of any filtering that may have previously occurred. If, when retrieving a search result, access restrictions have been placed on a Registration since the time of the original search, the Registration will still be included in the search result however the details of the Registration will be limited by the level of authorisation for the user (see section 4.5.3.3.2 RestrictionDetail).

As well as the search result, the response message includes the search summary. This allows the search type of the original search to be identified. The search summary also includes the expiry time of the search result access period.

The response message also includes the original search criteria (as the retrieve search result operation will be used after the initial search, the original search criteria may not be available to the user).

The particular search criteria and search result record included in the response will depend on the search type of the original search.



Operation Name: RetrieveSearchResult

Request: RetrieveSearchResultRequestMessage

Response: RetrieveSearchResultResponseMessage


UNCLASSIFIED


4.5.9.2.1 RetrieveSearchResultRequestMessage

RetrieveSearchResultRequestMessage


RetrieveSearchResultRequestType


PropertiesSearchNumber : string

RetrieveSearchResultRequest


RetrieveSearchResultRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RetrieveSearchResultRequest RetrieveSearchResultRequestType

RetrieveSearchResultRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SearchNumber string(16) The Search Number of the search.


UNCLASSIFIED

4.5.9.2.2 RetrieveSearchResultResponseMessage

RetrieveSearchResultResponseMessageClass

RetrieveSearchResultResponseType


PropertiesPpsrTransactionId : longSearchSummary : SearchSummary

SearchCriteriaClass

PropertiesOrdinalSearchSearchCriteria : OrdinalSearchSearchCriteriaSearchByGrantorAndEventDateRangeSearchCriteria : SearchByGrantorAndEventDateRangeSearchCriteriaSearchByGrantorSearchCriteria : SearchByGrantorSearchCriteriaSearchByRegistrationNumberSearchCriteria : SearchByRegistrationNumberSearchCriteriaSearchBySerialNumberSearchCriteria : SearchBySerialNumberSearchCriteria

SearchResultClass

PropertiesOrdinalSearchSearchResult : OrdinalSearchSearchResultSearchByGrantorAndEventDateRangeSearchResult : SearchByGrantorSearchResultSearchByGrantorSearchResult : SearchByGrantorSearchResultSearchByRegistrationNumberSearchResult : SearchByRegistrationNumberSearchResultSearchBySerialNumberSearchResult : SearchBySerialNumberSearchResult

RetrieveSearchResultResponse

SearchCriteria SearchResult


RetrieveSearchResultResponseMessage 1..1 RetrieveSearchResultResponse RetrieveSearchResultResponseType

RetrieveSearchResultResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.



1..1 SearchCriteria SearchCriteria The search criteria used for the original search.

1..1 SearchResult SearchResult The search result from the original search.

SearchCriteria 0..1 SearchByRegistrationNumberSearchCriteria

SearchByRegistrationNumberSearchCriteria This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was a Search By Registration Number.See section 4.5.4.2.1 SearchByRegistrationNumberSearchCriteria for details.


UNCLASSIFIED


0..1 SearchBySerialNumberSearchCriteria

SearchBySerialNumberSearchCriteria This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was a Search By Serial Number.See section 4.5.5.2.1 SearchBySerialNumberSearchCriteria for details.

0..1 SearchByGrantorSearchCriteria SearchByGrantorSearchCriteria This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was a Search By Grantor.See section 4.5.6.2.1 SearchByGrantorSearchCriteria for details.

0..1 SearchByGrantorAndEventDateRangeSearchCriteria

SearchByGrantorAndEventDateRangeSearchCriteria

This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was a Search By Grantor And Event Date Range.See section 4.5.7.2.1SearchByGrantorAndEventDateRangeSearchCriteria for details.

0..1 OrdinalSearchSearchCriteria OrdinalSearchSearchCriteria This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was an Ordinal Search.See section 4.5.8.2.1 OrdinalSearchSearchCriteria for details.

SearchResult 0..1 SearchByRegistrationNumberSearchResult

SearchByRegistrationNumberSearchResult This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was a Search By Registration Number.See section 4.5.4.2.2 SearchByRegistrationNumberSearchResult for details.

0..1 SearchBySerialNumberSearchResult

SearchBySerialNumberSearchResult This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was a Search By Serial Number.See section 4.5.5.2.2 SearchBySerialNumberSearchResult for details.

0..1 SearchByGrantorSearchResult SearchByGrantorSearchResult This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was a Search By


UNCLASSIFIED


Grantor.See section 4.5.6.2.2 SearchByGrantorSearchResult for details.

0..1 SearchByGrantorAndEventDateRangeSearchResult

SearchByGrantorSearchResult This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was a Search By Grantor And Event Date Range.See section 4.5.6.2.2 SearchByGrantorSearchResult for details.

0..1 OrdinalSearchSearchResult OrdinalSearchSearchResult This element will only be populated when the original search, identified by the SearchType in the SearchSummary element, was an Ordinal Search.See section 4.5.8.2.2 OrdinalSearchSearchResult for details.



4.5.9-10 The RetrieveSearchResultRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.5.9-20 The value provided for SearchNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41005

4.5.9-30 The SearchNumber must be for an existing search. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41006


UNCLASSIFIED

4.5.10 Retrieve Search Result Registration Attachment

This operation retrieves an attachment for a Registration that has been returned in a search result.



Operation Name: RetrieveSearchResultRegistrationAttachment

Request: RetrieveSearchResultRegistrationAttachmentRequestMessage

Response: RetrieveSearchResultRegistrationAttachmentResponseMessage


UNCLASSIFIED


4.5.10.2.1 RetrieveSearchResultRegistrationAttachmentRequestMessage

RetrieveSearchResultRegistrationAttachmentRequestMessage


RetrieveSearchResultRegistrationAttachmentRequestType


PropertiesAttachmentId : longChangeNumber : longRegistrationNumber : stringSearchNumber : string

RetrieveSearchResultRegistrationAttachmentRequest


RetrieveSearchResultRegistrationAttachmentRequestMessage


1..1 RetrieveSearchResultRegistrationAttachmentRequest




1..1 SearchNumber string(16) The Search Number of the search which returned the specified Registration Number and Change Number for which the Attachment is retrieved.

1..1 RegistrationNumber string(20) The Registration Number of the Registration for which the Attachment is to be retrieved.The Registration Number must be for a


UNCLASSIFIED


Registration that was included in the search result.

1..1 ChangeNumber long The Change Number of the version of the Registration for which the Attachment is to be retrieved.The Change Number must be correct for the specified Registration.The Change Number provided must be for a change to the specified Registration that occurred on or before the highest Change Number included in the search result for the Registration.

1..1 AttachmentId long The Attachment Id of the Attachment to be retrieved.The AttachmentId must be for an Attachment that was included on the version of the Registration specified by the RegistrationNumber and ChangeNumber.


UNCLASSIFIED

4.5.10.2.2 RetrieveSearchResultRegistrationAttachmentResponseMessage

RetrieveSearchResultRegistrationAttachmentResponseMessageClass

RetrieveSearchResultRegistrationAttachmentResponseType



RetrieveSearchResultRegistrationAttachmentResponse


RetrieveSearchResultRegistrationAttachmentResponseMessage

1..1 RetrieveSearchResultRegistrationAttachmentResponse








UNCLASSIFIED



4.5.10-10 The RetrieveSearchResultRegistrationAttachmentRequest element must be provided.




4.5.10-40 The search must not have been an Ordinal Search. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41025

4.5.10-50 The current time must be before the AccessToSearchResultExpiryTime of the search.



4.5.10-70 The RegistrationNumber must have been included in the search result for the SearchNumber.


4.5.10-80 If the RegistrationNumber is for a registration marked as “access is restricted”, the Account Customer must be authorised to retrieve “access is restricted” registrations.


4.5.10-90 If the RegistrationNumber is for an archived registration, the Account Customer must be authorised to retrieve archived registrations.


4.5.10-100 If the RegistrationNumber is for a removed registration, the Account Customer must be authorised to retrieve removed registrations.


4.5.10-110 The ChangeNumber must be correct for the RegistrationNumber. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41029


UNCLASSIFIED


4.5.10-120 The Change Number provided must be for a change to the specified registration that occurred on or before the highest Change Number included in the search result for the registration.


4.5.10-130 The AttachmentId must be for an Attachment that was associated with the version of the Registration at the specified Change Number.



UNCLASSIFIED

4.5.11 Retrieve Grantor Search Result Detail

This operation retrieves Registrations that are included in the search result for a Search By Grantor or a Search By Grantor and Event Date Range search. The Retrieve Grantor Search Result Detail operation can be called for the complete search result, or it can be called after the search result has been filtered (using either the Filter Grantor Search Result operation or the Filter Grantor And Event Date Range Search Result operation).

When retrieving Registrations using the Retrieve Grantor Search Result Detail operation, the Search Number of the original search and the Filter Number of the required filter must be provided in the request message. Note that even the full search result has a Filter Number, even though the search result has not been filtered.

The Retrieve Grantor Search Result Detail operation has a limit on the number of Registrations that can be retrieved in a single request (the maximum number is returned in the search result for both Search By Grantor and Search By Grantor And Event Date Range). If the number of Registrations that match the search criteria, or the filter criteria if a filter has been applied, is greater than the maximum number that can be retrieved in one request, the Retrieve Grantor Search Result Detail operation will need to be called more than once to retrieve all the matching Registrations.

Each Registration that meets the original search criteria or subsequent filter criteria is assigned a ResultSequenceNumber. The ResultSequenceNumber of the first Registration in the search result (or filtered search result) will be 1, and then continue in an unbroken sequence incremented by 1 for each Registration, such that the last Registration in the result has a ResultSequenceNumber equal to the total number of Registrations returned by the search or filter operation.

The ResultSequenceNumber for a particular Registration in a search result is always relative to the Filter Number. The same Registration may have a different ResultSequenceNumber for different Filter Numbers for the one Search Number.

When retrieving Registrations using the Retrieve Grantor Search Result Detail operation, the first ResultSequenceNumber to be returned and a count of the number of Registrations to be returned must be provided in the request message.

By using the first ResultSequenceNumber to be returned and the count of the number of Registrations to be returned, the B2G Account Customer’s application is able to retrieve Registrations in a number of different ways. For example:

If the number of Registrations in the result is less than the maximum that can be returned in one request, they can all be retrieved at once;


UNCLASSIFIED

If the number of Registrations in the result is more than the maximum that can be returned in one request, the B2G Account Customer’s application can call the Retrieve Grantor Search Result Detail operation as many times as required to retrieve all the Registrations, requesting the maximum number to retrieve each time;

The B2G Account Customer’s application can support paging operations, allowing the next set of Registrations in the result to be fetched from PPSR only when requested by an end user that is paging through the results. The number of Registrations retrieved each time can match the pages size of results in the B2G Account Customer’s application;

Performance of paging operations can be enhanced by predictively pre-fetching the next page of results ahead of the end user paging.



Operation Name: RetrieveGrantorSearchResultDetail

Request: RetrieveGrantorSearchResultDetailRequestMessage

Response: RetrieveGrantorSearchResultDetailResponseMessage


UNCLASSIFIED


4.5.11.2.1 RetrieveGrantorSearchResultDetailRequestMessage

RetrieveGrantorSearchResultDetailRequestMessage


RetrieveGrantorSearchResultDetailRequestType


PropertiesFilterNumber : intMaximumNumberOfRegistrationsToReturn : intSearchNumber : stringStartResultSequenceNumber : int

RetrieveGrantorSearchResultDetailRequest


RetrieveGrantorSearchResultDetailRequestMessage


1..1 RetrieveGrantorSearchResultDetail Request




1..1 SearchNumber string(16) The SearchNumber of the search result.

1..1 FilterNumber int The FilterNumber of the search result or after application of a filter to the search result.

1..1 MaximumNumberOfRegistrationsToReturn

int The maximum number of registrations to be returned. This must not be greater than the value of MaximumNumberOfReturnedRegistrationsPerR


UNCLASSIFIED


etrieve that was provided in the search result.

1..1 StartResultSequenceNumber int The ResultSequenceNumber of the first Registration to return.

4.5.11.2.2 RetrieveGrantorSearchResultDetailResponseMessage

RetrieveGrantorSearchResultDetailResponseMessageClass

RetrieveGrantorSearchResultDetailResponseType


PropertiesResultCount : intResultDetails : List<ResultDetail>SearchResultDetailRetrievedDateTime : DateTime

RetrieveGrantorSearchResultDetailResponse


RetrieveGrantorSearchResultDetailResponseMessage

1..1 RetrieveGrantorSearchResultDetailResponse




1..1 ResultCount int The number of registrations returned in the response message. This will usually be the same as the MaximumNumberOfRegistrationsToReturn in the request message. It may be less than the


UNCLASSIFIED


MaximumNumberOfRegistrationsToReturn in the request message when the StartResultSequenceNumber plus the MaximumNumberOfRegistrationsToReturn is less than the total number of registrations in the search result or filtered search result.

0..* ResultDetails List<ResultDetail> A list of registrations in the search result or filtered search result starting with the StartResultSequenceNumber in the request message.See section 4.5.3.3 Result Detail.

1..1 SearchResultDetailRetrievedDateTime

dateTime The date and time the search result details in the response message were retrieved from PPSR.Note that the details of registrations returned will depend on any restrictions on the registration at the time the result details are retrieved.



4.5.11-10 The RetrieveGrantorSearchResultDetail element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005



4.5.11-40 The SearchNumber must be for an existing search that was a Search By Grantor or Search By Grantor And Event Date Range.



UNCLASSIFIED




4.5.11-60 The FilterNumber must be valid for the SearchNumber. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41059

4.5.11-70 The number of Registrations in the search result or filtered search result must be greater than zero.


4.5.11-80 The StartResultSequenceNumber must be greater than or equal to 1 and less than or equal to the number of Registrations in the search result or filtered search result.


4.5.11-90 The MaximumNumberOfRegistrationsToReturn must be greater than 0 and less than or equal to the MaximumNumberOfReturnedRegistrationsPerRetrieve that was provided in the search result.



UNCLASSIFIED

4.5.12 Filter Grantor Search Result

This operation is used to reduce the number of Registrations returned from a Search by Grantor by filtering out those Registrations that may not be relevant. Using this operation is an optional step in working with the search result.



Operation Name: FilterGrantorSearchResult

Request: FilterGrantorSearchResultRequestMessage

Response: FilterGrantorSearchResultResponseMessage


UNCLASSIFIED

4.5.12.2 Common Filter Grantor Search Result Classes

4.5.12.2.1 SearchByGrantorFilterCriteria

SearchByGrantorFilterCriteriaClass

PropertiesIncludeMigratedTransitional : boolIncludeNonMigratedTransitional : boolIncludeNonTransitional : boolLastChangeTimeYear : int?SecurityInterestsOnly : boolStartTimeYear : int?

CollateralClassFilterCriteriaTypeEnum

UnsupportedUnknownMotorVehicleWatercraftAircraftAircraftEngineAirframeHelicopterSmallAircraftAgricultureCropsLivestockOtherGoodsFinancialPropertyChattelPaperCurrencyDocumentOfTitleIntermediatedSecurityInvestmentInstrumentNegotiableInstrumentIntangiblePropertyAccountGeneralIntangibleIntellectualPropertyCircuitLayoutCopyrightPatentDesignTradeMarkPlantBreedersRightAllPapNoExceptAllPapWithExcept

CollateralTypeEnum

UnsupportedUnknownConsumerCommercial

SearchSelectionFlagTypeEnum

UnsupportedIncludeExcludeEither

CollateralTypeFilterCriteria : List<CollateralType>

IsPMSIFilterCriteria

CollateralClassFilterCriteria : List<CollateralClassFilterCriteriaType>


UNCLASSIFIED


SearchByGrantorFilterCriteria 0..1 CollateralTypeFilterCriteria List<CollateralType> A list of the collateral types for registrations to be kept in the filtered search result. For example, to exclude registrations that are Consumer property, do not include “Consumer” in the list. See section 5.5 CollateralType for details of the collateral types.Only include collateral types that were included in the original search result (see the SearchByGrantorSearchResultSummary in the SearchByGrantorSearchResult in section 4.5.6.2.2 SearchByGrantorSearchResult). That is, the filter criteria cannot be used to expand the collateral types returned in the original search result.If no collateral types are provided in the filter criteria, no filtering by collateral type will be performed.

0..1 CollateralClassFilterCriteria List<CollateralClassFilterCriteriaType> A list of the collateral classes for registrations to be kept in the filtered search result. For example, to exclude registrations that are All present and after-acquired property or All present and after-acquired property except …, do not include “AllPapNoExcept” and “AllPapWithExcept” in the list. See section 5.2 CollateralClassFilterCriteriaType for details of the collateral classes. Only include collateral classes that were included in the original search result (see the SearchByGrantorSearchResultSummary in the SearchByGrantorSearchResult in section 4.5.6.2.2 SearchByGrantorSearchResult). That is, the filter criteria cannot be used to expand the collateral classes returned in the original search result.If no collateral classes are provided in the filter criteria, no filtering by collateral class will be performed.

0..1 LastChangeTimeYear int For a registration in the original search result to be kept in the filtered search result, the last change time for the registration must be in the specified LastChangeTimeYear.


UNCLASSIFIED


The value must be entered as a four digit year.

0..1 StartTimeYear int For a registration in the original search result to be kept in the filtered search result, the start time for the registration must be in the specified StartTimeYear.The value must be entered as a four digit year.

1..1 SecurityInterestsOnly boolean If “true”, only registrations that are security interests will be kept in the filtered search result.If “false”, registrations for all registration kinds will be kept in the filtered search result.If the original search criteria provided the value “true” for the SecurityInterestsOnly search criteria, then the value provided in the filter criteria must not be “false”. That is, the filter criteria cannot be used to expand the registration returned in the original search result to include non-security interests.

1..1 IsPMSIFilterCriteria SearchSelectionFlagType Indicates whether registrations that are kept in the filtered search result should be based on whether or not they are a PMSI.See section 5.19 SearchSelectionFlagType for details.If the original search criteria provided the value “Include” or “Exclude” for IsPMSISearchCriteria, then the value provided in the filter criteria must be the same. For example, if the original search criteria was to only include PMSI registrations, the filter criteria cannot expand the registrations returned in the original search result to include non-PMSI registrations.

1..1 IncludeNonTransitional boolean If “true”, registrations that are not transitional will be kept in the filtered search result.If “false”, registrations that are not transitional will be excluded from the filtered search result.If the original search criteria provided the value “false” for the IncludeNonTransitional search criteria, then the value provided in the filter criteria must not be “true”. That is, the filter criteria cannot be used to expand the registrations returned in the original search result to include non-transitional registrations.


UNCLASSIFIED


1..1 IncludeNonMigratedTransitional boolean If “true”, registrations that are transitional but not migrated will be kept in the filtered search result.If “false”, registrations that are transitional but not migrated will be excluded from the filtered search result.If the original search criteria provided the value “false” for the IncludeNonMigratedTransitional search criteria, then the value provided in the filter criteria must not be “true”. That is, the filter criteria cannot be used to expand the registrations returned in the original search result to include non-migrated transitional registrations.

1..1 IncludeMigratedTransitional boolean If “true”, registrations that are migrated transitional will be kept in the filtered search result.If “false”, registrations that are migrated transitional will be excluded from the filtered search result.If the original search criteria provided the value “false” for the IncludeMigratedTransitional search criteria, then the value provided in the filter criteria must not be “true”. That is, the filter criteria cannot be used to expand the registrations returned in the original search result to include migrated transitional registrations.


UNCLASSIFIED

4.5.12.3 Message Contracts4.5.12.3.1 FilterGrantorSearchResultRequestMessage

FilterGrantorSearchResultRequestMessage


FilterGrantorSearchResultRequestType


PropertiesFilterCriteria : SearchByGrantorFilterCriteriaSearchNumber : string

FilterGrantorSearchResultRequest


FilterGrantorSearchResultRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 FilterGrantorSearchResultRequest FilterGrantorSearchResultRequestType

FilterGrantorSearchResultRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SearchNumber string(16) The SearchNumber of the search result to filter.

1..1 FilterCriteria SearchByGrantorFilterCriteria See section 4.5.12.2.1 SearchByGrantorFilterCriteria for details.


UNCLASSIFIED

4.5.12.3.2 FilterGrantorSearchResultResponseMessage

FilterGrantorSearchResultResponseMessageClass

FilterGrantorSearchResultResponseType


PropertiesFilterCriteria : SearchByGrantorFilterCriteriaFilterSummary : FilterSummary

FilterGrantorSearchResultResponse


FilterGrantorSearchResultResponseMessage 1..1 FilterGrantorSearchResultResponse FilterGrantorSearchResultResponseType

FilterGrantorSearchResultResponseType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 FilterSummary FilterSummary See section 4.5.3.2 Filter Summary for details.

1..1 FilterCriteria SearchByGrantorFilterCriteria See section 4.5.12.2.1 SearchByGrantorFilterCriteria for details.


UNCLASSIFIED




4.5.12-10 The FilterGrantorSearchResultRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005



4.5.12-40 The SearchNumber must be for a Search By Grantor. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41063



4.5.12-60 The FilterCriteria element must be provided. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41053

4.5.12-70 If any values are provided in the CollateralTypeFilterCriteria, then all values provided must not be Unsupported.


4.5.12-80 If any values are provided in the CollateralTypeFilterCriteria, then all of the collateral types in the CollateralTypeFilterCriteria must have been included in the original search result (see the SearchByGrantorSearchResultSummary in the SearchByGrantorSearchResult in section 4.5.6.2.2 SearchByGrantorSearchResult).



UNCLASSIFIED


4.5.12-90 If any values are provided in the CollateralClassFilterCriteria element, then all values provided must not be Unsupported.


4.5.12-100 If any values are provided in the CollateralClassFilterCriteria element, then all of the collateral classes in the CollateralClassFilterCriteria must have been included in the original search result (see the SearchByGrantorSearchResultSummary in the SearchByGrantorSearchResult in section 4.5.6.2.2 SearchByGrantorSearchResult).


4.5.12-110 The value provided for LastChangeTimeYear must be a four digit year. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 41066

4.5.12-120 The value provided for LastChangeTimeYear must be a four digit year that is the current year or earlier.


4.5.12-130 The value provided for StartTimeYear must be a four digit year. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 41068

4.5.12-140 The value provided for StartTimeYear must be a four digit year that is the current year or earlier.


4.5.12-150 If the value provided for SecurityInterestsOnly is “false”, then the original search criteria for SecurityInterestsOnly must also have been “false”.


4.5.12-160 The value provided for IsPMSIFilterCriteria must not be Unsupported. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 41094

4.5.12-170 If the value provided for IsPMSIFilterCriteria is “Include”, then the original search criteria for IsPMSISearchCriteria must also have been either “Include” or “Either”.



UNCLASSIFIED


4.5.12-180 If the value provided for IsPMSIFilterCriteria is “Exclude”, then the original search criteria for IsPMSISearchCriteria must also have been either “Exclude” or “Either”.


4.5.12-190 If the value provided for IsPMSIFilterCriteria is “Either”, then the original search criteria for IsPMSISearchCriteria must also have been “Either”.


4.5.12-200 If the value provided for IncludeNonTransitional is “true”, then the original search criteria for IncludeNonTransitional must also have been “true”.


4.5.12-210 If the value provided for IncludeNonMigratedTransitional is “true”, then the original search criteria for IncludeNonMigratedTransitional must also have been “true”.


4.5.12-220 If the value provided for IncludeMigratedTransitional is “true”, then the original search criteria for IncludeMigratedTransitional must also have been “true”.


4.5.1212-230

There must be no validation errors from the request. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 694


UNCLASSIFIED

4.5.13 Filter Grantor And Event Date Range Search Result

This operation is used to reduce the number of Registrations returned from a Search by Grantor And Event Date Range by filtering out those Registrations that may not be relevant. Using this operation is an optional step in working with the search result.



Operation Name: FilterGrantorAndEventDateRangeSearchResult

Request: FilterGrantorAndEventDateRangeSearchResultRequestMessage

Response: FilterGrantorAndEventDateRangeSearchResultResponseMessage

4.5.13.2 Common Filter Grantor And Event Date Range Search Result Classes

4.5.13.2.1 SearchByGrantorAndEventDateRangeFilterCriteria

SearchByGrantorAndEventDateRangeFilterCriteriaClass

PropertiesRegistrationEventFromDate : DateTimeRegistrationEventToDate : DateTime


SearchByGrantorAndEventDateRangeFilterCriteria

1..1 RegistrationEventFromDate dateTime The first date in the date range of events to be kept in the filtered search result.Events that occurred on this date will be kept in


UNCLASSIFIED


the filtered search result. The value must not be before the date specified as the RegistrationEventFromDate in the original search criteria. That is, the filter criteria cannot expand the registration events returned in the original search result to include registration events that occurred before those in the original search result. Note: A time should not be specified. However, if a time component is specified it is ignored by PPSR.

1..1 RegistrationEventToDate dateTime The second date in the date range of events to include in the search. This must be on or after the RegistrationEventFromDate and must be on or before the current date.Events that occurred on this date will be included in the search result.If RegistrationEventFromDate and RegistrationEventToDate are the same, the search will only look for events that occurred on the specified date.The value must not be after the date specified as the RegistrationEventToDate in the original search criteria. That is, the filter criteria cannot expand the registration events returned in the original search result to include registration events that occurred after those in the original search result. Note: A time should not be specified. However, if a time component is specified it is ignored by PPSR.


UNCLASSIFIED

4.5.13.3 Message Contracts4.5.13.3.1 FilterGrantorAndEventDateRangeSearchResultRequestMessage

FilterGrantorAndEventDateRangeSearchResultRequestMessage


FilterGrantorAndEventDateRangeSearchResultRequestType


PropertiesFilterCriteria : SearchByGrantorAndEventDateRangeFilterCriteriaSearchNumber : string

FilterGrantorAndEventDateRangeSearchResultRequest


FilterGrantorAndEventDateRangeSearchResultRequestMessage


1..1 FilterGrantorAndEventDateRangeResultRequest




1..1 SearchNumber string(16) The SearchNumber of the search result to filter.

1..1 FilterCriteria SearchByGrantorAndEventDateRangeFilterCriteria

See section 4.5.13.2.1 SearchByGrantorAndEventDateRangeFilterCriteria for details.


UNCLASSIFIED

4.5.13.3.2 FilterGrantorAndEventDateRangeSearchResultResponseMessage

FilterGrantorAndEventDateRangeSearchResultResponseMessageClass

FilterGrantorAndEventDateRangeSearchResultResponseType


PropertiesFilterCriteria : SearchByGrantorAndEventDateRangeFilterCriteriaFilterSummary : FilterSummary

FilterGrantorAndEventDateRangeSearchResultResponse


FilterGrantorAndEventDateRangeSearchResultResponseMessage

1..1 FilterGrantorAndEventDateRange FilterGrantorAndEventDateRangeSearchResultResponseType

FilterGrantorAndEventDateRangeSearchResultResponseType


1..1 FilterSummary FilterSummary See section 4.5.3.2 Filter Summary for details.

1..1 FilterCriteria SearchByGrantorAndEventDateRangeFilterCriteria

See section 4.5.13.2.1 SearchByGrantorAndEventDateRangeFilterCriteria for details.


UNCLASSIFIED




4.5.13-10 The FilterGrantorAndEventDateRangeSearchResultRequest element must be provided.




4.5.13-40 The SearchNumber must be for a Search By Grantor And Event Date Range. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41056



4.5.13-60 The FilterCriteria element must be provided. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41053

4.5.13-70 The date specified in the RegistrationEventFromDate must not be before the value of RegistrationEventFromDate specified in the original search.


4.5.13-80 The date specified in the RegistrationEventToDate must not be later than the value of RegistrationEventToDate specified in the original search.



UNCLASSIFIED


4.5.13-90 Either the date specified in the RegistrationEventFromDate must be later than the value of RegistrationEventFromDate specified in the original search, or the date specified in the RegistrationEventToDate must be before the value of RegistrationEventToDate specified in the original search. That is, the filtered date range must be less than the date range in the original search.


4.5.13-100 The date specified in the RegistrationEventToDate must not be before the date specified in the RegistrationEventFromDate.


4.5.1313-110

There must be no validation errors from the request. Fault Detail Type: PpsrCollateralRegistrationSearchValidationFaultDetailError Number: 694


UNCLASSIFIED

4.5.14 Retrieve Registration History Detail

This operation returns an earlier version of a Registration than the version that was included in a search result.



Operation Name: RetrieveRegistrationHistoryDetail

Request: RetrieveRegistrationHistoryDetailRequestMessage

Response: RetrieveRegistrationHistoryDetailResponseMessage


UNCLASSIFIED


4.5.14.2.1 RetrieveRegistrationHistoryDetailRequestMessage

RetrieveRegistrationHistoryDetailRequestMessage


RetrieveRegistrationHistoryDetailRequestType


PropertiesChangeNumber : longRegistrationNumber : stringSearchNumber : string

RetrieveRegistrationHistoryDetailRequest


RetrieveRegistrationHistoryDetailRequestMessage


1..1 RetrieveRegistrationHistoryDetailRequest




1..1 SearchNumber string(16) The Search Number of the search which returned the specified Registration Number and Change Number.

1..1 RegistrationNumber string(20) The Registration Number of the Registration for which the history details are to be retrieved.The Registration Number must be for a Registration that was included in the search result.


UNCLASSIFIED


1..1 ChangeNumber long The Change Number of the change for which the history details are to be retrieved.The Change Number must be correct for the specified registration.The Change Number provided must be for a change to the specified registration that occurred on or before the highest Change Number included in the search result for the registration.

4.5.14.2.2 RetrieveRegistrationHistoryDetailResponseMessage

RetrieveRegistrationHistoryDetailResponseMessageClass

RetrieveRegistrationHistoryDetailResponseType


PropertiesResultDetail : ResultDetail

RetrieveRegistrationHistoryDetailResponse


RetrieveRegistrationHistoryDetailResponseMessage

1..1 RetrieveRegistrationHistoryDetailResponse




1..1 ResultDetail ResultDetail See section 4.5.3.3 Result Detail for details.


UNCLASSIFIED


Note that the ChangeHistory in the ResultDetail will not be populated.



4.5.14-10 The RetrieveRegistrationHistoryDetailRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005



4.5.14-40 The search must not have been an Ordinal Search. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41025




4.5.14-70 The RegistrationNumber must have been included in the search result for the SearchNumber.


4.5.14-80 If the RegistrationNumber is for a registration marked as “access is restricted”, the Account Customer must be authorised to retrieve “access is restricted” registrations.


4.5.14-90 If the RegistrationNumber is for an archived registration, the Account Customer must be authorised to retrieve archived registrations.



UNCLASSIFIED


4.5.14-100 If the RegistrationNumber is for a removed registration, the Account Customer must be authorised to retrieve removed registrations.


4.5.14-110 The ChangeNumber must be correct for the RegistrationNumber. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41029

4.5.14-120 The Change Number provided must be for a change to the specified registration that occurred on or before the highest Change Number included in the search result for the registration.



UNCLASSIFIED

4.5.15 Request Search Certificate

This operation is used to request the generation of a search certificate for a search result or a specific Registration returned by a search. The search certificate is a PDF file that can be printed to provide evidence of the search result.

The same operation is used to request a search certificate for:

the entire search result (for Search By Grantor or Search By Grantor And Event Date Range, a search certificate for the entire search result is only allowed when there are no records in the search result) – just provide the Search Number in the request message;

the current details (at the time of the search) for a single Registration in the search result – provide the Search Number, the Registration Number and (optionally) the Change Number in the request message; or

a previous version (at a specified Change Number) for a single Registration in the search result – provide the Search Number, the Registration Number and the Change Number in the request message.

If a Change Number is not provided when a Registration Number has been provided, then the search certificate will be issued for the version of the registration that was returned in the search result. This allows for a search certificate to be requested for a registration that has been marked as “access is restricted” and the Change Number has not been provided in the search result.

Note: It is possible for the same registration to be included more than once in the search result for a Search By Grantor And Event Date Range. If a search certificate is requested for such a registration without specifying a Change Number, the search certificate will be issued for the latest Change Number that was returned in the search result for the specified Registration Number. If a user is not authorised to access details of an “access is restricted” registration that is included more than once in a search result, the user will only be able to produce a search certificate for the latest Change Number. The only time this would make any difference to the search certificate produced would be when the end time of the registration differs between the two Change Numbers.

The search certificate will be produced asynchronously. Production of the search certificate will be queued for immediate processing and most certificates should be available within a matter of seconds. However, as many search certificates will require verifications to be undertaken with systems external to PPSR (e.g. verification of Grantor ACNs with ASIC) the time required to produce the certificate will depend upon the number of verifications required for the certificate and the overall demand for verifications with external systems. The response message will contain the Search Certificate Number for the search certificate that will be produced. The Retrieve Search Certificate operation must be called to retrieve the search certificate using the Search Certificate Number.


UNCLASSIFIED



Operation Name: RequestSearchCertificate

Request: RequestSearchCertificateRequestMessage

Response: RequestSearchCertificateResponseMessage


4.5.15.2.1 RequestSearchCertificateRequestMessage

RequestSearchCertificateRequestMessage


RequestSearchCertificateRequestType


PropertiesChangeNumber : long?RegistrationNumber : stringSearchNumber : string

RequestSearchCertificateRequest


RequestSearchCertificateRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.


UNCLASSIFIED


1..1 RequestSearchCertificateRequest RequestSearchCertificateRequestType

RequestSearchCertificateRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SearchNumber string(16) The Search Number of the search result for which the Search Certificate is required.

0..1 RegistrationNumber string(20) The Registration Number of the registration for which the Search Certificate is required.Provide a Registration Number if the required Search Certificate is for a single registration in the search result for a Search By Serial Number, Search By Grantor, Search By Grantor And Event Date Range or Search By Registration Number.Do not provide a Registration Number if the required Search Certificate is for one of the following: The entire search result for a Search By

Serial Number. A Search By Serial Number for which

there are no registrations in the search result.

A Search By Grantor or Search By Grantor And Event Date Range for which there are no registrations in the search result.

A Search By Registration Number and there is no registration for the Registration Number specified in the search criteria.

An Ordinal Search.If a Registration Number is provided, the Registration Number must be for a registration that was included in the search result.

0..1 ChangeNumber long The Change Number of the version of the registration for which the Search Certificate is required.A Change Number must be provided only if a Registration Number is provided.The Change Number provided must be correct for the specified registration.The Change Number provided must be for a change to the specified registration that occurred on or before the highest Change


UNCLASSIFIED


Number included in the search result for the registration.If a Change Number is not provided when a Registration Number has been provided, then the search certificate will be issued for the version of the registration that was returned in the search result. Note: It is possible for the same registration to be included more than once in the search result for a Search By Grantor And Event Date Range. If a search certificate is requested for such a registration without specifying a Change Number, the search certificate will be issued for the latest Change Number that was returned in the search result for the specified Registration Number.

4.5.15.2.2 RequestSearchCertificateResponseMessage

RequestSearchCertificateResponseMessageClass

RequestSearchCertificateResponseType


PropertiesAccessToSearchCertificateExpiryTime : DateTimePpsrTransactionId : longSearchCertificateNumber : stringSearchCertificateRequestedDateTime : DateTime

RequestSearchCertificateResponse


UNCLASSIFIED


RequestSearchCertificateResponseMessage

1..1 RequestSearchCertificateResponse RequestSearchCertificateResponseType

RequestSearchCertificateResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


1..1 SearchCertificateNumber string(50) The Search Certificate Number generated by PPSR for this Search Certificate request.

1..1 SearchCertificateRequestedDateTime

dateTime The date and time the Search Certificate was requested.

1..1 AccessToSearchCertificateExpiryTime

dateTime The date and time of expiry of the search certificate access period. See section 4.5.1.6 Search Result Access Expiry and Search Certificate Access Expiry for details.



4.5.15-10 The RequestSearchCertificateRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005



4.5.15-40 If the search was an Ordinal Search, a value must not be provided for RegistrationNumber.



UNCLASSIFIED


4.5.15-50 If the search was a Search By Registration Number, Search By Grantor, Search By Grantor And Event Date Range or Search By Serial Number and there were no registrations returned in the search result, a value must not be provided for RegistrationNumber.


4.5.15-60 If the search was a Search By Grantor or Search By Grantor And Event Date Range and there was at least one registration returned in the search result, a value must be provided for RegistrationNumber.


4.5.15-70 If a value is provided for RegistrationNumber, the RegistrationNumber must be for a registration that was included in the search result.


4.5.15-80 If a value is not provided for RegistrationNumber, a value must not be provided for ChangeNumber.


4.5.15-90 If a value is provided for ChangeNumber, the ChangeNumber must be correct for the RegistrationNumber.


4.5.15-100 If a value is provided for ChangeNumber, the ChangeNumber must be for a change to the specified registration that occurred on or before the highest Change Number included in the search result for the registration.


4.5.15-110 If a value is provided for RegistrationNumber and the specified registration is archived, the Account Customer must be authorised to retrieve archived registrations.


4.5.15-120 If a value is provided for RegistrationNumber and the specified registration is removed, the Account Customer must be authorised to retrieve removed registrations.



UNCLASSIFIED

4.5.16 Retrieve Search Certificate

This operation is used to retrieve a previously requested search certificate.

The search certificate will be produced asynchronously to the request for the search certificate. Production of the search certificate will be queued for immediate processing and most certificates should be available within a matter of seconds. If the Retrieve Search Certificate operation is called before the Search Certificate has been produced, the response message will contain a null value in the SearchCertificateFile element of the response.

If a registration in a search certificate has been Removed, or marked as “Access is restricted” between the generation and retrieval of the search certificate (and the user does not have the appropriate permissions), then the search certificate will not be able to be retrieved. In most cases a new search certificate can be requested.

If the search certificate includes a registration that has one or more attachments, the search certificate PDF file will include two pages for each registration attachment. The first page describes the attachment and the second page is a placeholder for the attachment. To complete a printed version of the search certificate, each registration attachment needs to be separately downloaded using the Retrieve Search Certificate Registration Attachment operation, and the placeholder page replaced with the actual attachment.



Operation Name: RetrieveSearchCertificate

Request: RetrieveSearchCertificateRequestMessage

Response: RetrieveSearchCertificateResponseMessage


UNCLASSIFIED


4.5.16.2.1 RetrieveSearchCertificateRequestMessage

RetrieveSearchCertificateRequestMessage


RetrieveSearchCertificateRequestType


PropertiesSearchCertificateNumber : string

RetrieveSearchCertificateRequest


RetrieveSearchCertificateRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RetrieveSearchCertificateRequest RetrieveSearchCertificateRequestType

RetrieveSearchCertificateRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 SearchCertificateNumber string(50) The Search Certificate Number of the required Search Certificate.


UNCLASSIFIED

4.5.16.2.2 RetrieveSearchCertificateResponseMessage

RetrieveSearchCertificateResponseMessageClass

RetrieveSearchCertificateResponseType


PropertiesAccessToSearchCertificateExpiryTime : DateTimePpsrTransactionId : longSearchCertificateCreatedDateTime : DateTimeSearchCertificateFile : byte[]SearchCertificateFileName : stringSearchCertificateNumber : string

AttachmentDetailClass

PropertiesAttachmentDescription : stringAttachmentFileName : stringAttachmentFileSizeBytes : intAttachmentId : longIsMigratedAttachment : bool

RetrieveSearchCertificateResponse

Attachments : List<AttachmentDetail>


RetrieveSearchCertificateResponseMessage

1..1 RetrieveSearchCertificateResponse RetrieveSearchCertificateResponseType

RetrieveSearchCertificateResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


1..1 SearchCertificateNumber string(50) The Search Certificate Number of this Search Certificate.

0..1 SearchCertificateCreatedDateTime dateTime The date and time the Search Certificate was created.If the Search Certificate has not been produced yet, this will be null.


dateTime The date and time of expiry of the search certificate access period. See section 4.5.1.6 Search Result Access Expiry and Search


UNCLASSIFIED


Certificate Access Expiry for details.

0..1 SearchCertificateFileName string(255) The file name for the Search Certificate PDF file. If the Search Certificate has not been produced yet, this will be null.

0..1 SearchCertificateFile byte[] The PDF file that is the Search Certificate as a byte array. If the Search Certificate has not been produced yet, this will be null.

0…* Attachments List<AttachmentDetail> If the search certificate is for a single registration that has one or more attachments, the Attachments element contains details of the attachments.Note that this element does not contain the actual attachment file. The RetrieveSearchCertificateRegistrationAttachment operation is used to retrieve the actual attachment file. See section 4.5.17 Retrieve Search Result Registration Attachment.If the Search Certificate has not been produced yet, this will be null, even if the certificate is for a single registration that has attachments.If the search certificate is for a single registration that has attachments, but the search certificate shows that the registration is access restricted and only limited details for the registration are included in the certificate, the Attachments element will be null.





1..1 IsMigratedAttachment boolean For registrations that were migrated from other registers prior to commencement of PPSR, an attachment may have been created when the Registration was migrated from its source register that contains additional data provided by the source register that is not supported by PPSR.IsMigratedAttachment indicates whether the


UNCLASSIFIED


attachment is such an attachment.Note that attachments that existed in source registers prior to migration to PPSR and have been brought across to PPSR are not migrated attachments and the value of IsMigratedAttachment will be “false”.



4.5.16-10 The RetrieveSearchCertificateRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.5.16-20 The value provided for SearchCertificateNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41083

4.5.16-30 The value provided for SearchCertificateNumber must be for an existing search certificate.


4.5.16-40 The search certificate must not have been archived. Fault Detail Type: PpsrSoapFaultDetailError Number: 1702

4.5.16-50 No Registration in the search certificate may have been marked as “access is restricted” or Removed since the search certificate was generated.



UNCLASSIFIED

4.5.17 Retrieve Search Certificate Registration Attachment

This operation retrieves an attachment for a Registration in a Search Certificate.



Operation Name: RetrieveSearchCertificateRegistrationAttachment

Request: RetrieveSearchCertificateRegistrationAttachmentRequestMessage

Response: RetrieveSearchCertificateRegistrationAttachmentResponseMessage


UNCLASSIFIED


4.5.17.2.1 RetrieveSearchCertificateRegistrationAttachmentRequestMessage

RetrieveSearchCertificateRegistrationAttachmentRequestMessage


RetrieveSearchCertificateRegistrationAttachmentRequestType


PropertiesAttachmentId : longSearchCertificateNumber : string

RetrieveSearchCertificateRegistrationAttachmentRequest


RetrieveSearchCertificateRegistrationAttachmentRequestMessage


1..1 RetrieveSearchCertificateRegistrationAttachmentRequest




1..1 SearchCertificateNumber string(50) The Search Certificate Number of the search certificate for which the Attachment is to be retrieved.

1..1 AttachmentId long The Attachment Id of the Attachment to be retrieved.The AttachmentId must be for an Attachment that was included in the specified search certificate.


UNCLASSIFIED

4.5.17.2.2 RetrieveSearchCertificateRegistrationAttachmentResponseMessage

RetrieveSearchCertificateRegistrationAttachmentResponseMessageClass

RetrieveSearchCertificateRegistrationAttachmentResponseType



RetrieveSearchCertificateRegistrationAttachmentResponse


RetrieveSearchCertificateRegistrationAttachmentResponseMessage

1..1 RetrieveSearchCertificateRegistrationAttachmentResponse








UNCLASSIFIED



4.5.17-10 The RetrieveSearchCertificateRegistrationAttachmentRequest element must be provided.


4.5.17-20 The value provided for SearchCertificateNumber must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41083

4.5.17-30 The SearchCertificateNumber must be for an existing search certificate. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41084

4.5.17-40 The search certificate must have been produced and be ready to be retrieved. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41085

4.5.17-50 The current time must be before the AccessToSearchCertificateExpiryTime of the search certificate.


4.5.17-60 The AttachmentId must be for an Attachment that was associated with the search certificate.



UNCLASSIFIED

4.5.18 Request Search Certificates

This operation is used to request the generation of a set of search certificates for a search result (covering the entire search; or one or more Registrations returned by the search) and to have the search certificates sent to an email address, a B2G Mailbox, or both.

Note: the search certificates are included in the email as attachments: the notification sent to the B2G mailbox is only a notification that the search certificates have been created. They will still need to be downloaded using the RetrieveSearchCertificate operation.

Details of search certificates (what they are, and details of how they can be specified) are covered in section 4.5.15 Request Search Certificate above. This operation differs from RequestSearchCertificate in the following ways:

RequestSearchCertificate. RequestSearchCertificates

Number of search certificates A single search certificate 1 or more search certificates

Delivery Must be retrieved using the RetrieveSearchCertificate operation.The client B2G system must poll the register until the certificate is available.

Sent to an email address and/or a B2G mailbox.As the search certificates are created, they are grouped into batches and sent.The individual search certificates can be retrieved using the RetrieveSearchCertificate operation



Operation Name: RequestSearchCertificates

Request: RequestSearchCertificatesRequestMessage

Response: RequestSearchCertificatesResponseMessage


UNCLASSIFIED


4.5.18.2.1 RequestSearchCertificatesRequestMessage


RequestSearchCertificatesRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RequestSearchCertificatesRequest RequestSearchCertificatesRequestType

RequestSearchCertificatesRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

0..1 B2GAccountCustomerNumber string(20) The B2G Mailbox that the notifications that the search certificates are generated are sent to.

0..1 NotificationEmailAddress string(250) The email address that the search certificates are sent to.


UNCLASSIFIED


1..1 SearchNumber string(16) The Search Number of the search result for which the Search Certificate is required.

0..* RegistrationNumbers List<string(20)> The Registration Number of the registrations for which a Search Certificate is required.Provide Registration Numbers if the required Search Certificate is for registrations in the search result for a Search By Grantor or Search By Grantor And Event Date Range Do not provide Registration Numbers if the required Search Certificate is for one of the following: A Search By Serial Number. A Search By Grantor or Search By Grantor

And Event Date Range for which there are no registrations in the search result.

A Search By Registration Number. An Ordinal Search.If a Registration Number is provided, the Registration Number must be for a registration that was included in the search result.


UNCLASSIFIED

4.5.18.2.2 RequestSearchCertificatesResponseMessage


UNCLASSIFIED


RequestSearchCertificatesResponseMessage

1..1 RequestSearchCertificatesResponse

RequestSearchCertificatesResponseType

RequestSearchCertificatesResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


dateTime The date and time of expiry of the search certificate access period. See section 4.5.1.6 Search Result Access Expiry and Search Certificate Access Expiry for details.


1..1 SearchCertificatesRequestedDateTime

dateTime The date and time the Search Certificate was requested.

1..1 SearchCertificateDetails List< SearchCertificateDetail> The Search Certificate Numbers generated by PPSR for this Search Certificates request.

SearchCertificateDetail 0..1 RegistrationNumber string(20) The Registration Number this search certificate is for (if applicable). If no registration numbers were provided in

the request, this element will not be returned.

If one or more registration numbers were provided in the request, this element will be one of those registration numbers

1..1 SearchCertificateNumber string(50) The Search Certificate Number generated by PPSR for this Search Certificate.



4.5.18-10 The RequestSearchCertificatesRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005



UNCLASSIFIED



4.5.18-40 If the search was a Search By Registration Number, Ordinal Search or Search By Serial Number, a value must not be provided for RegistrationNumbers.


4.5.18-50 If the search was a Search By Grantor or Search By Grantor And Event Date Range and there were no registrations returned in the search result, a value must not be provided for RegistrationNumbers.


4.5.18-60 If the search was a Search By Grantor or Search By Grantor And Event Date Range and there was at least one registration returned in the search result, a value must be provided for RegistrationNumbers.


4.5.18-70 If a value is provided for RegistrationNumber, the RegistrationNumber must be for a registration that was included in the search result.


4.5.18-80 If a value is provided for RegistrationNumber, it must not be an empty string. Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41000

4.5.18-90 If a value is provided for RegistrationNumber and the specified registration is archived, the Account Customer must be authorised to retrieve archived registrations.


4.5.18-100 If a value is provided for RegistrationNumber and the specified registration is removed, the Account Customer must be authorised to retrieve removed registrations.


4.5.18-110 One of B2GAccountCustomerNumber or NotificationEmailAddress must be provided.


4.5.18-120 If a value is provided for the NotificationEmailAddress element, then the value must be in a valid format for an email address


4.5.18-130 The B2GAccountCustomerNumber must be for an existing B2G account customer


4.5.18-140 Duplicate RegistrationNumber elements must not be provided Fault Detail Type: PpsrCollateralRegistrationSearchFaultDetailError Number: 41105


UNCLASSIFIED


UNCLASSIFIED

4.6 Report Service

The Report Service contains operations used to request the generation of reports and subsequently retrieve the report output. These include:

Request Report

Retrieve Report Summaries

Retrieve Report

Delete Report

The Report Service allows access to reports for a B2G Account Customer. PPSR uses the authentication credentials provided in the WS-Security header (see section 3.4 WS-Security) to determine the B2G Account Customer whose reports will be accessed by each operation. All location users for all locations for a B2G Account Customer will have access to all reports for an Account Customer, including reports requested through the Web Channel or by the Contact Centre on behalf of the Account Customer. Note that reports requested by a B2G Account Customer through the B2G Channel can also be accessed through the Web Channel, but will only be available to Web Channel users that can access all reports for the Account Customer regardless of the user that requested the report.

A report is requested using the Request Report operation. There are a number of different reports that can be requested. The request message will include the report type being requested and any required report criteria. The report criteria that can be specified will depend on the report type. The report types and the associated report criteria are defined in the document “Reports Technical Specification”.

Reports can be provided in different output formats (e.g. PDF, CSV, XML). The report format needs to be specified when requesting the report. The report output will be provided as a file in the requested format. For the report format types of CSV and XML, the structure of the data in the output file depends upon the report type. These are defined in the document “Reports Technical Specification”. Not all report formats are available for all report types. Which report formats are available for each report type is defined in the document “Reports Technical Specification”.

Reports are produced asynchronously. Production of a report will be queued for processing. The response message for the Request Report operation will contain the Report Number for the report that will be produced. The Retrieve Report operation must be called to retrieve the report using the Report Number.


UNCLASSIFIED

The Retrieve Report Summaries operation can be called to query summary information and the status of reports that have been requested by the Account Customer.

Once the report output has been produced and retrieved by the Account Customer, the report can be deleted from PPSR by calling the Delete Report operation. If the Account Customer does not delete a report, it will be deleted automatically by PPSR a pre-defined number of days after the report has been produced. The number of days after which reports are deleted has initially been set at 7 days, however this may be reviewed in the future. It is the Account Customer’s responsibility to ensure they retrieve their reports within 7 days. As long as a report has not been deleted it can be retrieved or re-retrieved using the Retrieve Report operation.


4.6.1.1 PpsrReportFaultDetail

PpsrReportFaultDetail



PpsrReportFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.


UNCLASSIFIED

4.6.1.2 PpsrReportValidationFaultDetail

PpsrReportValidationFaultDetail






PpsrReportValidationFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 ValidationErrors List<PpsrValidationError> A list of validation errors related to the report criteria.




UNCLASSIFIED

4.6.2 Request Report

This operation is used to request the generation of a report.

The request message will define the type of report being requested and any required report criteria. The output format of the report also needs to be specified (e.g. PDF, CSV, XML). The report output will be provided as a file in the requested format.

The reports will be produced asynchronously. Production of the report will be queued for processing. The response message will contain the Report Number for the report that will be produced. The Retrieve Report operation must be called to retrieve the report using the Report Number. An optional notification email can be sent when the report has been produced and is ready to be retrieved.


Service Name: Report

Operation Name: RequestReport

Request: RequestReportRequestMessage

Response: RequestReportResponseMessage


UNCLASSIFIED


4.6.2.2.1 RequestReportRequestMessage

RequestReportRequestMessage


RequestReportRequestType


PropertiesReportCriteria : XElementReportReadyNotificationEmailAddress : stringReportType : string

ReportFormatTypeEnum

UnsupportedXmlPdfCsv

RequestReportRequest

ReportFormat


RequestReportRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RequestReportRequest RequestReportRequestType

RequestReportRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 ReportType string(50) The type of report being requested. The value of ReportType must be one of the values defined in the document “Reports Technical Specification”.

1..1 ReportFormat ReportFormatType The format of the report output (e.g. PDF, CSV, XML). See section 5.16 ReportFormatType for details.The ReportFormat must be allowed for the specified ReportType. See the document


UNCLASSIFIED


“Reports Technical Specification” for details of which report formats are available for each report type.

1..1 ReportCriteria XElement The report criteria for the report request as XML.The structure of the XML depends upon the report type. See the document “Reports Technical Specification” for more information about the XML structure for the different report types.

0..1 ReportReadyNotificationEmailAddress

string(250) An optional email address to receive a notification from PPSR when the report has been produced.

4.6.2.2.2 RequestReportResponseMessage

RequestReportResponseMessageClass

RequestReportResponseType


PropertiesPpsrTransactionId : longReportNumber : string

RequestReportResponse


UNCLASSIFIED


RequestReportResponseMessage 1..1 RequestReportResponse RequestReportResponseType

RequestReportResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 ReportNumber string(20) The Report Number assigned by PPSR to the Report. This number is used to retrieve the report once it has been produced.



This section documents the business rules that are common to all report requests.

In addition to the business rules that are defined here, there will be business rules that relate to the specific report criteria for each different type of report. The report specific business rules are defined in the document “Reports Technical Specification”. If there are any business rule violations in the report specific business rules, these will be returned as a SOAP Fault where the content of the SOAP fault detail element is PpsrReportValidationFaultDetail and the value of the ErrorNumber is 714. The PpsrReportValidationFaultDetail allows multiple business rule violations to be reported, each with a unique ErrorNumber. These error numbers are defined in the document “Reports Technical Specification”.


4.6.2-10 The RequestReportRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.6.2-20 The value provided for ReportType must not be an empty string. Fault Detail Type: PpsrReportFaultDetailError Number: 45000

4.6.2-30 The value provided for ReportType must be a valid report type (see the document “Reports Technical Specification”).

Fault Detail Type: PpsrReportFaultDetailError Number: 45001

4.6.2-40 The Account Customer must be authorised to request reports for the specified ReportType.



UNCLASSIFIED


4.6.2-50 The value provided for ReportFormat must not be Unsupported. Fault Detail Type: PpsrReportFaultDetailError Number: 45002

4.6.2-60 The value provided for ReportFormat must be allowed for the specified ReportType (see the document “Reports Technical Specification”).


4.6.2-70 If a value is provided for the ReportReadyNotificationEmailAddress element, then the value must be in a valid format for an email address.


4.6.2-80 The ReportCriteria element must be provided. Fault Detail Type: PpsrReportFaultDetailError Number: 45003

4.6.2-90 The XML content in the ReportCriteria element must be the correct datatype for the specified ReportType (see the document “Reports Technical Specification”).


4.6.2-100 The XML content in the ReportCriteria element must pass all business rule checks for the specified ReportType (see the document “Reports Technical Specification”).

Fault Detail Type: PpsrReportValidationFaultDetailThe actual Error Numbers for the report specific business rules are defined in the document “Reports Technical Specification”.

4.6.2-10 There must be no validation errors from the request. Fault Detail Type: PpsrReportValidationFaultDetailError Number: 714


UNCLASSIFIED

4.6.3 Retrieve Report Summaries

This operation is used to retrieve summary information and the status of reports that have been recently requested by the Account Customer.

The operation can return information about reports that have been requested but not yet deleted from PPSR. This includes reports that have not yet been produced.

The summary of a report returned by the operation will include the status of the report (whether it has been produced yet), the report type and the report criteria used.

As well as retrieving summaries of all reports not yet deleted, the operation can be used to retrieve a summary of a single report (by Report Number) or summaries of all reports of a specific report type.



Operation Name: RetrieveReportSummaries

Request: RetrieveReportSummariesRequestMessage

Response: RetrieveReportSummariesResponseMessage


UNCLASSIFIED


4.6.3.2.1 RetrieveReportSummariesRequestMessage

RetrieveReportSummariesRequestMessage


RetrieveReportSummariesRequestType


PropertiesReportNumber : stringReportType : string

RetrieveReportSummariesRequest


RetrieveReportSummariesRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RetrieveReportSummariesRequest RetrieveReportSummariesRequestType

RetrieveReportSummariesRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

0..1 ReportNumber string(20) An optional Report Number to restrict the report summaries returned to only include the report summary of the specified Report Number.If the report for the specified Report Number is for a report that does not exist (including a report that has been deleted) or for a report requested by a different Account Customer, the list of Report Summaries will be empty.

0..1 ReportType string(50) An optional Report Type to restrict the report summaries returned to only include the report


UNCLASSIFIED


summaries of reports of the specified Report Type.The value of ReportType must be a one of the values defined in the document “Reports Technical Specification”.


UNCLASSIFIED

4.6.3.2.2 RetrieveReportSummariesResponseMessage

RetrieveReportSummariesResponseMessageClass

RetrieveReportSummariesResponseType


ReportSummaryClass

PropertiesPdfFilePageCount : int?ReportCriteria : XElementReportExpiryDateTime : DateTime?ReportFileName : stringReportFileSizeBytes : int?ReportNumber : stringReportProducedDateTime : DateTime?ReportRequestedB2GAccountCustomerLocation : stringReportRequestedDateTime : DateTimeReportRequestedUsername : stringReportType : string



ReportStatusTypeEnum

UnsupportedProcessingPendingProcessingCompleted

ReportRequestedChannelTypeEnum

UnsupportedB2GWebContactCentre

RetrieveReportSummariesResponse

ReportSummaries : List<ReportSummary>

ReportFormat

ReportRequestedChannel

ReportStatus


UNCLASSIFIED


RetrieveReportSummariesResponseMessage 1..1 RetrieveReportSummariesResponse RetrieveReportSummariesResponseType

RetrieveReportSummariesResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

0..* ReportSummaries List<ReportSummary> A list of Report Summaries. If the request message included a Report Number and/or Report Type, only Report Summaries for the specified Report Number and/or Report Type will be included.

ReportSummary 1..1 ReportNumber string(20) The Report Number of the report.

1..1 ReportType string(50) The Report Type of the report.The value will be one of the values defined in the document “Reports Technical Specification”.

1..1 ReportFormat ReportFormatType The format of the report output (e.g. PDF, CSV, XML). See section 5.16 ReportFormatType for details.

1..1 ReportCriteria XElement The report criteria used for the report request, as XML.The structure of the XML depends upon the report type. See the document “Reports Technical Specification” for more information about the XML structure for the different report types.

1..1 ReportRequestedChannel ReportRequestedChannelType The channel used when the report was requested (e.g. Web, B2G, Contact Centre). See section 5.17 ReportRequestedChannelType for details.

1..1 ReportRequestedUsername string(40) The username of the user that requested the report.If the report was requested by the B2G Channel, this will be for the B2G Account Customer Location User used to request the report.If the report was requested by the Web Channel, this will be for the Account Customer user that requested the report.If the report was requested by the Contact Centre Channel, this will just be ‘Contact Centre’.


UNCLASSIFIED


0..1 ReportRequestedB2GAccountCustomerLocation

string(50) If the report was requested by the B2G Channel, this will be for the B2G Account Customer Location used to request the report.If the report was not requested by the B2G Channel, this will be null.

1..1 ReportStatus ReportStatusType The status of the report. This is used to indicate whether the report has been produced and is available to be retrieved. See section 5.18 ReportStatusType for details.

0..1 ReportFileName string(255) The file name of the output file for the report.If the report has not been produced yet, this will be null.

0..1 ReportFileSizeBytes int The size of the output file for the report in bytes.If the report has not been produced yet, this will be null.

0..1 PdfFilePageCount int If the report format is PDF, the number of pages in the PDF file.If the report format is not PDF or the report has not been produced yet, this will be null.

1..1 ReportRequestedDateTime dateTime The date and time the report was requested.

0..1 ReportProducedDateTime dateTime The date and time the report was produced.If the report has not been produced yet, this will be null.

0..1 ReportExpiryDateTime dateTime The date and time the report will expire. After this time the report will be deleted and can no longer be accessed.If the report has not been produced yet, this will be null.


UNCLASSIFIED



4.6.3-10 The RetrieveReportSummariesRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.6.3-20 If a value is provided for ReportType, the value must be a valid report type (see the document “Reports Technical Specification”.



UNCLASSIFIED

4.6.4 Retrieve Report

This operation is used to retrieve a previously requested report, using the Report Number returned when the report was requested.

The report will be produced asynchronously to the request for the report. Production of the report will be queued for processing. If the Retrieve Report operation is called before the report has been produced, the response message will contain a null value in the ReportFile element of the response.

Reports can be provided in different output formats (e.g. PDF, CSV, XML). The report format is specified when requesting the report. The report output will be provided as a file in the requested format.

For the report format types of CSV and XML, the structure of the data in the output file depends upon the report type. See the document “Reports Technical Specification” for more information about the CSV and XML structure for the different report types.

If there is no report for the specified Report Number (i.e. a report for the Report Number has never existed or the report has already been deleted) or the Report Number is for a report requested by a different Account Customer, a SOAP fault will be returned.



Operation Name: RetrieveReport

Request: RetrieveReportRequestMessage

Response: RetrieveReportResponseMessage


UNCLASSIFIED


4.6.4.2.1 RetrieveReportRequestMessage

RetrieveReportRequestMessage


RetrieveReportRequestType


PropertiesReportNumber : string

RetrieveReportRequest


RetrieveReportRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RetrieveReportRequest RetrieveReportRequestType

RetrieveReportRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 ReportNumber string(20) The Report Number of the report to retrieve.


UNCLASSIFIED

4.6.4.2.2 RetrieveReportResponseMessage

RetrieveReportResponseMessageClass

RetrieveReportResponseType


PropertiesPpsrTransactionId : longReportExpiryDateTime : DateTime?ReportFile : byte[]ReportFileName : stringReportNumber : stringReportType : string



RetrieveReportResponse

ReportFormat


RetrieveReportResponseMessage 1..1 RetrieveReportResponse RetrieveReportResponseType

RetrieveReportResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


1..1 ReportNumber string(20) The Report Number of the report.

1..1 ReportType string(50) The Report Type of the report.The value will be one of the values defined in the document “Reports Technical Specification”.

1..1 ReportFormat ReportFormatType The format of the report output (e.g. PDF, CSV, XML). See section 5.16 ReportFormatType for details.


UNCLASSIFIED


0..1 ReportFileName string(255) The file name of the output file for the report.If the Report has not been produced yet, this will be null.

0..1 ReportFile byte[] The file that is the report output as a byte array. If the report has not been produced yet, this will be null.

0..1 ReportExpiryDateTime dateTime The date and time the report will expire. After this time the report will be deleted and can no longer be accessed.If the Report has not been produced yet, this will be null.



4.6.4-10 The RetrieveReportRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.6.4-20 The value provided for ReportNumber must not be an empty string. Fault Detail Type: PpsrReportFaultDetailError Number: 45006

4.6.4-30 The value provided for ReportNumber must be for an existing report for the B2G Account Customer. That is, a report that has been requested by the Account Customer (either by the Web or B2G Channel, or by the Contact Centre on behalf of the Account Customer) and the report has not been deleted.


4.6.4-40 The value provided for ReportNumber must not be a Report Number for a failed or discarded report.


4.6.4-50 The value provided for ReportNumber must not be a Report Number for a cancelled report.



UNCLASSIFIED


UNCLASSIFIED

4.6.5 DeleteReport

This operation is used to delete an existing report. If a report has been requested but not yet produced it cannot be deleted. A report can only be deleted after it has been produced.



Operation Name: DeleteReport

Request: DeleteReportRequestMessage

Response: DeleteReportResponseMessage


UNCLASSIFIED


4.6.5.2.1 DeleteReportRequestMessage

DeleteReportRequestMessage


DeleteReportRequestType


PropertiesReportNumber : string

DeleteReportRequest


DeleteReportRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 DeleteReportRequest DeleteReportRequestType

DeleteReportRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 ReportNumber string(20) The Report Number of the report to delete.


UNCLASSIFIED

4.6.5.2.2 DeleteReportResponseMessage

DeleteReportResponseMessageClass

DeleteReportResponseType



DeleteReportResponse


DeleteReportResponseMessage 1..1 DeleteReportResponse DeleteReportResponseType

DeleteReportResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.




4.6.5-10 The DeleteReportRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


UNCLASSIFIED


4.6.5-20 The value provided for ReportNumber must not be an empty string. Fault Detail Type: PpsrReportFaultDetailError Number: 45006

4.6.5-30 The value provided for ReportNumber must be for an existing report for the B2G Account Customer. That is, a report that has been requested by the Account Customer (either by the Web or B2G Channel, or by the Contact Centre on behalf of the Account Customer) and the report has not been deleted.


4.6.5-40 The value provided for ReportNumber must be for a report that has been produced. That is, it is still not waiting to be produced.



UNCLASSIFIED

4.7 B2G Mailbox Service

The B2G Mailbox Service contains operations that manage B2G Mailbox Messages for a B2G Account Customer. These include:

Retrieve Messages

Retrieve Message PDF

Delete Messages

PPSR uses the authentication credentials provided in the WS-Security header (see section 3.4 WS-Security) to determine the appropriate B2G Mailbox that will be accessed by each operation. All username/passwords for all locations for a B2G Account Customer will have access to all B2G Mailbox Messages for a B2G Account Customer.

There are various types of B2G Mailbox Messages, depending on the content being delivered. For more information on the various types of B2G Mailbox Messages, refer to the document “B2G Mailbox Notifications”. The Retrieve Messages operation is used to retrieve all types of messages. The Retrieve Messages operation can be used to retrieve messages of just a specific notification type, or to retrieve messages of any notification type. The request message for the Retrieve Messages operation contains filter criteria that determine which B2G Mailbox Messages will be returned. The response message for the Retrieve Messages operation will contain B2G Mailbox Messages in the B2G Mailbox for the B2G Account Customer that match the filter criteria provided in the request message.

The Retrieve Messages operation returns message metadata and the message content of each matching B2G Mailbox Message. The metadata includes data items such as a unique Message Id for the message, the date/time the message was added to the B2G Mailbox and the notification type. The message content is returned as XML. The structure of the XML in each B2G Mailbox Message depends on the notification type of the message. Refer to the document “B2G Mailbox Notifications” for a description of the XML structure for each notification type.

Some B2G Mailbox Messages are provided as a PDF document in addition to the XML version of the message (e.g. a Verification Statement). When a PDF document is provided for a B2G Mailbox Message, the PDF document is not included in the response to the Retrieve Messages operation. However, the message metadata will contain an indicator that there is a PDF document for the message available. The Retrieve Message PDF operation can then be used to retrieve the PDF document for a specific B2G Mailbox Message based on its unique Message Id.

When a B2G Mailbox Message is retrieved, it is not deleted but is flagged as having been retrieved. A B2G Mailbox Message will remain in the B2G Mailbox until it is explicitly deleted using the Delete Messages operation, or until it becomes ‘stale’. A B2G Mailbox Message


UNCLASSIFIED

becomes stale once it has been in the B2G Mailbox for a pre-defined number of days. The age at which a B2G Mailbox Message becomes stale has initially been set at 60 days, however this may be reviewed in the future. If a B2G Mailbox Message remains in the B2G Mailbox after 60 days it will be deleted by PPSR. It is the B2G Account Customer’s responsibility to ensure they retrieve their B2G Mailbox Messages within 60 days. As long as a B2G Mailbox message has not been deleted it can be retrieved or re-retrieved using the Retrieve Messages operation.


UNCLASSIFIED


4.7.1.1 PpsrB2GMailboxMessageAccessFaultDetail

This class is used when a specific B2G Mailbox Message is accessed by its unique Message Id and the B2G Mailbox Message with that Message Id does not exist in the Account Customer’s B2G Mailbox.

PpsrB2GMailboxMessageAccessFaultDetail


PropertiesB2GMailboxMessageId : string


PpsrB2GMailboxMessageAccessFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 B2GMailboxMessageId long The unique identifier of the B2G Mailbox Message that resulted in the error.


UNCLASSIFIED

4.7.2 Retrieve Messages

This operation is used to retrieve B2G Mailbox Messages from the Account Customer’s B2G Mailbox.

The request message provided when the operation is called can include optional filter criteria to determine which B2G Mailbox Messages will be returned. The filter criteria allow for any combination of the following:

A specific registration (either the Registration Number and/or Change Number)

A date/time range for when messages were added to the B2G Mailbox

A range of B2G Mailbox Message Ids

An indicator to include previously retrieved B2G Mailbox Messages

A specific Giving Of Notice identifier

A specific Customer’s Request Message Id

A specific Secured Party Group Number

A specific notification type

The response message will contain B2G Mailbox Messages in the Account Customer’s B2G Mailbox that match all specified filter criteria.

A limit is placed on the number of messages that will be returned by each call to the Retrieve Messages operation. Therefore it is possible that not all messages in the B2G Mailbox that meet the filter criteria will be returned. The maximum number of messages that will be returned in a single call to the Retrieve Messages operation has initially been set at 100, however this may be reviewed in the future. If there are more than 100 messages that match the filter criteria, only the oldest 100 messages that match the filter criteria will be returned.

When designing a B2G Customer application to retrieve messages from the B2G Mailbox, consideration needs to be given to ensuring that the same messages are not repeatedly retrieved. Two simple ways to achieve this are to delete messages as soon as they have been retrieved and saved or processed by the B2G Customer’s application, or to exclude the IncludePreviouslyRetrievedMessages filter criteria to limit messages to only those that have not previously been retrieved. If the second approach is used, care must be taken in the case of a system error within the B2G Customer’s application where PPSR has flagged messages as having been retrieved but they have not all been received or processed by the B2G Customer’s application.


UNCLASSIFIED

Another approach to retrieve only those messages that have not yet been processed by a B2G Customer application is to use the MessageAfterMessageId filter criteria and keep track of the B2GMailboxMessageId of the last message processed or saved by the B2G Customer’s application. The B2GMailboxMessageId of messages are allocated sequentially as new messages are added to B2G Mailboxes. Therefore, a message with a B2GMailboxMessageId that is less than the B2GMailboxMessageId of a second message is older than the second message. When messages are returned by the Retrieve Messages operation, they are returned in order of B2GMailboxMessageId, with the oldest messages returned first.

The content of all messages returned by this operation is in XML format. If a message is also provided as a PDF document, then the HasPdf indicator element within the response message has a value of “true”. The PDF document for a message can be retrieved by calling the RetrieveMessagePDF operation with the message’s unique B2G Mailbox Message Id.

The XML content of each message is dependant on the notification type of the B2G Message. Refer to the document “B2G Mailbox Notifications” for a description of the XML structure for each notification type.


Service Name: B2GMailbox

Operation Name: RetrieveMessages

Request: RetrieveMessagesRequestMessage

Response: RetrieveMessagesResponseMessage


UNCLASSIFIED


4.7.2.2.1 RetrieveMessagesRequestMessage

RetrieveMessagesRequestMessage


RetrieveMessagesRequestType


PropertiesChangeNumber : long?GivingOfNoticeIdentifier : stringIncludePreviouslyRetrievedMessages : bool?MessagesAddedFromDateTime : DateTime?MessagesAddedToDateTime : DateTime?MessagesAfterMessageId : long?MessagesBeforeMessageId : long?NotificationType : stringOriginalCustomersRequestMessageId : stringRegistrationNumber : stringSecuredPartyGroupNumber : string

RetrieveMessagesRequest


RetrieveMessagesRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RetrieveMessagesRequest RetrieveMessagesRequestType

RetrieveMessagesRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

0..1 ChangeNumber long If provided, then only messages for the Registration with this Change Number will be


UNCLASSIFIED


retrieved.

0..1 GivingOfNoticeIdentifier string(50) If provided and the value is not an empty string, then only messages for Registrations that have this value as their Giving Of Notice Identifier will be retrieved.

0..1 IncludePreviouslyRetrievedMessages boolean If provided and the value is true, then messages that have been previously retrieved will be included in the response, as well as any messages that have not previously been retrieved.If provided and the value is false, or a value is not provided, then only messages that have not been previously retrieved will be included in the response.

0..1 MessagesAddedFromDateTime dateTime If provided, then only messages that have been added on or after this date and time will be retrieved.

0..1 MessagesAddedToDateTime dateTime If provided, then only messages that have been added on or before this date and time will be retrieved.

0..1 MessagesAfterMessageId long If provided, then only messages that have a B2GMailboxMessageId that is greater than this value will be retrieved.

0..1 MessagesBeforeMessageId long If provided, then only messages that have a B2GMailboxMessageId that is less than this value will be retrieved.

0..1 OriginalCustomersRequestMessageId string(50) If provided and the value is not an empty string, then only messages that are a result of call to a B2G web service operation where the CustomersRequestMessageId was this value will be retrieved.For example, if several Registrations have been created by a single call to the CreateRegistrations operation of the Collateral Registration Service, and the Address for Service for the registrations is the B2G Account Customer, then the Verifications Statements and Registration Token messages for these registrations can be retrieved using the CustomersRequestMessageId that was provided in the call to the CreateRegistrations operation of the Collateral Registration Service.


UNCLASSIFIED


0..1 RegistrationNumber string(20) If provided and the value is not an empty string, then only messages for the Registration with this Registration Number will be retrieved.

0..1 SecuredPartyGroupNumber string(20) If provided and the value is not an empty string, then only messages for the Secured Party Group with this Secured Party Group Number will be retrieved.Note that this includes messages for Registrations that have a Secured Party Group identified by this Secured Party Group Number.

0..1 NotificationType string(75) If provided, then only messages that are this type of message will be retrieved. The value of NotificationType must be a one of the values defined in the document “B2G Mailbox Notifications”.


UNCLASSIFIED

4.7.2.2.2 RetrieveMessagesResponseMessage

RetrieveMessagesResponseMessageClass

RetrieveMessagesResponseType


B2GMailboxMessageClass

PropertiesB2GMailboxMessageId : longHasPdf : boolMessage : XElementMessageAddedDateTime : DateTimeMessageLastRetrievedDateTime : DateTime?NotificationType : string

RetrieveMessagesResponse

MailboxMessages : List<B2GMailboxMessage>


RetrieveMessagesResponseMessage 1..1 RetrieveMessagesResponse RetrieveMessagesResponseType

RetrieveMessagesResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

0..* MailboxMessages List<B2GMailboxMessage> A list of any B2G Mailbox Messages that match the filter criteria provided in the Request.If this list is empty and filter values were provided, then no B2G Mailbox messages matched the filter values.


UNCLASSIFIED


If this list is empty and no filter values were provided, then either the B2G Mailbox is empty or does not contain any new messages added since this operation was last called.

B2GMailboxMessage 1..1 B2GMailboxMessageId long The unique identifier of the B2G Mailbox Message.

1..1 MessageAddedDateTime dateTime The date and time that this B2G Mailbox Message was added to the B2G Mailbox.

0..1 MessageLastRetrievedDateTime dateTime If this B2G Mailbox Message has been previously retrieved, then this value is the date and time that this B2G Mailbox Message was last retrieved.If this is the first time this B2G Mailbox Message has been retrieved this value will be null.

1..1 NotificationType string(75) The type of message for the B2G Mailbox Message. The value of NotificationType will be one of the values defined in the document “B2G Mailbox Notifications”.

1..1 Message XElement The B2G Mailbox Message content as XML.The structure of the XML depends upon the Notification Type. See the document “B2G Mailbox Notifications” for more information about the XML structure for the different NotificationTypes.

1..1 HasPdf boolean Indicates whether a PDF document is provided for this B2G Mailbox Message. If true, the Retrieve Message PDF operation can be used to retrieve the PDF document.


UNCLASSIFIED


4.7.2.3.1 PpsrB2GMailboxRetrieveMessagesValidationFaultDetail

PpsrB2GMailboxRetrieveMessagesValidationFaultDetail




RetrieveValidationErrors : List<PpsrValidationError>


PpsrB2GMailboxRetrieveMessagesValidationFaultDetail


1..1 RetrieveValidationErrors List<PpsrValidationError> A list of validation errors in the request message.




UNCLASSIFIED


Some business rule violations will be returned as a SOAP Fault where the content of the SOAP fault detail element is PpsrB2GMailboxRetrieveMessagesValidationFaultDetail and the value of the ErrorNumber is 693. The PpsrB2GMailboxRetrieveMessagesValidationFaultDetail allows multiple business rule violations to be reported. In the following table, where the Fault Detail Type in the SOAP Fault column is PpsrB2GMailboxRetrieveMessagesValidationFaultDetail, the Error Number is the value that will provided in the ErrorNumber field of the group of errors.


4.7.2-10 The RetrieveMessagesRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.7.2-20 If a value has been provided for the MessagesAddedFromDateTime element and a value has been provided for the MessagesAddedToDateTime element, then the MessagesAddedFromDateTime element must have a value which is on or before the value in the MessagesAddedToDateTime element.

Fault Detail Type: PpsrB2GMailboxRetrieveMessagesValidationFaultDetailError Number: 38004

4.7.2-30 If a value has been provided for the MessagesAfterMessageId element and a value has been provided for the MessagesBeforeMessageId element, then the MessagesAfterMessageId element must have a value which is less than the value in the MessagesBeforeMessageId element.


4.7.2-40 If a value is provided for NotificationType, then the value must be valid for one of the notification types that can be provided in the B2G Mailbox (see the document “B2G Mailbox Notifications”.



UNCLASSIFIED

4.7.3 Retrieve Message PDF

This operation is used to retrieve a PDF document for a single B2G Mailbox Message from the Account Customer’s B2G Mailbox.

All B2G Mailbox Messages are provided as XML. The XML version of messages is retrieved from the B2G Mailbox using the Retrieve Messages operation. Some B2G Mailbox Messages are also provided as a PDF document in addition to the XML version of the message (e.g. a Verification Statement). When a PDF document is provided for a B2G Mailbox Message, the PDF document is not included in the response to the Retrieve Messages operation. However, the message metadata will contain an indicator that there is a PDF document for the message available. The Retrieve Message PDF operation can then be used to retrieve the PDF document for a specific B2G Mailbox Message based on its unique B2G Mailbox Message Id.



Operation Name: RetrieveMessagePdf

Request: RetrieveMessagePdfRequestMessage

Response: RetrieveMessagePdfResponseMessage


UNCLASSIFIED


4.7.3.2.1 RetrieveMessagePdfRequestMessage

RetrieveMessagePdfRequestMessage


RetrieveMessagePdfRequestType


PropertiesB2GMailboxMessageId : long

RetrieveMessagePdfRequest


RetrieveMessagePdfRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 RetrieveMessagePdfRequest RetrieveMessagePdfRequestType

RetrieveMessagePdfRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 B2GMailboxMessageId long The B2G Mailbox Message Id identifying the B2G Mailbox Message for which to retrieve the PDF version.


UNCLASSIFIED

4.7.3.2.2 RetrieveMessagePdfResponseMessage

RetrieveMessagePdfResponseMessageClass

RetrieveMessagePdfResponseType


B2GMailboxPdfMessageClass

PropertiesB2GMailboxMessageId : longMessagePdf : byte[]PdfFileName : string

RetrieveMessagePdfResponse

B2GMailboxPdfMessage


RetrieveMessagePdfResponseMessage 1..1 RetrieveMessagePdfResponse RetrieveMessagePdfResponseType

RetrieveMessagePdfResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 B2GMailboxPdfMessage B2GMailboxPdfMessage

B2GMailboxPdfMessage 1..1 B2GMailboxMessageId long The unique identifier of the B2G Mailbox Message.

1..1 PdfFileName string(255) The file name of the PDF document. The file name may include space characters.

1..1 MessagePdf byte[] The content of the PDF document as a byte array. The maximum size of this element is theoretically 2GB, but is expected to never exceed 100MB. Most commonly the


UNCLASSIFIED


file size will be between 100KB and 1MB.


4.7.3.3.1 PpsrB2GMailboxRetrieveMessagePdfFaultDetail

PpsrB2GMailboxRetrieveMessagePdfFaultDetail


PropertiesB2GMailboxMessageId : long


PpsrB2GMailboxRetrieveMessagePdfFaultDetail 1..1 PpsrSoapFaultDetail PpsrSoapFaultDetail See section 3.3.1 PpsrSoapFaultDetail.

1..1 B2GMailboxMessageId long The B2G Mailbox Message Id that resulted in the error.



4.7.3-10 The RetrieveMessagePdfRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


UNCLASSIFIED


4.7.3-20 The B2GMailboxMessageId must be for an existing B2G Mailbox Message in the Account Customer’s B2G Mailbox.

Fault Detail Type: PpsrB2GMailboxMessageAccessFaultDetailError Number: 38002

4.7.3-30 The B2G Mailbox Message identified by the B2GMailboxMessageId must have a PDF document available.

Fault Detail Type: PpsrB2GMailboxRetrieveMessagePdfFaultDetailError Number: 38003

4.7.3-40 The message must not have been deleted. Fault Detail Type: PpsrSoapFaultDetailError Number: 1701

4.7.3-50 The message must not have been archived. Fault Detail Type: PpsrSoapFaultDetailError Number: 1702


UNCLASSIFIED

4.7.4 Delete Messages

This operation is used to delete one or more B2G Mailbox Messages from the Account Customer’s B2G Mailbox.

The request message provides a list of the unique B2G Mailbox Message Ids of the messages to be deleted. A limit is placed on the number of messages that will be deleted by each call to the Delete Messages operation. The maximum number of messages that will be deleted in a single call to the Delete Messages operation has initially been set at 100, however this may be reviewed in the future.

A B2G Account Customer should call the DeleteMessages operation to delete messages that have been successfully retrieved by a call to the Retrieve Messages operation.



Operation Name: DeleteMessages

Request: DeleteMessagesRequestMessage

Response: DeleteMessagesResponseMessage


UNCLASSIFIED


4.7.4.2.1 DeleteMessagesRequestMessage

DeleteMessagesRequestMessage


DeleteMessagesRequestType


PropertiesToDeleteMessageIds : List<long>

DeleteMessagesRequest


DeleteMessagesRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 DeleteMessagesRequest DeleteMessagesRequestType

DeleteMessagesRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 ToDeleteMessageIds List<long> A list of the B2G Mailbox Message Ids identifying the B2G Mailbox Messages to delete.


UNCLASSIFIED

4.7.4.2.2 DeleteMessagesResponseMessage

DeleteMessagesResponseMessageClass

DeleteMessagesResponseType


PropertiesDeletedMessageIds : List<long>NotDeletedMessageIds : List<long>

DeleteMessagesResponse


DeleteMessagesResponseMessage

1..1 DeleteMessagesResponse DeleteMessagesResponseType

DeleteMessagesResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 DeletedMessageIds List<long> The list of the B2G Mailbox Message Ids that were provided in the request message and for which the corresponding B2G Mailbox Messages have been deleted.

1..1 NotDeletedMessageIds List<long> The list of B2G Mailbox Message Ids that were provided in the request message but for which no B2G Mailbox Messages have been deleted.If a B2G Mailbox Message Id is provided in the request message but it does not match an existing B2G Mailbox Message in the Account Customer’s B2G Mailbox, the B2G Mailbox Message Id will be returned in the NotDeletedMessageIds.


UNCLASSIFIED



4.7.4-10 The DeleteMessagesRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.7.4-20 The ToDeleteMessageIds list must contain at least one element. Fault Detail Type: PpsrSoapFaultDetailError Number: 38000

4.7.4-30 The ToDeleteMessageIds list must contain no more than 100 elements. Fault Detail Type: PpsrSoapFaultDetailError Number: 38001


UNCLASSIFIED

4.8 Register Operations Service

The Register Operations Service provides an operation to assist in troubleshooting the interface between the Account Customer and the PPSR:

Ping

The Register Operations Service provides an operation to allow the password for a B2G Account Customer Location User to be changed:

Change B2G Password

The Register Operations Service provides an operation to allow B2G Account Customers to test whether the web service stack used in their own systems is configured to provide lax processing of XML messages:

Is Lax Supported


UNCLASSIFIED

4.8.1 Ping

This operation is used to test if the PPSR host is reachable.


Service Name: RegisterOperations

Operation Name: Ping

Request: PingRequestMessage

Response: PingResponseMessage


4.8.1.2.1 PingRequestMessage

PingRequestMessage


PingRequestType


PingRequest


UNCLASSIFIED


PingRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 PingRequest PingRequestType

PingRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

4.8.1.2.2 PingResponseMessage

PingResponseMessageClass

PingResponseType


PropertiesExtension : XElement

PingResponse


PingResponseMessage 1..1 PingResponse PingResponseType

PingResponseType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.


UNCLASSIFIED



4.8.1-10 The PingRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005


UNCLASSIFIED

4.8.2 Change B2G Password

This operation is used to change a B2G Account Customer’s Location User’s password.



Operation Name: ChangeB2GPassword

Request: ChangeB2GPasswordRequestMessage

Response: ChangeB2GPasswordResponseMessage


UNCLASSIFIED


4.8.2.2.1 ChangeB2GPasswordRequestMessage

ChangeB2GPasswordRequestMessage


ChangeB2GPasswordRequestType


PropertiesNewPassword : stringUsername : string

ChangeB2GPasswordRequest


ChangeB2GPasswordRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 ChangeB2GPasswordRequest ChangeB2GPasswordRequestType

ChangeB2GPasswordRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 Username string(40) The username of the B2G Account Customer Location User whose password is to be changed.The username must be the same as the username provided in the WS-Security SOAP header for the request message.

1..1 NewPassword string(50) The new password for the B2G Account Customer Location User.


UNCLASSIFIED

4.8.2.2.2 ChangeB2GPasswordResponseMessage

ChangeB2GPasswordResponseMessageClass

ChangeB2GPasswordResponseType


PropertiesPasswordExpiryDateTime : DateTimePpsrTransactionId : long

ChangeB2GPasswordResponse


ChangeB2GPasswordResponseMessage

1..1 ChangeB2GPasswordResponse ChangeB2GPasswordResponseType

ChangeB2GPasswordResponseType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.


1..1 PasswordExpiryDateTime dateTime The date and time the new password will expire. Another call to the ChangeB2GPassword operation must be made before this time in order to continue using other operations after this time.


UNCLASSIFIED


4.8.2.3.1 PpsrRegisterOperationsChangeB2GPasswordValidationFaultDetail

PpsrRegisterOperationsChangeB2GPasswordValidationFaultDetail


PropertiesUsername : string


PpsrRegisterOperationsChangeB2GPasswordValidationFaultDetail


1..1 Username string(40) The username of the B2G Account Customer Location User whose password is to be changed.



4.8.2-10 The ChangeB2GPasswordRequest element must be provided. Fault Detail Type: PpsrSoapFaultDetailError Number: 50005

4.8.2-20 The value provided for Username must not be an empty string. Fault Detail Type: PpsrRegisterOperationsChangeB2GPasswordValidationFaultDetailError Number: 40000

4.8.2-30 The Username must be the same as the username provided in the WS-Security SOAP header for the request message.

Fault Detail Type: PpsrRegisterOperationsChangeB2GPasswordValidationFaultDetail


UNCLASSIFIED


Error Number: 40001

4.8.2-40 The value provided for NewPassword must not be an empty string. Fault Detail Type: PpsrRegisterOperationsChangeB2GPasswordValidationFaultDetailError Number: 40002

4.8.2-50 The value provided in NewPassword must meet the following rules: not contain space characters have at least a minimum number of 9 characters have no more than a maximum number of 15 characters have at least one upper case character have at least one lower case character have at least one numeric character have at least one special character be different to the previous 8 passwords used for the B2G Account Customer

Location User.

Fault Detail Type: PpsrRegisterOperationsChangeB2GPasswordValidationFaultDetailError Number: 40003

4.8.2-60 The password must not have been changed in the last 12 hours. Fault Detail Type: PpsrRegisterOperationsChangeB2GPasswordValidationFaultDetailError Number: 40023


UNCLASSIFIED

4.8.3 Is Lax Supported

This operation can be used by B2G Account Customers to test whether the web service stack used in their own systems is configured to provide lax processing of XML messages. It is not expected that a B2G Account Customer would use this operation in a production system. It is only expected to be used during software development, which would be using a non-production environment of PPSR, such as the discovery environment.

This operation takes a request message with no parameters. The response message defined in the WSDL for this operation returns a message with a single string value. However, the actual response message returned will contain a second string value. If this operation can be called and the response message processed successfully, the web service stack used in the B2G Account Customers system provides lax processing of XML messages.



Operation Name: IsLaxSupported

Request: IsLaxSupportedRequestMessage

Response: IsLaxSupportedResponseMessage


UNCLASSIFIED


4.8.3.2.1 IsLaxSupportedRequestMessage

IsLaxSupportedRequestMessageClass


IsLaxSupportedRequestMessage

4.8.3.2.2 IsLaxSupportedResponseMessage

IsLaxSupportedResponseMessageClass

IsLaxSupportedResponseTypeClass

PropertiesValue : string

IsLaxSupportedResponse


UNCLASSIFIED


IsLaxSupportedResponseMessage 1..1 IsLaxSupportedResponse IsLaxSupportedResponseType

IsLaxSupportedResponseType 1..1 Value string


UNCLASSIFIED

4.9 Alert Notification Service

The Alert Notification Service provides operations to create and manage Alert Notification Requests.

Alert Notifications operations allow any interested party to request and maintain their requests for alert notification(s) to be sent when any Registration for an organisational grantor that is described by ACN, ARSN or ARBN is created or amended (including discharge). The alert notifications are sent out in a batch early each morning, covering changes from the day before. The service does not provide real time notifications.

Notifications sent to a B2G Account Customer are retrieved through the BG2 Mailbox Service (see section 4.7).

Each Alert Notification Request has the following data items: Alert Notification Request Number (uniquely identifying the request, assigned by the PPSR system) Name (provided by user to assist in identifying the request) B2G Account Customer Number to send notifications to (optional) Email Address to send notifications to (optional) Start time (notifications will start to be sent form this time) End Time (date at which the request expires, and notification will no longer be sent) List of organisations to include in the notification when there is a change to the registrations against that organisation (ACN, ARSN or ARBN number)

Note that the end time controls whether or not an alert notification is sent – it is not the time when the organisations are stopped being monitored. Eg for an alert monitoring ACN 123, with an end time of 30 June 2015 23:59:59, with alerts being processed at 01:00 each morning, a registration against ACN 123 created on 30 June 2015 09:00:00 would not trigger a notification, because the processing time is after the end time of the Alert Notification

There are a number of business rules relating to Alert Notification Requests One of B2G Account Customer Number or Email Address must be provided In order to authorise access (for amendment or retrieval), the Alert Notification Request Number and one of the Email Address or B2G Account Customer Number

must be provided.

There are a number of limits relating to Alert Notification Requests


UNCLASSIFIED

Between 1 and 1000 organisations can be specified Each email address can be the recipient of up to 100 current requests Each B2G Account customer can be the recipient of up to 100 current requests

These limits may be changed from time to time. If the limit is reduced, any existing Alert Notification that violates the limits will still function, but cannot be amended.

Alert notifications requests can be created and managed through both the Web and B2G channels. An alert notification request can be managed through either channel (it is not restricted to the channel that was used to create it).

Operation to create an Alert Notification Request: Create Alert Notification

Operation to modify an Alert Notification Request Amend Alert Notification

Operations to discover information about Alert Notification Requests: Retrieve Alert Notification (information about a single Alert Notification Request) Retrieve Alert Notifications (listing of Alert Notification Requests sent to a specified email or B2G Mailbox))

Operation to stop receiving notifications from an Alert Notification Request: Cancel Alert Notification

An Alert Notification Request can only be accessed while it is current. Once it has passed its End Time (either through the passage of time, or by using the explicit Cancel Alert Notification operation), no operations can be performed on it – the interface will respond as though it does not exist.


UNCLASSIFIED

4.9.1 Common Alert Notification Classes

This section describes classes that are common to more than one Alert Notification Service operation.

4.9.1.1 Alert Notification Request

The AlertNotificationRequest class contains information that describes an Alert Notification Request.

It is provided in the response of the following operations: Create Alert Notification Amend Alert Notification Retrieve Alert Notification


UNCLASSIFIED


AlertNotificationRequest 1..1 AlertNotificationEndTime dateTime When the Alert Notification Request is no longer effective. Alert Notifications will not be sent after this time.

1..1 AlertNotificationRequestNumber string(16) The unique number for this alert notification request that is generated by PPSR when the


UNCLASSIFIED

request is created.

1..1 AlertNotificationStartTime dateTime The start time for this alert notification request that is recorded by PPSR when the request is created.

0..1 B2GAccountCustomerNumber string(20) The B2G Mailbox that the alert notifications are sent to

0..1 EmailAddress string(250) The email address that the alert notifications are sent to.

1..1 Name string(50) The name provided by the user when the Alert Notification Request is created.

1..* Organisations List<GrantorOrganisationWithVerificationStatus>

List of organisations the Alert Notification Request is monitoring

GrantorOrganisationWithVerificationStatus 1..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (ACN, ARBN, ARSN). See section 5.14 OrganisationNumberType for details.ABN is not a valid Organisation Number Type for an Alert Notification Request



IdentifierVerificationStatusType Indicates whether ASIC was able to be contacted to verify the organisation number, and if ASIC was able to be contacted, indicates whether the organisation number was verified as valid by ASIC.See section 5.8 IdentifierVerificationStatusType for details.If the VerificationStatus is “NotVerified” and the B2G Account Customer wishes to convey this information to the end user (e.g. on a screen or printed report), the form of words used in the explanation will need to be in an approved form agreed with the Registrar.The approved form for the conveying of data under this note is the way the data would appear on a search certificate or verification statement including any disclaimers and interpretive notes. This means that either a search certificate or verification statement provided in .pdf format over the B2G channel would suffice for the purposes of this note.

0..1 OrganisationName string(250) If the organisation number has been verified as


UNCLASSIFIED

valid with ASIC, this is the name of the organisation provided by ASI.If the organisation number has not been able to be verified as valid with ASIC, this will be null.


dateTime When the OrganisationNumberVerificationStatus was set.

4.9.2 Create Alert Notification

This operation is used to create a new alert notification request.


Service Name: AlertNotifications

Operation Name: CreateAlertNotificationRequest

Request: CreateAlertNotificationRequestMessage

Response: CreateAlertNotificationResponseMessage


UNCLASSIFIED


4.9.2.2.1 CreateAlertNotificationRequestMessage


UNCLASSIFIED


UNCLASSIFIED


CreateAlertNotificationRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 CreateAlertNotificationRequest CreateAlertNotificationRequestType

CreateAlertNotificationRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 AlertNotificationEndTime dateTime When the Alert Notification Request is no longer effective.



1..1 Name string(50) The name for the Alert Notification Request

1..* AlertGrantorOrganisations List<AlertGrantorOrganisation> The list of organisation identifiers the Alert Notification Request is for.

AlertGrantorOrganisation 1..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (ACN, ARBN, ARSN). See section 5.14 OrganisationNumberType for details.ABN is not a valid Organisation Number Type for an Alert Notification Request


1..1 OrganisationSequenceNumber short A unique sequence number must be provided for each organisation. They should start at 1 for the first organisation and increase by 1 for each subsequent organisation.This number will be used to associate business rule violations (if any).This number is not stored in PPSR as part of the Alert Notification Request record.


UNCLASSIFIED

4.9.2.2.2 CreateAlertNotificationResponseMessage


UNCLASSIFIED


CreateAlertNotificationResponseMessage

1..1 CreateAlertNotificationResponse CreateAlertNotificationResponseType

CreateAlertNotificationResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 AlertNotificationRequest AlertNotificationRequest The created Alert Notification Request. See section 4.9.1.1 Alert Notification Request


4.9.2.3.1 PpsrAlertNotificationCreateValidationFaultDetail


UNCLASSIFIED


PpsrAlertNotificationCreateValidationFaultDetail


0..1 AlertNotificationValidationErrors List<PpsrValidationError> A list of validation errors in the request message relating to the request in general (ie not relating to the AlertGrantorOrganisation records)

0..1 OrganisationGrantorValidationErrors List<PpsrValidationErrorGroup>

A list of validation errors in the request message relating to the AlertGrantorOrganisation records.

PpsrValidationErrorGroup 1..1 SequenceNumber Short The OrganisationSequenceNumber provided in the request that the validation errors relate to.

1..* ValidationErrors List<PpsrValidationError> A list of validation errors in the request message relating to the AlertGrantorOrganisation record with the specified SequenceNumber





4.9.2-10 The EmailAddress must be of a valid format for an email address. Fault Detail Type: PpsrValidationErrorAlertNotificationValidationErrors Error Number: 35001

4.9.2-20 The AlertNotificationEndTime must be after the current date Fault Detail Type: PpsrValidationErrorAlertNotificationValidationErrors Error Number: 35002


UNCLASSIFIED


4.9.2-30 The AlertNotificationEndTime must not be too far in the future (currently configured for one year)

Fault Detail Type: PpsrValidationErrorAlertNotificationValidationErrors Error Number: 35003

4.9.2-40 The number of alert notification requests for this EmailAddress must not exceed the configured limit (currently 100 requests).


4.9.2-50 There must be at least one grantor organisation specified in AlertGrantorOrganisations


4.9.2-60 At least one of EmailAddress or B2GAccountCustomerNumber must be provided


4.9.2-80 The number of alert notification requests for this B2GAccountCustomerNumber must not exceed the configured limit (currently 100 requests).


4.9.2-90 The number of grantor organisations specified in AlertGrantorOrganisations must not exceed the configured limit (currently 1000 organisations).


4.9.2-110 The B2GAccountCustomerNumber must be the same as the AccountCustomerNumber for the username provided in the WS-Security SOAP header for the request message.




4.9.2-130 The name must be at least as long as the configured minimum length (currently 5 characters)



UNCLASSIFIED


4.9.2-140 Each OrganisationSequenceNumber in the AlertGrantorOrganisations list must be unique

Fault Detail Type: PpsrValidationErrorOrganisationGrantorValidationErrorsError Number: 35011

4.9.2-150 Each pair of OrganisationNumberType and OrganisationNumber in the AlertGrantorOrganisations list must be unique

Fault Detail Type: PpsrValidationErrorOrganisationGrantorValidationErrorsError Number: 35012

4.9.2-160 The OrganisationNumberType must be one of (ACN, ARBN, ARSN) Fault Detail Type: PpsrValidationErrorOrganisationGrantorValidationErrorsError Number: 35019

4.9.2-170 The OrganisationNumber must not be an empty string Fault Detail Type: PpsrValidationErrorOrganisationGrantorValidationErrorsError Number: 35021

4.9.2-190 There must be no validation errors from the request. Fault Detail Type: PpsrAlertNotificationCreateValidationFaultDetailError Number: 714

4.9.3 Amend Alert Notification

This operation is used to amend a current alert notification request.



Operation Name: AmendAlertNotificationRequest


UNCLASSIFIED

Request: AmendAlertNotificationRequestMessage

Response: AmendAlertNotificationResponseMessage


4.9.3.2.1 AmendAlertNotificationRequestMessage


UNCLASSIFIED


AmendAlertNotificationRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 AmendAlertNotificationRequest AmendAlertNotificationRequestType

AmendAlertNotificationRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

0..1 AlertNotificationEndTime dateTime If provided, the new time that the Alert Notification Request will no longer be effective.

1..1 AlertNotificationRequestNumber String(16) The unique number for the alert notification request that is to be amended.

0..1 B2GAccountCustomerNumber string(20) The existing B2G Mailbox for the AlertNotificationRequestNumber

0..1 EmailAddress string(250) The existing email address for the AlertNotificationRequestNumber.

0..1 Name string(50) If provided, the new name for the Alert Notification Request

0..1 NewB2GAccountCustomerNumber string(20) If provided, the new B2G Mailbox that the alert notifications are sent to.If set to an empty string, the current B2GAccountCustomerNumber will be removed.

0..1 NewEmailAddress string(250) If provided, the new email address that the alert notifications are sent to.If set to an empty string, the EmailAddress will be removed.

1..* AddedGrantorOrganisations List<AlertGrantorOrganisation> The list of organisation identifiers to add to the Alert Notification Request.

1..* RemovedGrantorOrganisations List<AlertGrantorOrganisation> The list of existing organisation identifiers to remove from the Alert Notification Request

1..* ReverifyGrantorOrganisations List<AlertGrantorOrganisation> The list of existing organisation identifiers to verify the current organisation name for.

AlertGrantorOrganisation 1..1 OrganisationNumberType OrganisationNumberType The type of the number used to identify the organisation (ACN, ARBN, ARSN). See section 5.14 OrganisationNumberType for details.ABN is not a valid Organisation Number Type for an Alert Notification Request



UNCLASSIFIED


1..1 OrganisationSequenceNumber short A unique sequence number must be provided for each organisation. They should start at 1 for the first organisation and increase by 1 for each subsequent organisation.This number will be used to associate business rule violations (if any).This number is not stored in PPSR as part of the Alert Notification Request record.


UNCLASSIFIED

4.9.3.2.2 AmendAlertNotificationResponseMessage


UNCLASSIFIED


AmendAlertNotificationResponseMessage

1..1 AmendAlertNotificationResponse AmendAlertNotificationResponseType

AmendAlertNotificationResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 AlertNotificationRequest AlertNotificationRequest The created Alert Notification Request. See section 4.9.1.1 Alert Notification Request


4.9.3.3.1 PpsrAlertNotificationAmendValidationFaultDetail


UNCLASSIFIED


PpsrAlertNotificationAmendValidationFaultDetail



0..1 AddedOrganisationGrantorValidationErrors

List<PpsrValidationErrorGroup>

A list of validation errors in the request message relating to the AddedGrantorOrganisations records.

0..1 RemovedOrganisationGrantorValidationErrors


A list of validation errors in the request message relating to the RemovedGrantorOrganisations records.

0..1 ReverifyOrganisationGrantorValidationErrors


A list of validation errors in the request message relating to the ReverifyGrantorOrganisations records.

PpsrValidationErrorGroup 1..1 SequenceNumber Short The OrganisationSequenceNumber provided in the request that the validation errors relate to.

1..* ValidationErrors List<PpsrValidationError> A list of validation errors in the request message relating to the AlertGrantorOrganisation record with the specified SequenceNumber





4.9.3-10 The AlertNotificationRequestNumber must be for a current alert notification request.



UNCLASSIFIED


4.9.3-20 The NewEmailAddress must be of a valid format for an email address. Fault Detail Type: PpsrValidationErrorAlertNotificationValidationErrors Error Number: 35001

4.9.3-30 The AlertNotificationEndTime must be after the current date Fault Detail Type: PpsrValidationErrorAlertNotificationValidationErrors Error Number: 35002

4.9.3-40 The AlertNotificationEndTime must not be too far in the future (currently configured for one year)


4.9.3-50 The number of alert notification requests for the NewEmailAddress must not exceed the configured limit (currently 100 requests).


4.9.3-60 There must be at least one grantor organisation specified for the alert notification request after applying the AddedGrantorOrganisations and RemovedGrantorOrganisations


4.9.3-70 At least one of EmailAddress or B2GAccountCustomerNumber must be left on the alert request notification after applying the NewB2GAccountCustomerNumber and NewEmailAddress


4.9.3-80 The number of alert notification requests for the NewB2GAccountCustomerNumber must not exceed the configured limit (currently 100 requests).


4.9.3-90 The number of grantor organisation specified after applying the AddedGrantorOrganisations and RemovedGrantorOrganisations must not exceed the configured limit (currently 1000 organisations).


4.9.3-100 The NewB2GAccountCustomerNumber must be the same as the AccountCustomerNumber for the username provided in the WS-Security SOAP header for the request message..



UNCLASSIFIED


4.9.3-110 The NewB2GAccountCustomerNumber must be for an existing B2G account customer


4.9.3-120 The name must be at least as long as the configured minimum length (currently 5 characters)


4.9.3-130 The AlertNotificationRequestNumber must not be an empty string Fault Detail Type: PpsrValidationErrorAlertNotificationValidationErrors Error Number: 35024

4.9.3-140 The EmailAddress must be the same as recorded for the AlertNotificationRequestNumber


4.9.3-150 The B2GAccountCustomerNumber must be the same as recorded for the AlertNotificationRequestNumber


4.9.3-160 Each OrganisationSequenceNumber must be unique within each list: AddedGrantorOrganisations RemovedGrantorOrganisations ReverifyGrantorOrganisations

Fault Detail Type: PpsrValidationErrorAddedOrganisationGrantorValidationErrorsRemovedOrganisationGrantorValidationErrorsReverifyOrganisationGrantorValidationErrorsError Number: 35011

4.9.3-170 Each pair of OrganisationNumberType and OrganisationNumber in the AlertGrantorOrganisations list must be unique within each list: AddedGrantorOrganisations RemovedGrantorOrganisations ReverifyGrantorOrganisations

Fault Detail Type: PpsrValidationErrorAddedOrganisationGrantorValidationErrorsRemovedOrganisationGrantorValidationErrorsReverifyOrganisationGrantorValidationErrorsError Number: 35012


UNCLASSIFIED


4.9.3-180 Each pair of OrganisationNumberType and OrganisationNumber in the AlertGrantorOrganisations list must exist in the alert notification request specified by AlertNotificationRequestNumber: RemovedGrantorOrganisations ReverifyGrantorOrganisations

Fault Detail Type: PpsrValidationErrorRemovedOrganisationGrantorValidationErrorsReverifyOrganisationGrantorValidationErrorsError Number: 35013

4.9.3-190 The OrganisationNumberType must be one of (ACN, ARBN, ARSN) Fault Detail Type: PpsrValidationErrorAddedOrganisationGrantorValidationErrorsRemovedOrganisationGrantorValidationErrorsReverifyOrganisationGrantorValidationErrorsError Number: 35019

4.9.3-200 The OrganisationNumber must not be an empty string Fault Detail Type: PpsrValidationErrorAddedOrganisationGrantorValidationErrorsRemovedOrganisationGrantorValidationErrorsReverifyOrganisationGrantorValidationErrorsError Number: 35021

4.9.3-220 Each pair of OrganisationNumberType and OrganisationNumber in the AddedGrantorOrganisations list must not must already exist in the alert notification request specified by AlertNotificationRequestNumber

Fault Detail Type: PpsrValidationErrorAddedOrganisationGrantorValidationErrorsError Number: 35023

4.9.3-230 Only one of EmailAddress or B2GAccountCustomerNumber may be provided Fault Detail Type: PpsrValidationErrorAlertNotificationValidationErrors Error Number: 35029

4.9.3-240 There must be no validation errors from the request. Fault Detail Type: PpsrAlertNotificationAmendValidationFaultDetailError Number: 725


UNCLASSIFIED

4.9.4 Cancel Alert Notification

This operation is used to cancel a current alert notification request.



Operation Name: CancelAlertNotificationRequest

Request: CancelAlertNotificationRequestMessage

Response: CancelAlertNotificationResponseMessage


UNCLASSIFIED


4.9.4.2.1 CancelAlertNotificationRequestMessage


CancelAlertNotificationRequestMessage 1..1 BaseRequestMessage BaseRequestMessage See section 3.9 Common Message Fields.

1..1 CancelAlertNotificationRequest CancelAlertNotificationRequestType

CancelAlertNotificationRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 AlertNotificationRequestNumber String(16) The unique number for the alert notification request that is to be cancelled.

0..1 B2GAccountCustomerNumber string(20) The B2G Mailbox that matches the alert notification request identified by AlertNotificationRequestNumber


UNCLASSIFIED


0..1 EmailAddress string(250) The email address that matches the alert notification request identified by AlertNotificationRequestNumber.

4.9.4.2.2 CancelAlertNotificationResponseMessage


CancelAlertNotificationResponseMessage

1..1 CancelAlertNotificationResponse CancelAlertNotificationResponseType

CancelAlertNotificationResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.


UNCLASSIFIED


1..1 AlertNotificationRequestNumber String(16) Echo of the request AlertNotificationRequestNumber

0..1 B2GAccountCustomerNumber string(20) Echo of the request B2GAccountCustomerNumber

0..1 EmailAddress string(250) Echo of the request EmailAddress


4.9.4.3.1 PpsrAlertNotificationRetrieveAlertNotificationValidationFaultDetail


UNCLASSIFIED


PpsrAlertNotificationRetrieveAlertNotificationValidationFaultDetail















UNCLASSIFIED





4.9.4-70 There must be no validation errors from the request. Fault Detail Type: PpsrAlertNotificationRetreiveAlertNotificationValidationFaultDetailError Number: 728

4.9.5 Retrieve Alert Notification

This operation is used to retrieve details of a current alert notification request.



Operation Name: RetrieveAlertNotificationRequest

Request: RetrieveAlertNotificationRequestMessage

Response: RetrieveAlertNotificationResponseMessage


UNCLASSIFIED


4.9.5.2.1 RetrieveAlertNotificationRequestMessage


RetrieveAlertNotificationRequestMessage


1..1 RetrieveAlertNotificationRequest RetrieveAlertNotificationRequestType

RetrieveAlertNotificationRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.

1..1 AlertNotificationRequestNumber String(16) The unique number for the alert notification request that is to be cancelled.

0..1 B2GAccountCustomerNumber string(20) The B2G Mailbox that matches the alert notification request identified by


UNCLASSIFIED


AlertNotificationRequestNumber

0..1 EmailAddress string(250) The email address that matches the alert notification request identified by AlertNotificationRequestNumber.


UNCLASSIFIED

4.9.5.2.2 RetrieveAlertNotificationResponseMessage


UNCLASSIFIED


RetrieveAlertNotificationResponseMessage

1..1 RetrieveAlertNotificationResponse RetrieveAlertNotificationResponseType

RetrieveAlertNotificationResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

1..1 AlertNotificationRequest AlertNotificationRequest The retrieved Alert Notification Request. See section 4.9.1.1 Alert Notification Request




UNCLASSIFIED

















UNCLASSIFIED






4.9.6 Retrieve Alert Notifications

This operation is used to request a notification to be sent listing all the current alert notifications for an email address or a B2G account customer mailbox.



Operation Name: RetrieveAlertNotificationsRequest

Request: RetrieveAlertNotificationsRequestMessage

Response: RetrieveAlertNotificationsResponseMessage


UNCLASSIFIED


4.9.6.2.1 RetrieveAlertNotificationsRequestMessage


RetrieveAlertNotificationsRequestMessage


1..1 RetrieveAlertNotificationsRequest RetrieveAlertNotificationsRequestType

RetrieveAlertNotificationsRequestType 1..1 CommonRequestType CommonRequestType See section 3.9 Common Message Fields.




UNCLASSIFIED

4.9.6.2.2 RetrieveAlertNotificationsResponseMessage


RetrieveAlertNotificationsResponseMessage

1..1 RetrieveAlertNotificationsResponse RetrieveAlertNotificationsResponseType

RetrieveAlertNotificationsResponseType 1..1 CommonResponseType CommonResponseType See section 3.9 Common Message Fields.

0..1 B2GAccountCustomerNumber string(20) The B2G Mailbox that was provide in the request.

0..1 EmailAddress string(250) The email address that was provide in the request.


UNCLASSIFIED










UNCLASSIFIED



4.9.6-10 The EmailAddress must be of a valid format for an email address. Fault Detail Type: PpsrValidationErrorAlertNotificationValidationErrors Error Number: 35001

4.9.6-20 At least one of EmailAddress or B2GAccountCustomerNumber must be provided





4.9.6-100 If the EmailAddress is provided, there must be at least one active alert notification for that EmailAddress


4.9.6-110 If the B2GAccountCustomerNumber is provided, there must be at least one active alert notification for that B2GAccountCustomerNumber





UNCLASSIFIED




UNCLASSIFIED

5 Reference TypesThis section lists the reference types and their values.

5.1 ChangeType

The types of changes to a Registration that will generate a Change Number.

Value Description

Unsupported Indicates that the Registration was changed for a reason not supported by the version of the B2G Interface being used.

Create Indicates the Registration was changed because it was created.

Amend Indicates the Registration was changed because it was amended.

Discharge Indicates the Registration was changed because it was discharged.

Remove Indicates the Registration was changed because it was removed.

Reinstate Indicates the Registration was changed because it was reinstated.

AddressForServiceChange Indicates the Address For Service of the Registration was changed.

Transfer Indicates the Registration was changed because it was transferred to a different Secured Party Group.


UNCLASSIFIED

5.2 CollateralClassFilterCriteriaType

The collateral classes that can be used when filtering Search By Grantor search result.

Value Description

Unsupported Indicates that the collateral class is not supported by the version of the B2G Interface being used.

Unknown Unknown

MotorVehicle Motor Vehicle

Watercraft Watercraft

AircraftEngine Aircraft / Aircraft engine

AircraftFrame Aircraft / Airframe

Helicopter Aircraft / Helicopter

SmallAircraft Aircraft / Small aircraft

Agriculture Agriculture

Crops Agriculture / Crops

Livestock Agriculture / Livestock

OtherGoods Other goods

FinancialProperty Financial property

ChattelPaper Financial property / Chattel paper

Currency Financial property / Currency

DocumentOfTitle Financial property / Document of title

IntermediatedSecurity Financial property / Intermediated security

InvestmentInstrument Financial property / Investment instrument

NegotiableInstrument Financial property / Negotiable instrument


UNCLASSIFIED

Value Description

Intangible Property Intangible property

Account Intangible property / Account

GeneralIntangible Intangible property / General intangible

Intellectual Property Intangible property / Intellectual property

CircuitLayout Intangible property / Intellectual property / Circuit layout

Copyright Intangible property / Intellectual property / Copyright

Patent Intangible property / Intellectual property / Patent

Design Intangible property / Intellectual property / Design

TradeMark Intangible property / Intellectual property / Trade mark

PlantBreedersRight Intangible Property / Intellectual property / Plant breeder’s right

AllPapNoExcept All present and after-acquired property

AllPapWithExcept All present and after-acquired property except …

5.3 CollateralClassSearchCriteriaType

The collateral classes that can be used when performing Search By Grantor.

Value Description


MotorVehicle Motor Vehicle




UNCLASSIFIED

Value Description

AircraftFrame Aircraft / Airframe







FinancialProperty Financial property







Intangible Property Intangible property



Intellectual Property Intangible property / Intellectual property







UNCLASSIFIED

Value Description

PlantBreedersRight Intangible Property / Intellectual property / Plant breeder’s right



5.4 CollateralClassType

The collateral classes for which registrations can exist in PPSR. Each item of personal property registered as collateral is described by the specific class of personal property to which the item belongs.

Value Description


Unknown Unknown collateral class. This will only occur on migrated registrations.

MotorVehicle Motor vehicle



Airframe Aircraft / Airframe







UNCLASSIFIED

Value Description










IntellectualProperty Intangible property / Intellectual property






PlantBreedersRight Intangible property / Intellectual property / Plant breeder’s right



5.5 CollateralType


UNCLASSIFIED

Value Description

Unsupported Indicates that the collateral type is not supported by the version of the B2G Interface being used.

Unknown Indicates the collateral type is unknown. This will only occur on migrated registrations.

Consumer Indicates consumer property.

Commercial Indicates commercial property.

5.6 ExtendedBooleanType

Allows for explicitly indicating an Unknown value for Boolean data types where the data is relevant for a registration, separately from using Null for instances where the data is not relevant. This is used to support data migrated from existing registers that do not store data that is required by PPSR.

Value Description

Unsupported Indicates that the value is not supported by the version of the B2G Interface being used.

Unknown Used when the value is Unknown. This will only occur on migrated registrations.

True Used when the value is True.

False Used when the value is False.


UNCLASSIFIED

5.7 GrantorType

The type of grantor that has granted the security interest in the collateral in PPSR. Each grantor will be either an organisation or an individual.

Value Description

Unsupported Indicates that the grantor type is not supported by the version of the B2G Interface being used.

Individual Indicates that a grantor is an individual.

Organisation Indicates that a grantor is an organisation.

5.8 IdentifierVerificationStatusType

When a Secured Party in a Secured Party Group is an organisation that is identified in PPSR by its organisation number (ACN, ARSN, ARBN or ABN), PPSR will attempt to verify the value of the organisation number with either ASIC (for ACN, ARSN, ARBN) or ABR (for ABN). The IdentifierVerificationStatusType is used to indicate the verification status of the organisation number with ASIC or ABR.

Value Description

Unsupported Indicates that the identifier verification status is not supported by the version of the B2G Interface being used.

Found The identifier has been verified with the verification register, and the identifier exists in the verification register.

NotFound The identifier has been verified with the verification register, but the identifier does not exist in the verification register.


UNCLASSIFIED

Value Description

NotVerified The identifier has not yet been successfully verified (either as existing or not existing) with the verification register.

NotPerformed The identifier will not be verified with the verification register. This is used for migrated registrations.

5.9 NevdisVehicleIdentifierType

The types of vehicle identifiers used to match vehicle with NEVDIS.

Value Description

Unsupported Indicates that the vehicle identifier type is not supported by the version of the B2G Interface being used.

VIN Vehicle Identification Number

ChassisNumber Chassis Number

5.10 NewRegistrationCollateralClassType

The collateral classes for which new registrations can be made in PPSR. Each item of personal property registered as collateral is described by the specific class of personal property to which the item belongs.

Note: The PPS Regulations define the collateral classes that can be used to describe collateral. The Regulations also allow for some collateral classes to be further described and the concept of “subclass” is used in PPSR. For example, the class of Agriculture can be further described as


UNCLASSIFIED

being either of the subclass Crops or the subclass Livestock. Further details of the use of subclasses and the class hierarchy are provided in sections 2.5, 3.1 and 4.1 of the document “PPSR - 6.4.3.1 - Describing Collateral”. In the B2G Interface Specification, the use of the term “class” is used to refer to either a class as defined in the Regulations or a subclass as defined in the document “PPSR - 6.4.3.1 - Describing Collateral”.

Value Description

MotorVehicle Motor vehicle



Airframe Aircraft / Airframe
















UNCLASSIFIED

Value Description

Intellectual Property Intangible property / Intellectual property(cannot be used for Consumer registrations)






PlantBreedersRight Intangible property / Intellectual property / Plant breeder’s right



5.11 NewRegistrationCollateralType

The type of property for which new registrations can be made in PPSR. Registrations are either for commercial property or consumer property.

Value Description

Consumer Indicates consumer property.

Commercial Indicates commercial property.

5.12 NewRegistrationSerialNumberType

The types of serial numbers that can be used when creating a registration in PPSR.


UNCLASSIFIED

The types of serial numbers are:

For Motor Vehicles:

Vehicle Identification Number (VIN)

Chassis Number

Motor Vehicle Manufacturer’s Number

For Watercraft:

Hull Identification Number (HIN) - for boats

Official Number - for ships

For Aircraft:

Aircraft Engine Manufacturer’s Number

Airframe Manufacturer’s Number

Helicopter Manufacturer’s Number

Aircraft Nationality Code and Registration Mark

For Intellectual Property:

Patent Number, Patent Application Number or Patent Cooperation Treaty (PCT) Number

Trade Mark Number or Trade Mark Application Number

Design Number or Design Application Number

Plant Breeder’s Right Number or Plant Breeder’s Right Application Number

Value Description



UNCLASSIFIED

Value Description


MotorVehicleManufacturersNumber Motor Vehicle Manufacturer’s Number

HIN HIN

OfficialNumber Official Number

AircraftEngineManufacturersNumber Aircraft Engine Manufacturer’s Number

AirframeManufacturersNumber Airframe Manufacturer’s Number

HelicopterManufacturersNumber Helicopter Manufacturer’s Number

AircraftNationalityCodeAndRegistrationMark


PatentNumber Patent Number / Patent Application Number / Patent Cooperation Treaty Number

TradeMarkNumber Trade Mark Number / Trade Mark Application Number

DesignNumber Design Number / Design Application Number

PlantBreedersRightNumber Plant Breeder’s Right Number / Plant Breeder’s Right Application Number


UNCLASSIFIED

5.13 OrdinalSearchResultType

The type of results that can be returned from an Ordinal Search.

Value Description

Unsupported Indicates that the ordinal search result type is not supported by the version of the B2G Interface being used.

RegistrationEventOneBeforeTwo Registration Event One took place before Registration Event Two.

RegistrationEventOneAfterTwo Registration Event One took place after Registration Event Two.

RegistrationEventOneSameAsTwo Registration Event One took place at the same time as Registration Event Two.

5.14 OrganisationNumberType

Grantors and secured parties for registrations are either an organisation or an individual. Grantors and secured parties that are organisations can be identified in various ways. PPSR uses identifying numbers issued by the Australian Securities and Investments Commission (ASIC) and the Australian Business Register (ABR). When a grantor or secured party has an identifying number issued by one of these agencies, the number and the type of number are recorded.

The numbers issued by ASIC are:

Australian Company Number (ACN)

Australian Registered Body Number (ARBN)

Australian Registered Scheme Number (ARSN)


UNCLASSIFIED

The numbers issued by ABR are:

Australian Business Number (ABN)

Value Description

Unsupported Indicates that the organisation number type is not supported by the version of the B2G Interface being used.

ACN Australian Company Number.

ARBN Australian Registered Body Number.

ARSN Australian Registered Scheme Number.

ABN Australian Business Number.

5.15 RegistrationEventType

For Ordinal Search, this is used to indicate the type of registration events to be compared.

Value Description

Unsupported Indicates that the registration event type is not supported by the version of the B2G Interface being used.

StartTime Indicates that the Registration Start Time will be used for comparison in an Ordinal Search.

EndTime Indicates that the Registration End Time will be used for comparison in an Ordinal Search.


UNCLASSIFIED

Value Description

ChangeNumber Indicates that the Change Time of a specified Change Number for a Registration will be used for comparison in an Ordinal Search.

5.16 ReportFormatType

The format types for report output.

Value Description

Unsupported Indicates that the report format type is not supported by the version of the B2G Interface being used.

Xml The report output will be an XML file.

Pdf The report output will be a PDF file.

Csv The report output will be a CSV file.

5.17 ReportRequestedChannelType

The channels that can be used to request reports.

Value Description

Unsupported Indicates that the channel type is not supported by the version of the B2G Interface being used.

B2G The report was requested through the B2G Channel.


UNCLASSIFIED

Value Description

Web The report was requested through the Web Channel.

ContactCentre The report was requested by a Contact Centre user on behalf of the Account Customer.

5.18 ReportStatusType

The status or processing for a report.

Value Description

Unsupported Indicates that the report status type is not supported by the version of the B2G Interface being used.

ProcessingPending The report has been requested but has not yet been produced.

ProcessingCompleted The report has been produced and the output is available to be retrieved.

5.19 SearchSelectionFlagType

The types of search selection that can be made for some attributes of Registrations that can be specified as search criteria.


UNCLASSIFIED

Value Description

Unsupported Indicates that the search selection type is not supported by the version of the B2G Interface being used.

Include Only Registrations with the specific attribute will be included in the search result.

Exclude Registrations with the specific attribute will be excluded from the search result.

Either Registrations will be included in the search result regardless of the value of the specific attribute.

5.20 SearchType

The types of searches that can be performed.

Value Description

Unsupported Indicates that the search type is not supported by the version of the B2G Interface being used.

SearchByRegistrationNumber Search By Registration Number

SearchBySerialNumber Search By Serial Number

SearchByGrantor Search By Grantor

SearchByGrantorAndEventDateRange Search By Grantor And Event Date Range

OrdinalSearch Ordinal Search


UNCLASSIFIED

5.21 SecuredPartyType

The type of the secured party in PPSR. Each secured party will be either an organisation or an individual.

Value Description

Unsupported Indicates that the secured party type is not supported by the version of the B2G Interface being used.

Individual Indicates that a secured party is an individual.

Organisation Indicates that a secured party is an organisation.

5.22 SerialNumberSearchCriteriaType

The types of serial numbers that can be used when performing Search By Serial Number.


For Motor Vehicles:


Chassis Number


For Watercraft:



For Aircraft:


UNCLASSIFIED










Value Description

Unsupported Indicates that the serial number type is not supported by the version of the B2G Interface being used.




HIN HIN



AirframeManufacturersNumber Airframe Manufacturers Number



Aircraft Nationality Code And Registration Mark


UNCLASSIFIED

Value Description





5.23 SerialNumberType

The types of serial numbers that can be used with each collateral class that can have a serial number.


For Motor Vehicles:


Chassis Number


Unknown Motor Vehicle Identifier

For Watercraft:



For Aircraft:


UNCLASSIFIED










Value Description

Unsupported Indicates that the serial number type is not supported by the version of the B2G Interface being used.




UnknownMotorVehicleIdentifier Unknown Motor Vehicle Identifier

HIN HIN



AirframeManufacturersNumber Airframe Manufacturer’s Number



UNCLASSIFIED

Value Description







5.24 SortOrderType

Indicates the order in which Registrations are included in the search result for a Search By Grantor.

Value Description

Unsupported Indicates that the sort order type is not supported by the version of the B2G Interface being used.

Ascending Registrations are included in ascending order of Registration Number.

Descending Registrations are included in descending order of Registration Number.


UNCLASSIFIED

6 Allowable Characters for Grantor NamesThe values entered into PPSR for Grantor names (Family Name and Given Names for Individual Grantors, and Organisation Name for Organisation Grantors), must only contain the following 7-bit ASCII characters:

Decimal Code

Symbol Description

32 Space

33 ! Exclamation mark

34 “ Double quotes (or speech marks)

35 # Number

36 $ Dollar

37 % Percent

38 & Ampersand

39 ‘ Single quote

40 ( Open parenthesis (or open bracket)

41 ) Close parenthesis (or close bracket)

42 * Asterisk

43 + Plus

44 , Comma

45 - Hyphen

46 . Period, dot or full stop

47 / Slash or divide

48 0 Zero

49 1 One


UNCLASSIFIED

Decimal Code

Symbol Description

50 2 Two

51 3 Three

52 4 Four

53 5 Five

54 6 Six

55 7 Seven

56 8 Eight

57 9 Nine

58 : Colon

59 ; Semicolon

60 < Less than (or open angled bracket)

61 = Equals

62 > Greater than (or close angled bracket)

63 ? Question mark

64 @ At symbol

65 A Uppercase A

66 B Uppercase B

67 C Uppercase C

68 D Uppercase D

69 E Uppercase E

70 F Uppercase F

71 G Uppercase G

72 H Uppercase H


UNCLASSIFIED

Decimal Code

Symbol Description

73 I Uppercase I

74 J Uppercase J

75 K Uppercase K

76 L Uppercase L

77 M Uppercase M

78 N Uppercase N

79 O Uppercase O

80 P Uppercase P

81 Q Uppercase Q

82 R Uppercase R

83 S Uppercase S

84 T Uppercase T

85 U Uppercase U

86 V Uppercase V

87 W Uppercase W

88 X Uppercase X

89 Y Uppercase Y

90 Z Uppercase Z

91 [ Opening bracket

92 \ Backslash

93 ] Closing bracket

94 ^ Caret - circumflex

95 _ Underscore


UNCLASSIFIED

Decimal Code

Symbol Description

96 ` Grave accent(this is commonly misused as a an apostrophe)

97 a Lowercase a

98 b Lowercase b

99 c Lowercase c

100 d Lowercase d

101 e Lowercase e

102 f Lowercase f

103 g Lowercase g

104 h Lowercase h

105 i Lowercase i

106 j Lowercase j

107 k Lowercase k

108 l Lowercase l

109 m Lowercase m

110 n Lowercase n

111 o Lowercase o

112 p Lowercase p

113 q Lowercase q

114 r Lowercase r

115 s Lowercase s

116 t Lowercase t

117 u Lowercase u


UNCLASSIFIED

Decimal Code

Symbol Description

118 v Lowercase v

119 w Lowercase w

120 x Lowercase x

121 y Lowercase y

122 z Lowercase z

123 { Opening brace

124 | Vertical bar

125 } Closing brace

126 ~ Tilde
