13
Interface Functional Specification ManageInventory Industry Interface NBN CO OSS PROGRAM This document forms part of NBN Co's Wholesale Broadband Agreement, which is a Standard Form of Access Agreement for the purposes of Part XIC of the Competition and Consumer Act 2010.

Interface Functional Specification ManageInventory

  • Upload
    others

  • View
    11

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Interface Functional Specification ManageInventory

Interface Functional Specification ManageInventoryIndustry InterfaceNBN CO OSS PROGRAM

This document forms part of NBN Co's Wholesale Broadband Agreement, which is a Standard Form of Access Agreement for the purposes of Part XIC of the Competition and Consumer Act 2010.

Page 2: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 2 of 13

Copyright

This document is subject to copyright and must not be used except as permitted below or under the Copyright Act 1968 (Cth). You must not reproduce or publish this document in whole or in part for commercial gain without the prior written consent of NBN Co. You may reproduce and publish this document in whole or in part for educational or non-commercial purposes as approved by NBN Co in writing.

Copyright © 2012 NBN Co Limited. All rights reserved.

Disclaimer

This document predominantly sets out technical information in relation to NBN Co's B2B Gateway. It also sets out some of terms and conditions that apply in relation to NBN Co's B2B Gateway. Other terms and conditions in relation to NBN Co's B2B Gateway are set out elsewhere in the Wholesale Broadband Agreement between NBN Co and Access Seeker, including in the Product Description for the NBN Co Platform Interfacing Service and the NBN Co Operations Manual. Access Seeker is advised to familiarise itself with all of the terms and conditions that apply in relation to NBN Co's B2B Gateway, not just those terms and conditions set out in this document. Where NBN Co has provided recommendations or examples in this document, Access Seeker must not assume that NBN Co's networks, platforms or systems will support Access Seeker's implementation of such recommendations or examples. Information that is identified as important in this document is brought to Access Seeker's attention for practical purposes of understanding all information in context and should not necessary be accorded more weight than other information for implementation purposes.

Environment

NBN Co asks that you consider the environment before printing this document.

Page 3: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 3 of 13

Document Control

Title Interface Functional Specification: ManageInventory

Revision HistoryVersion Date Details

V1.5 2012/04/06 First Release

V1.6 2012/08/29 Updated under Industry Interface 2.1.Updated touchpoint descriptions to:- clarify the use of DescribedBy and SpecifiedBy name/value pairs.- clarify the sequence of the specification blocks within a message.Updated sample messages to:- correct Transient IDs for NFAS/NWAS, including updates to "Connected to UNI" values.- correct Port ID, SVLAN ID and CVLAN ID behaviour in responses.

V2.0 2012/05/09 First draft for Industry Interface 3.0.Updated sample messages with Service Restoration SLA, Multicast and 2 UNI-Vs.

V2.1 2012/05/18 Updated sample messages with corrections.

V2.2 2012/06/21 Updated sample messages to correct NFAS/NWAS 'Connected to UNI' and 'Connected to AVC' values.

V2.3 2012/07/05 Updated sample messages to correct CVC structure.Updated touchpoint descriptions to:- clarify the use of DescribedBy and SpecifiedBy name/value pairs, and- clarify the sequence of the specification blocks within a message.

V2.4 2012/09/28 Updated sample messages to:- add Multicast sample messages.- add Second UNI-V sample messages.- add Service Restoration SLA sample messages.- removed VLAN Mode from submit order sample messages.- updated NTD Type and Location from External/Outdoor to Internal/Indoor.

Related DocumentsDocument Title Version

ManageInventory Interface Technical Specification V2.4

Interface Common Objects Specification V1.6

Compare: Insert�
text
"Updated touchpoint"
Compare: Insert�
text
"Updated under Industry Interface 2.1."
Compare: Insert�
text
"V1.6"
Compare: Insert�
text
"to:"
Compare: Insert�
text
"- clarify the use"
Compare: Replace�
text
[Old text]: "changes can be found" [New text]: "DescribedBy and SpecifiedBy name/value"
Compare: Insert�
text
"- correct Port ID, SVLAN ID and CVLAN ID behaviour"
Compare: Insert�
text
""Connected to UNI" values."
Compare: Insert�
text
"- correct Transient IDs for NFAS/NWAS, including updates to"
Compare: Insert�
text
"Updated sample messages to:"
Compare: Insert�
text
"message."
Compare: Insert�
text
"- clarify the sequence of the specification blocks within a"
Compare: Insert�
text
"pairs."
Compare: Insert�
text
"responses."
Compare: Insert�
text
"V2.0"
Compare: Insert�
text
"First draft for Industry Interface 3.0."
Compare: Insert�
text
"Updated sample messages with Service Restoration SLA,"
Compare: Insert�
text
"Multicast and 2 UNI-Vs."
Compare: Insert�
text
"V2.1"
Compare: Insert�
text
"Updated sample messages with corrections."
Compare: Insert�
text
"V2.2"
Compare: Insert�
text
"Updated sample messages to correct NFAS/NWAS 'Connected"
Compare: Insert�
text
"to UNI' and 'Connected to AVC' values."
Compare: Insert�
text
"V2.3"
Compare: Insert�
text
"Updated sample messages to correct CVC structure."
Compare: Insert�
text
"Updated touchpoint descriptions to:"
Compare: Insert�
text
"- clarify"
Compare: Insert�
text
"use of DescribedBy and SpecifiedBy name/value"
Compare: Insert�
text
"pairs, and"
Compare: Insert�
text
"- clarify the sequence of the specification blocks within a"
Compare: Insert�
text
"message."
Compare: Insert�
text
"V2.4"
Compare: Insert�
text
"Updated sample messages to:"
Compare: Insert�
text
"- add Multicast sample messages."
Compare: Insert�
text
"- add Second UNI-V sample messages."
Compare: Insert�
text
"- add"
Compare: Replace�
text
[Old text]: "Design Change Log." [New text]: "Restoration SLA sample messages."
Compare: Insert�
text
"- removed VLAN Mode from submit order sample messages."
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "- updated NTD Type and Location from External/Outdoor to"
Compare: Replace�
text
[Old text]: "Details" [New text]: "Internal/Indoor."The following text attributes were changed: font
Compare: Insert�
text
"V2.4"
Compare: Insert�
text
"V1.6"
Compare: Insert�
text
"2012/07/05"
Compare: Insert�
text
"2012/06/21"
Compare: Insert�
text
"2012/05/18"
Compare: Insert�
text
"2012/09/28"
Compare: Insert�
text
"2012/05/09"
Compare: Insert�
text
"2012/08/29"
Page 4: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 4 of 13

