• Web services technology

    IdentifierSearch service is based on open standards known collectively as web services, which includes:

    • The Simple Object Access Protocol (SOAP)
    • Web Services Definition Language (WSDL)
    • Extensible Markup Language (XML), XML Schema Definition language (XSD) with the data formatted as XML.

    Security

    The IdentifierSearch web service is hosted over a secure connection. It uses the HTTP Basic Authentication method over HTTPS and contains a SOAP formatted XML message carrying a XML payload.

    BRR_1090

    SOAP

    The operation is available as either SOAPv1.1 or as SOAPv1.2. The ABR currently supports both operations, but we recommend using the latest version.

    The request message in the SOAP envelope is provided as an Identifier‍Search element.

    Authentication

    The server will first validate the identity of an incoming request message. The authentication is used by the ABR to determine the validity of the incoming request. The request will be refused if the identity check fails.

    The IdentifierSearch authentication mode requires a username and password in the HTTP GET request.

    About the request parameters

    Request Parameters

    IdentifierType

    The type of identifier in the IdentifierValue.

    Valid values are “ABN” and ACN/ ARBN”.

    When searching for "ACN or ARBN" you must add the "ACN/ARBN parameters in the <abr:IdentifierValue>ACN/ARBN<IdentifierValue>.

    Data type: s:String

    Occurrences: Zero or one

    IdentifierValue

    An ABN or ACN/ARBN eg 12345678955.

    Data Type: s:String

    Occurrences: Zero or one

    Date

    The date of identifier records over which the search should be made.

    Data type: dateTime

    Occurrences: Exactly one

    History

    Specifies whether the search result should only include data elements with an effective "To date" set. Valid values are “Y/N”.

    • If “Y” is specified, the historicalABNRecord element will contain the search result.
    • If “N” is specified, the currentABNRecord will contain the search result.

    Data type: simpleType EYesNo (Restriction of s:String)

    Occurrences: Exactly one

    • Last modified: 16 Jun 2016QC 1090