1. Introduction1.1 Purpose

The purpose of this document is to describe the service interface from a logical (functional) perspective.

1.2 ScopeThis document applies to: • The functional level interface description for the service• It details the service from a non-technical “black box” level to describe the service input and output

messages and concepts.

This document does NOT address: • Technical specifications, or physical design details of the service• Description of Functional and Non functional requirements

1.3 Target AudienceAudience Intended purpose

Business Stakeholder High-level understanding.Provide non-technical audience with a broad understanding of the service behaviour and constraints.

Project Team Project Planning.To support ongoing project planning.

Project Architects Project Architecture.To align other architectural views.

Nominated Reviewers Project Socialisation and Review.To understand service behaviour and constraints and to obtain objective feedback through the Peer Review & Ratification processes.

Integration Developers Input into detailed design.

Business Analysts Input into the Requirement Specification including service mapping documentation and schema designs.

Test Analysts High-level understanding & Next Phase.Provides a high level overview of the proposed service and used in conjunction with the System Requirement Specification, as input into their System Test documentation.

Service Consumer Stakeholders Input into detailed design and architecture for the systems consuming the service.

Service Provider Stakeholders Input into detailed design and architecture for the systems providing the service.

1.4 Document PrecedenceNBN Co’s Detailed B2B Specifications comprise a number of different documents. If there is any inconsistency between any of these documents, then that inconsistency will be resolved by giving precedence to the documents in the following order:1.The XSD, Product Definitions (XML), and the "NBN Co Product Attributes and Business Rules Matrix"2.The Interface Functional and Technical Specifications3.The Developer Guides and Message Examples

Page 5: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 5 of 13

2. Service DescriptionManage Inventory provides functions which allow an Access Seeker to request Product Instance information so that their systems can be aligned or reconciled to NBN Co.

Page 6: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 6 of 13

2.1 Information ModelThis section describes the key entities and their relationships in the service schema represented as a class diagram.

Page 7: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 7 of 13

2.2. requestProductInstanceInformation

Touchpoint DescriptionThis touchpoint is used by an Access Seeker to retrieve Product Instance details using their Access Seeker ID and Product Instance ID.Validation RulesThis following validation rules apply to this touchpoint. Failure to satisfy these validation rules can cause an input message to be rejected and the invocation to result in an error.

• A single Product Instance ID must be provided.• The Access Seeker ID must be provided.• An Access Seeker can only request product instance information on product orders where it is the owner.Characteristics• Each request will be handled without regard to previous requests. If a duplicate request is received by the touchpoint, it will be processed independently from the first request.

Each of the requests will result in a separate response.• Non-Repudiable: No.

This section describes in detail all attributes required in the request message, including a description, type and any length/cardinality restrictions. The cardinality column reflects whether an attribute is mandatory in the request.

Name Description Type Cardinality

/ManageInventoryRequest

Product Product must contain the Product Instance ID which will be used to retrieve Product Instance details.

Product 1..1

/ManageInventoryRequest/Product

ID Product Instance ID.Length: 15

string 1..1

Page 8: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 8 of 13

2.3. responseProductInstanceInformation

Touchpoint DescriptionThis touchpoint will return Product Instance details which match the provided Product Instance ID and Access Seeker ID. These details include:• Product Instance ID• Service Characteristics and Instance IDs• Resource Characteristics and Instance IDs• Access Seeker ID• First Activation Date• Billing Account IDCharacteristics• Non-Repudiable: No.• The sequence of specification blocks in the ebMS payload returned by this touchpoint may vary from the sequence provided in the sample messages.

Exception(Please refer to the Appendix for the exception codes and descriptions)

Description

validationException Returned when a validation issue prevents the processing of the request. For example, the message does not validate against the XSD and/or does not contain a mandatory field specified in the interface specification.

technicalException Returned when a technical issue prevents the processing of the request. For example, the end application is unavailable.

recordNotFoundException Returned when a combination of Product Instance ID and Access Seeker ID results in no Product Instance information being returned.

accountHierarchyViolationException Returned when the Product Instance ID is found, but the related Billing Account ID does not belong to the Access Seeker.

Compare: Insert�
text
"•The sequence of specification blocks in the ebMS payload returned by this touchpoint may vary from the sequence provided in the sample messages."
Page 9: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 9 of 13

This section describes in detail all attributes returned in the response message, including a description, type and any length/cardinality restrictions.Name Description Type Cardinality

/ManageInventoryResponse

Product Contains Products, Services and Resources details associated with the Product Instance

Product 1..1

/ManageInventoryResponse/Product

ID Product Instance ID.Length: 15

string 1..1

DescribedBy These name/value pairs will be used to communicate attributes which describes the Product.1. FirstActivationDate: The First Activation Date of the product. The value will be a DateTime stamp in UTC format e.g. yyyy-mm-ddThh:mm:ssZ. This is mandatory.2. BillingAccountID: The Billing Account ID related to the Product. The value will be the Billing Account ID and format will be a String. This is mandatory.For other Product attributes, the valid list and structure of name/value pairs are described in the Product Definition provided to Access Seeker by NBN Co during on-boarding.

CharacteristicValue 1..*

SpecifiedBy This contains the Product Specification details. EntitySpecification 1..1

ProductReferences ProductReferences contains associated Resources and Services. Product 0..*

/ManageInventoryResponse/Product/DescribedBy

value Represents the value attribute in a name-value pair. string 1..1

CharacteristicThe associated quality or distinctive feature that defines an entity

Characteristic 1..1

/ManageInventoryResponse/Product/DescribedBy/Characteristic

ID Represents the ID attribute in a name-value pair. string 0..1

name Represents the name attribute in a name-value pair. string 0..1

type Represents the categorization of the name-value pair. string 0..1

/ManageInventoryResponse/Product/ProductReferences

ID Resource or Service Instance IDLength: 15

string 1..1

Compare: Delete�
text
"mandatory."
Compare: Delete�
text
"SpecifiedBy"
Compare: Replace�
text
[Old text]: "This contains the Product Specification details." [New text]: "mandatory."
Compare: Delete�
text
"EntitySpecification"
Compare: Delete�
text
"1..1"
Compare: Delete�
text
"ProductReferences"
Compare: Replace�
text
[Old text]: "ProductReferences contains associated Resources and Services." [New text]: "For other"
Compare: Insert�
text
"attributes,"
Compare: Delete�
text
"0..*"
Compare: Delete�
text
"/ManageInventoryResponse/Product/ProductReferences"
Compare: Delete�
text
"ID"
Compare: Delete�
text
"Resource or Service Instance ID"
Compare: Delete�
text
"string"
Compare: Delete�
text
"0..1"
Compare: Delete�
text
"Length: 15"
Compare: Delete�
text
"DescribedBy"
Compare: Delete�
text
"This contains the name/value pairs which describe"
Compare: Delete�
text
"Resource or"
Compare: Delete�
text
"CharacteristicValue"
Compare: Delete�
text
"0..*"
Compare: Delete�
text
"Service. The"
Compare: Replace�
text
[Old text]: "Seekers" [New text]: "Seeker"
Compare: Replace�
text
[Old text]: "on-" [New text]: "on-boarding."
Compare: Delete�
text
"boarding."
Compare: Replace�
text
[Old text]: "0..1" [New text]: "1..1"
Compare: Delete�
text
"Sub"
Compare: Insert�
text
"/ManageInventoryResponse/Product/DescribedBy"
Compare: Insert�
text
"value"
Compare: Replace�
text
[Old text]: "/ManageInventoryResponse/Product/ProductReferences/ProductReferences" [New text]: "Represents the value attribute in a name-value pair."The following text attributes were changed: size
Compare: Insert�
text
"/ManageInventoryResponse/Product/DescribedBy/Characteristic"
Compare: Insert�
text
"The associated quality or distinctive feature that defines an entity"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"Characteristic"
Compare: Insert�
text
"Characteristic"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"string"
Compare: Replace�
text
[Old text]: "Resource or Service Instance" [New text]: "Represents the"
Compare: Insert�
text
"attribute in a name-value pair."
Compare: Replace�
text
[Old text]: "Length: 15" [New text]: "name"
Compare: Insert�
text
"0..1"
Compare: Insert�
text
"string"
Compare: Insert�
text
"Represents the name attribute in a name-value pair."
Compare: Replace�
text
[Old text]: "DescribedBy" [New text]: "type"
Compare: Replace�
text
[Old text]: "This contains" [New text]: "Represents"
Compare: Replace�
text
[Old text]: "name/value pairs which describe" [New text]: "categorization of"
Compare: Replace�
text
[Old text]: "Resource or" [New text]: "name-value pair."
Compare: Insert�
text
"0..1"
Compare: Insert�
text
"string"
Compare: Replace�
text
[Old text]: "CharacteristicValue" [New text]: "/ManageInventoryResponse/Product/ProductReferences"The following text attributes were changed: size
Compare: Delete�
text
"0..*"
Compare: Delete�
text
"Services. The valid list and structure of name/value pairs are described in"
Compare: Replace�
text
[Old text]: "the Product Definition provided to Access Seekers by NBN Co during on-" [New text]: "ID"
Compare: Insert�
text
"Resource or Service Instance ID"
Compare: Insert�
text
"string"
Compare: Delete�
text
"boarding."
Compare: Insert�
text
"1..1"
Compare: Replace�
text
[Old text]: "SpecifiedBy" [New text]: "Length: 15"
Compare: Delete�
text
"This contains the Product Specification details."
Compare: Delete�
text
"EntitySpecification"
Compare: Delete�
text
"0..1"
Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Page 10: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 10 of 13

DescribedBy This contains the name/value pairs which describe the Resource or Service. The valid list and structure of name/value pairs are described in the Product Definition provided to Access Seeker by NBN Co during on-boarding.

CharacteristicValue 0..*

SpecifiedBy This contains the Product Specification details. EntitySpecification 1..1

ProductReferences ProductReferences contains associated Sub Resources and Services. Product 0..*

/ManageInventoryResponse/Product/ProductReferences/DescribedBy

value Represents the value attribute in a name-value pair. string 1..1

CharacteristicThe associated quality or distinctive feature that defines an entity

Characteristic 1..1

/ManageInventoryResponse/Product/ProductReferences/DescribedBy/Characteristic

ID Represents the name attribute in a name-value pair. string 1..1

type Represents the categorization of the name-value pair. string 1..1

/ManageInventoryResponse/Product/ProductReferences/ProductReferences

ID Resource or Service Instance IDLength: 15

string 1..1

DescribedBy This contains the name/value pairs which describe the Resource or Services. The valid list and structure of name/value pairs are described in the Product Definition provided to Access Seeker by NBN Co during on-boarding.

CharacteristicValue 0..*

SpecifiedBy This contains the Product Specification details. EntitySpecification 1..1

/ManageInventoryResponse/Product/ProductReferences/ProductReferences/DescribedBy

value Represents the value attribute in a name-value pair. string 1..1

CharacteristicThe associated quality or distinctive feature that defines an entity

Characteristic 1..1

/ManageInventoryResponse/Product/ProductReferences/ProductReferences/DescribedBy/Characteristic

ID Represents the name attribute in a name-value pair. string 1..1

type Represents the categorization of the name-value pair. string 1..1

/ManageInventoryResponse/Product/ProductReferences/ProductReferences/SpecifiedBy

ID Product Specification IDLength: 15

string 1..1

version Product Specification VersionLength: 6

string 1..1

type Product Specification Type string 1..1

Page 11: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 11 of 13

category Product Specification Category string 1..1

/ManageInventoryResponse/Product/ProductReferences/SpecifiedBy

ID Product Specification IDLength: 15

string 1..1

version Product Specification VersionLength: 6

string 1..1

type Product Specification Type string 1..1

category Product Specification Category string 1..1

/ManageInventoryResponse/Product/SpecifiedBy

ID Product Specification IDLength: 15

string 1..1

version Product Specification VersionLength: 6

string 1..1

type Product Specification Type string 1..1

category Product Specification Category string 1..1

Compare: Insert�
text
"categoryProduct Specification Category/ManageInventoryResponse/Product/ProductReferences/SpecifiedBy"
Compare: Delete�
text
"/ManageInventoryResponse/Product/SpecifiedBy"
Compare: Insert�
text
"Length: 15"
Compare: Replace�
text
[Old text]: "string" [New text]: "version"
Compare: Replace�
text
[Old text]: "0..1" [New text]: "Product Specification Version"
Compare: Replace�
text
[Old text]: "15" [New text]: "6"
Compare: Insert�
text
"type"
Compare: Insert�
text
"Product Specification Type"
Compare: Replace�
text
[Old text]: "version" [New text]: "category"
Compare: Replace�
text
[Old text]: "Version" [New text]: "Category"
Compare: Insert�
text
"/ManageInventoryResponse/Product/SpecifiedBy"
Compare: Replace�
text
[Old text]: "string" [New text]: "ID"
Compare: Replace�
text
[Old text]: "0..1" [New text]: "Product Specification ID"
Compare: Replace�
text
[Old text]: "6" [New text]: "15"
Compare: Insert�
text
"Product Specification Version"
Compare: Insert�
text
"version"
Compare: Insert�
text
"Length: 6"
Compare: Delete�
text
"string"
Compare: Delete�
text
"0..1"
Compare: Insert�
text
"string"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"string"
Compare: Move�
text
This text was moved from page 10 of old document to page 11 of this document
Compare: Insert�
text
"1..1"
Compare: Replace�
text
[Old text]: "0..1" [New text]: "1..1"
Compare: Insert�
text
"1..11..111 of 13"
Compare: Insert�
text
"stringstring"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"string"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"string"
Compare: Insert�
text
"1..11..1"
Compare: Insert�
text
"stringstring"
Compare: Delete�
text
"12"
Compare: Delete�
text
"10 of"
Page 12: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFS - 2012/09/28Document Version V2.4 © 2012 NBN Co Ltd 12 of 13

Appendix A - List of Values

List of values

ExceptionsThe code in the table below will be returned in the Exception\ID attribute. The description in the table will be returned in the Exception\description attribute.

ValidationException Version: V3.0

001000 The following mandatory field or fields are not provided: %field1%, %field2%, ....

001001 Field length of %fieldName% is invalid, the length provided is %providedLengthOfField% but it should be %acceptedLengthOfField%

001002 Data type mismatch on field %fieldName%

001003 Incorrect enumeration of %enumeration% provided for field %fieldName%

001004 Invalid parameter combination : %parameter1% cannot be provided with %parameter2%

001005 The following field or fields should not be provided for this operation: %field1%, %field2%,....

001006 The following technical issue or issues were found when validating the message: %technicalValidationReason1%. %technicalValidationReason2%. ...

001007 The specified %fieldName% is invalid due to the end date being before the start date

001008 The value specified in the field %fieldName% exceeds the maximum of %maximum allowed%

001009 The value of %fieldName% is invalid as it is in the future.

001010 The number of occurrences for the following field %fieldName% exceeds the defined maximum occurrences of %maxOccurrences%

001011 At least one of the following fields must be provided: %field1%, %field2%

001012 The value for %field name% : %field value% is in an invalid format

TechnicalException Version: V3.0

000000 A technical error has occurred during the processing of the request.

RecordNotFoundException Version: V3.0

011000 No records were found to match the %field% %ID% specified in the request

AccountHierarchyViolationException Version: V3.0

002000 The Billing Account ID %Billing Account ID% does not belong to the Access Seeker

002001 The Product Instance ID : %ID% does not belong to the Access Seeker

Page 13: Interface Functional Specification ManageInventory
Page 14: Interface Functional Specification ManageInventory

Interface Functional Specification ManageInventoryIndustry InterfaceNBN CO OSS PROGRAM

This document forms part of NBN Co's Wholesale Broadband Agreement, which is a Standard Form of Access Agreement for the purposes of Part XIC of the Competition and Consumer Act 2010.

Page 15: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 2 of 12

Copyright

This document is subject to copyright and must not be used except as permitted below or under the Copyright Act 1968 (Cth). You must not reproduce or publish this document in whole or in part for commercial gain without the prior written consent of NBN Co. You may reproduce and publish this document in whole or in part for educational or non-commercial purposes as approved by NBN Co in writing.

Copyright © 2012 NBN Co Limited. All rights reserved.

Disclaimer

This document predominantly sets out technical information in relation to NBN Co's B2B Gateway. It also sets out some of terms and conditions that apply in relation to NBN Co's B2B Gateway. Other terms and conditions in relation to NBN Co's B2B Gateway are set out elsewhere in the Wholesale Broadband Agreement between NBN Co and Access Seeker, including in the Product Description for the NBN Co Platform Interfacing Service and the NBN Co Operations Manual. Access Seeker is advised to familiarise itself with all of the terms and conditions that apply in relation to NBN Co's B2B Gateway, not just those terms and conditions set out in this document. Where NBN Co has provided recommendations or examples in this document, Access Seeker must not assume that NBN Co's networks, platforms or systems will support Access Seeker's implementation of such recommendations or examples. Information that is identified as important in this document is brought to Access Seeker's attention for practical purposes of understanding all information in context and should not necessary be accorded more weight than other information for implementation purposes.

Environment

NBN Co asks that you consider the environment before printing this document.

Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 16: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 3 of 12

Document Control

Title Interface Functional Specification: ManageInventory

Revision History

Detailed descriptions of changes can be found in the Service Design Change Log.

Version Date Details

V1.5 2012/04/06 First Release

Related DocumentsDocument Title Version

ManageInventory Interface Technical Specification V1.5

Interface Common Objects Specification V1.4

Compare: Replace�
text
[Old text]: "Detailed" [New text]: "Version"The following text attributes were changed: font
Compare: Insert�
text
"Updated touchpoint"
Compare: Insert�
text
"Updated under Industry Interface 2.1."
Compare: Insert�
text
"2012/08/29"
Compare: Insert�
text
"V1.6"
Compare: Insert�
text
"First Release"
Compare: Insert�
text
"2012/04/06"
Compare: Insert�
text
"V1.5"
Compare: Insert�
text
"Details"
Compare: Insert�
text
"Date"
Compare: Insert�
text
"to:"
Compare: Insert�
text
"- clarify the use"
Compare: Replace�
text
[Old text]: "changes can be found" [New text]: "DescribedBy and SpecifiedBy name/value"
Compare: Insert�
text
"- correct Port ID, SVLAN ID and CVLAN ID behaviour"
Compare: Insert�
text
""Connected to UNI" values."
Compare: Insert�
text
"- correct Transient IDs for NFAS/NWAS, including updates to"
Compare: Insert�
text
"Updated sample messages to:"
Compare: Insert�
text
"message."
Compare: Insert�
text
"- clarify the sequence of the specification blocks within a"
Compare: Insert�
text
"pairs."
Compare: Insert�
text
"responses."
Compare: Insert�
text
"V2.0"
Compare: Insert�
text
"2012/05/09"
Compare: Insert�
text
"First draft for Industry Interface 3.0."
Compare: Insert�
text
"Updated sample messages with Service Restoration SLA,"
Compare: Insert�
text
"Multicast and 2 UNI-Vs."
Compare: Insert�
text
"V2.1"
Compare: Insert�
text
"2012/05/18"
Compare: Insert�
text
"Updated sample messages with corrections."
Compare: Insert�
text
"V2.2"
Compare: Insert�
text
"2012/06/21"
Compare: Insert�
text
"Updated sample messages to correct NFAS/NWAS 'Connected"
Compare: Insert�
text
"to UNI' and 'Connected to AVC' values."
Compare: Insert�
text
"V2.3"
Compare: Insert�
text
"2012/07/05"
Compare: Insert�
text
"Updated sample messages to correct CVC structure."
Compare: Insert�
text
"Updated touchpoint descriptions to:"
Compare: Insert�
text
"- clarify"
Compare: Insert�
text
"use of DescribedBy and SpecifiedBy name/value"
Compare: Insert�
text
"pairs, and"
Compare: Insert�
text
"- clarify the sequence of the specification blocks within a"
Compare: Insert�
text
"message."
Compare: Insert�
text
"V2.4"
Compare: Insert�
text
"2012/09/28"
Compare: Insert�
text
"Updated sample messages to:"
Compare: Insert�
text
"- add Multicast sample messages."
Compare: Insert�
text
"- add Second UNI-V sample messages."
Compare: Insert�
text
"- add"
Compare: Replace�
text
[Old text]: "Design Change Log." [New text]: "Restoration SLA sample messages."
Compare: Insert�
text
"- removed VLAN Mode from submit order sample messages."
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "- updated NTD Type and Location from External/Outdoor to"
Compare: Delete�
text
"Version"
Compare: Delete�
text
"Date2012/04/06"
Compare: Delete�
text
"First Release"
Compare: Replace�
text
[Old text]: "Details" [New text]: "Internal/Indoor."The following text attributes were changed: font
Compare: Insert�
text
"Version"
Compare: Insert�
text
"V2.4"
Compare: Insert�
text
"V1.6"
Compare: Delete�
text
"VersionV1.5V1.4"
Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 17: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 4 of 12

1. Introduction1.1 Purpose

The purpose of this document is to describe the service interface from a logical (functional) perspective.

1.2 ScopeThis document applies to: • The functional level interface description for the service• It details the service from a non-technical “black box” level to describe the service input and output

messages and concepts.

This document does NOT address: • Technical specifications, or physical design details of the service• Description of Functional and Non functional requirements

1.3 Target AudienceAudience Intended purpose

Business Stakeholder High-level understanding.Provide non-technical audience with a broad understanding of the service behaviour and constraints.

Project Team Project Planning.To support ongoing project planning.

Project Architects Project Architecture.To align other architectural views.

Nominated Reviewers Project Socialisation and Review.To understand service behaviour and constraints and to obtain objective feedback through the Peer Review & Ratification processes.

Integration Developers Input into detailed design.

Business Analysts Input into the Requirement Specification including service mapping documentation and schema designs.

Test Analysts High-level understanding & Next Phase.Provides a high level overview of the proposed service and used in conjunction with the System Requirement Specification, as input into their System Test documentation.

Service Consumer Stakeholders Input into detailed design and architecture for the systems consuming the service.

Service Provider Stakeholders Input into detailed design and architecture for the systems providing the service.

1.4 Document PrecedenceNBN Co’s Detailed B2B Specifications comprise a number of different documents. If there is any inconsistency between any of these documents, then that inconsistency will be resolved by giving precedence to the documents in the following order:1.The XSD, Product Definitions (XML), and the "NBN Co Product Attributes and Business Rules Matrix"2.The Interface Functional and Technical Specifications3.The Developer Guides and Message Examples

Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 18: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 5 of 12

2. Service DescriptionManage Inventory provides functions which allow an Access Seeker to request Product Instance information so that their systems can be aligned or reconciled to NBN Co.

Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 19: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 6 of 12

2.1 Information ModelThis section describes the key entities and their relationships in the service schema represented as a class diagram.

Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 20: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 7 of 12

2.2. requestProductInstanceInformation

Touchpoint DescriptionThis touchpoint is used by an Access Seeker to retrieve Product Instance details using their Access Seeker ID and Product Instance ID.Validation RulesThis following validation rules apply to this touchpoint. Failure to satisfy these validation rules can cause an input message to be rejected and the invocation to result in an error.

• A single Product Instance ID must be provided.• The Access Seeker ID must be provided.• An Access Seeker can only request product instance information on product orders where it is the owner.Characteristics• Each request will be handled without regard to previous requests. If a duplicate request is received by the touchpoint, it will be processed independently from the first request.

Each of the requests will result in a separate response.• Non-Repudiable: No.

This section describes in detail all attributes required in the request message, including a description, type and any length/cardinality restrictions. The cardinality column reflects whether an attribute is mandatory in the request.

Name Description Type Cardinality

/ManageInventoryRequest

Product Product must contain the Product Instance ID which will be used to retrieve Product Instance details.

Product 1..1

/ManageInventoryRequest/Product

ID Product Instance ID.Length: 15

string 1..1

Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 21: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 8 of 12

2.3. responseProductInstanceInformation

Touchpoint DescriptionThis touchpoint will return Product Instance details which match the provided Product Instance ID and Access Seeker ID. These details include:• Product Instance ID• Service Characteristics and Instance IDs• Resource Characteristics and Instance IDs• Access Seeker ID• First Activation Date• Billing Account IDCharacteristics• Non-Repudiable: No.

Exception(Please refer to the Appendix for the exception codes and descriptions)

Description

validationException Returned when a validation issue prevents the processing of the request. For example, the message does not validate against the XSD and/or does not contain a mandatory field specified in the interface specification.

technicalException Returned when a technical issue prevents the processing of the request. For example, the end application is unavailable.

recordNotFoundException Returned when a combination of Product Instance ID and Access Seeker ID results in no Product Instance information being returned.

accountHierarchyViolationException Returned when the Product Instance ID is found, but the related Billing Account ID does not belong to the Access Seeker.

Compare: Insert�
text
"•The sequence of specification blocks in the ebMS payload returned by this touchpoint may vary from the sequence provided in the sample messages."
Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 22: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 9 of 12

This section describes in detail all attributes returned in the response message, including a description, type and any length/cardinality restrictions.Name Description Type Cardinality

/ManageInventoryResponse

Product Contains Products, Services and Resources details associated with the Product Instance

Product 1..1

/ManageInventoryResponse/Product

ID Product Instance ID.Length: 15

string 1..1

DescribedBy These name/value pairs will be used to communicate attributes which describes the Product.1. FirstActivationDate: The First Activation Date of the product. The value will be a DateTime stamp in UTC format e.g. yyyy-mm-ddThh:mm:ssZ. This is mandatory.2. BillingAccountID: The Billing Account ID related to the Product. The value will be the Billing Account ID and format will be a String. This is mandatory.

CharacteristicValue 1..*

SpecifiedBy This contains the Product Specification details. EntitySpecification 1..1

ProductReferences ProductReferences contains associated Resources and Services. Product 0..*

/ManageInventoryResponse/Product/ProductReferences

ID Resource or Service Instance IDLength: 15

string 0..1

DescribedBy This contains the name/value pairs which describe the Resource or Service. The valid list and structure of name/value pairs are described in the Product Definition provided to Access Seekers by NBN Co during on-boarding.

CharacteristicValue 0..*

SpecifiedBy This contains the Product Specification details. EntitySpecification 0..1

ProductReferences ProductReferences contains associated Sub Resources and Services. Product 0..*

/ManageInventoryResponse/Product/ProductReferences/ProductReferences

ID Resource or Service Instance IDLength: 15

string 0..1

DescribedBy This contains the name/value pairs which describe the Resource or Services. The valid list and structure of name/value pairs are described in the Product Definition provided to Access Seekers by NBN Co during on-boarding.

CharacteristicValue 0..*

SpecifiedBy This contains the Product Specification details. EntitySpecification 0..1

Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Delete�
text
"mandatory."
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Delete�
text
"SpecifiedBy"
Compare: Replace�
text
[Old text]: "This contains the Product Specification details." [New text]: "mandatory."
Compare: Delete�
text
"EntitySpecification"
Compare: Delete�
text
"1..1"
Compare: Delete�
text
"ProductReferences"
Compare: Replace�
text
[Old text]: "ProductReferences contains associated Resources and Services." [New text]: "For other"
Compare: Insert�
text
"attributes,"
Compare: Delete�
text
"0..*"
Compare: Delete�
text
"/ManageInventoryResponse/Product/ProductReferences"
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Delete�
text
"ID"
Compare: Delete�
text
"Resource or Service Instance ID"
Compare: Delete�
text
"string"
Compare: Delete�
text
"0..1"
Compare: Delete�
text
"Length: 15"
Compare: Delete�
text
"DescribedBy"
Compare: Delete�
text
"This contains the name/value pairs which describe"
Compare: Delete�
text
"Resource or"
Compare: Delete�
text
"CharacteristicValue"
Compare: Delete�
text
"0..*"
Compare: Delete�
text
"Service. The"
Compare: Replace�
text
[Old text]: "Seekers" [New text]: "Seeker"
Compare: Replace�
text
[Old text]: "on-" [New text]: "on-boarding."
Compare: Delete�
text
"boarding."
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Replace�
text
[Old text]: "0..1" [New text]: "1..1"
Compare: Delete�
text
"Sub"
Compare: Insert�
text
"/ManageInventoryResponse/Product/DescribedBy"
Compare: Insert�
text
"value"
Compare: Replace�
text
[Old text]: "/ManageInventoryResponse/Product/ProductReferences/ProductReferences" [New text]: "Represents the value attribute in a name-value pair."The following text attributes were changed: size
Compare: Insert�
text
"/ManageInventoryResponse/Product/DescribedBy/Characteristic"
Compare: Insert�
text
"The associated quality or distinctive feature that defines an entity"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"Characteristic"
Compare: Insert�
text
"Characteristic"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"string"
Compare: Replace�
text
[Old text]: "Resource or Service Instance" [New text]: "Represents the"
Compare: Insert�
text
"attribute in a name-value pair."
Compare: Replace�
text
[Old text]: "Length: 15" [New text]: "name"
Compare: Insert�
text
"0..1"
Compare: Insert�
text
"string"
Compare: Insert�
text
"Represents the name attribute in a name-value pair."
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Replace�
text
[Old text]: "DescribedBy" [New text]: "type"
Compare: Replace�
text
[Old text]: "This contains" [New text]: "Represents"
Compare: Replace�
text
[Old text]: "name/value pairs which describe" [New text]: "categorization of"
Compare: Replace�
text
[Old text]: "Resource or" [New text]: "name-value pair."
Compare: Insert�
text
"0..1"
Compare: Insert�
text
"string"
Compare: Replace�
text
[Old text]: "CharacteristicValue" [New text]: "/ManageInventoryResponse/Product/ProductReferences"The following text attributes were changed: size
Compare: Delete�
text
"0..*"
Compare: Delete�
text
"Services. The valid list and structure of name/value pairs are described in"
Compare: Move�
table cell
This table cell was moved from page 9 of this document to page 9 of new document
Compare: Move�
table cell
This table cell was moved to page 9 of new document
Compare: Replace�
text
[Old text]: "the Product Definition provided to Access Seekers by NBN Co during on-" [New text]: "ID"
Compare: Insert�
text
"Resource or Service Instance ID"
Compare: Insert�
text
"string"
Compare: Delete�
text
"boarding."
Compare: Insert�
text
"1..1"
Compare: Replace�
text
[Old text]: "SpecifiedBy" [New text]: "Length: 15"
Compare: Delete�
text
"This contains the Product Specification details."
Compare: Delete�
text
"EntitySpecification"
Compare: Delete�
text
"0..1"
Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 23: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 10 of 12

/ManageInventoryResponse/Product/SpecifiedBy

ID Product Specification IDLength: 15

string 0..1

version Product Specification VersionLength: 6

string 0..1

type Product Specification Type string 0..1

category Product Specification Category string 0..1

Compare: Insert�
text
"categoryProduct Specification Category/ManageInventoryResponse/Product/ProductReferences/SpecifiedBy"
Compare: Delete�
text
"/ManageInventoryResponse/Product/SpecifiedBy"
Compare: Insert�
text
"Length: 15"
Compare: Replace�
text
[Old text]: "string" [New text]: "version"
Compare: Replace�
text
[Old text]: "0..1" [New text]: "Product Specification Version"
Compare: Replace�
text
[Old text]: "15" [New text]: "6"
Compare: Insert�
text
"type"
Compare: Insert�
text
"Product Specification Type"
Compare: Replace�
text
[Old text]: "version" [New text]: "category"
Compare: Replace�
text
[Old text]: "Version" [New text]: "Category"
Compare: Insert�
text
"/ManageInventoryResponse/Product/SpecifiedBy"
Compare: Replace�
text
[Old text]: "string" [New text]: "ID"
Compare: Replace�
text
[Old text]: "0..1" [New text]: "Product Specification ID"
Compare: Replace�
text
[Old text]: "6" [New text]: "15"
Compare: Insert�
text
"Product Specification Version"
Compare: Insert�
text
"version"
Compare: Insert�
text
"Length: 6"
Compare: Delete�
text
"string"
Compare: Delete�
text
"0..1"
Compare: Insert�
text
"string"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"string"
Compare: Move�
text
This text was moved from page 10 of this document to page 11 of new document
Compare: Move�
text
This text was moved to page 11 of new document
Compare: Insert�
text
"1..1"
Compare: Replace�
text
[Old text]: "0..1" [New text]: "1..1"
Compare: Insert�
text
"1..11..111 of 13"
Compare: Insert�
text
"stringstring"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"string"
Compare: Insert�
text
"1..1"
Compare: Insert�
text
"string"
Compare: Insert�
text
"1..11..1"
Compare: Insert�
text
"stringstring"
Compare: Delete�
text
"12"
Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Delete�
text
"10 of"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 24: Interface Functional Specification ManageInventory

NBN Co OSS Program

SFAA - WBA - NBN Co Platform Interfacing Service - ManageInventory V1.0 IFSDocument Version V1.5 © 2012 NBN Co Ltd 11 of 12

Appendix A - List of Values

List of values

ExceptionsThe code in the table below will be returned in the Exception\ID attribute. The description in the table will be returned in the Exception\description attribute.

ValidationException Version: V3.0

001000 The following mandatory field or fields are not provided: %field1%, %field2%, ....

001001 Field length of %fieldName% is invalid, the length provided is %providedLengthOfField% but it should be %acceptedLengthOfField%

001002 Data type mismatch on field %fieldName%

001003 Incorrect enumeration of %enumeration% provided for field %fieldName%

001004 Invalid parameter combination : %parameter1% cannot be provided with %parameter2%

001005 The following field or fields should not be provided for this operation: %field1%, %field2%,....

001006 The following technical issue or issues were found when validating the message: %technicalValidationReason1%. %technicalValidationReason2%. ...

001007 The specified %fieldName% is invalid due to the end date being before the start date

001008 The value specified in the field %fieldName% exceeds the maximum of %maximum allowed%

001009 The value of %fieldName% is invalid as it is in the future.

001010 The number of occurrences for the following field %fieldName% exceeds the defined maximum occurrences of %maxOccurrences%

001011 At least one of the following fields must be provided: %field1%, %field2%

001012 The value for %field name% : %field value% is in an invalid format

TechnicalException Version: V3.0

000000 A technical error has occurred during the processing of the request.

RecordNotFoundException Version: V3.0

011000 No records were found to match the %field% %ID% specified in the request

AccountHierarchyViolationException Version: V3.0

002000 The Billing Account ID %Billing Account ID% does not belong to the Access Seeker

002001 The Product Instance ID : %ID% does not belong to the Access Seeker

Compare: Insert�
text
"- 2012/09/28"
Compare: Replace�
text
[Old text]: "V1.5" [New text]: "V2.4"
Compare: Replace�
text
[Old text]: "11" [New text]: "12"
Compare: Replace�
text
[Old text]: "12" [New text]: "13"
Compare: Replace�
image
This image was replaced (click to see the new and difference images)
Page 25: Interface Functional Specification ManageInventory