# Chorus UFB API
[Query Service Qualification (tested 21/01/22)](#Query-Service-Qualification)
[Transfer Primary (tested 10/02/22)](#Transfer-Primary)
[Disconnect Primary (tested 21/01/22)](#Disconnect-Primary)
[Connect Secondary (tested 10/02/22)](#Connect-Secondary)
[Disconnect Secondary (tested 21/01/22)](#Disconnect-Secondary)
[Change Offer (tested 24/01/22)](#Change-Offer)
[Modifiy Attribute (tested 25/01/22)](#Modify-Attribute)
### <a>Query Service Qualification</a>
*url:*
>POST /serviceQualificationManagement/v4/queryServiceQualification
*request:*
```json
{
"searchCriteria": {
"service": {
"place": [
{
"name": "CHORUS",
"id": "100727821"
}
]
}
}
}
```
*response:*
```json
200 OK
{
"queryServiceQualificationDate": "2022-01-20T15:07:15.433+13:00",
"searchCriteria": {
"service": {
"place": [
{
"id": "100727821",
"name": "CHORUS",
"role": ""
}
]
}
},
"serviceQualificationItem": [
{
"@type": "ServiceQualificationItemExtended",
"availability": {
"Services": [
{
"ServiceType": "fibre",
"AccessType": "ufb",
"ServiceabilityType": "install-required",
"DownloadSpeed": 0,
"UploadSpeed": 0,
"Speeds": null,
"ServiceProperties": [
"intact"
],
"LocationProvider": "CHORUS",
"LocationProviderIDX": "100727821",
"Products": [
{
"Name": "Business 1",
"PrimaryOffer": true,
"MarketSegment": "BUSINESS",
"ProductOfferID": "2",
"ProductOfferSpecID": "2",
"ProductOfferCompatID": "21"
},
...
],
"FibreInfo": {
"FibreAvailable": true,
"FibreAvailableDate": "",
"FibreInADay": false,
"ONTIDs": [
"ONT008536212"
],
"IntactServiceIDs": [
"1636029202-Primary-OWNED_BY_RSP:Y"
],
"IsROW": false,
"DwellingType": "SDU",
"CO": "RUE",
"Consented": "true",
"SpareONTPorts": 2,
"ONTSerials": [
"ALCL20417305"
],
"OntLinkStatus": "",
"PointOfInterconnect": ""
}
}
],
"Location": {
"UUID": "",
"SPID": 0,
"GooglePlaceID": "",
"SlamID": 0,
"SamID": 0,
"DPID": 0,
"CreatedAtNanos": 0,
"UpdatedAtNanos": 0,
"DeletedAtNanos": 0,
"LocationProvider": "CHORUS",
"LocationProviderIDX": "100727821",
"UnitType": "",
"UnitTypeExtra": "",
"Number": "40",
"NumberPre": "",
"NumberPost": "",
"StreetName": "NGAPUHI",
"StreetType": "ROAD",
"Suburb": "REMUERA",
"City": "AUCKLAND",
"State": "",
"Country": "New Zealand",
"PostCode": "1050",
"Formatted": "",
"FormattedOriginal": "",
"Notes": "",
"Latitude": "",
"Longitude": "",
"Rank": 0,
"Score": 0,
"TUI": 0,
"FloorNumberType": "",
"FloorNumberNumber": "",
"BuildingName": "",
"Addressable": false
},
"UUID": "c194f4d0-a6f7-460f-8afb-6c6a8fce712a",
"RequestedLocationProvider": "CHORUS",
"RequestedLocationProviderIDX": "100727821"
},
"service": {
"place": [
{
"id": "100727821",
"name": "CHORUS",
"role": ""
}
]
}
}
]
}
```
### <a>Transfer Primary</a>
1. Query Service Qualification
[goto](#Query-Service-Qualification)
2. ServiceOrder (Transfer Primary)
*url:*
>POST /serviceOrdering/v4/serviceOrder
*request:*
```json
{
"externalId": "TEST_CREATE_CHORUS_26f93390-1b3b-4746-8692-de032d68cf7d",
"serviceOrderItem": [
{
"id": "1",
"action": "add",
"service": {
"serviceSpecification": {
"id": "UFB"
},
"serviceCharacteristic": [
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "102081672"
},
{
"Name": "ufb.OrderType",
"valueType": "string",
"value": "Transfer Primary"
},
{
"Name": "ufb.Chorus.ProductOfferingId",
"valueType": "string",
"value": "136"
},
{
"Name": "ufb.Chorus.ExistingProviderName",
"valueType": "string",
"value": "Vodafone Cloud"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "081c6839-16fd-4b88-95c1-86189c73b81c"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "shien"
},
{
"Name": "ufb.Chorus.ConnectRFSDateTime",
"valueType": "string",
"Value": "1644881032663000000"
}
]
}
}
]
}
```
*response*
```json
{
"id": "82011a36-389b-41b5-83d2-334d77c139a9",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceOrdering/v4/serviceOrder/82011a36-389b-41b5-83d2-334d77c139a9",
"externalId": "TEST_CREATE_CHORUS_26f93390-1b3b-4746-8692-de032d68cf7d",
"orderDate": "2022-02-10T11:50:11.541+13:00",
"serviceOrderItem": [
{
"@type": "serviceOrderItem",
"action": "add",
"id": "1",
"service": {
"id": "8d13b64e-a7ac-44ad-879b-e363a0be7c6b",
"serviceType": "UFB",
"serviceCharacteristic": [
{
"name": "ufb.ActiveASSURANCE_L1_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveASSURANCE_L2_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveCIRCUIT_ID_INSERTION",
"valueType": "string",
"value": "DHCP Option 82"
},
{
"name": "ufb.ActiveCONNECT_RFS_DATE_TIME",
"valueType": "string",
"value": "1644739200000000000"
},
{
"name": "ufb.ActiveDATA_HANDOVER_CONNECTION_ID",
"valueType": "string",
"value": "120695030"
},
{
"name": "ufb.ActiveDOWNSTREAM_HP",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_CIR",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_EIR",
"valueType": "string",
"value": "300"
},
{
"name": "ufb.ActiveONT_ID",
"valueType": "string",
"value": "ONT009718797"
},
{
"name": "ufb.ActiveORDER_DATE",
"valueType": "string",
"value": "1644447014000000000"
},
{
"name": "ufb.ActivePlaceDescription",
"valueType": "string",
"value": "Please consult with customer."
},
{
"name": "ufb.ActivePlaceID",
"valueType": "string",
"value": "102081672"
},
{
"name": "ufb.ActiveProductProductOfferID",
"valueType": "string",
"value": "136"
},
{
"name": "ufb.ActiveProductProductOfferName",
"valueType": "string",
"value": "vf Private 100-20-2.5-2.5"
},
{
"name": "ufb.ActiveSiteContactName",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.ActiveSiteContactPhone",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.ActiveUNI_PORT_NUMBER",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveUNI_PORT_TYPE",
"valueType": "string",
"value": "1G"
},
{
"name": "ufb.ActiveUNI_TAGGING",
"valueType": "string",
"value": "Tagged"
},
{
"name": "ufb.ActiveUPSTREAM_HP",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveUPSTREAM_LP_CIR",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveUPSTREAM_LP_EIR",
"valueType": "string",
"value": "100"
},
{
"name": "ufb.Chorus.ChorusOrderItemIds",
"valueType": "string",
"value": "2629103"
},
{
"name": "ufb.Chorus.ConnectRFSDateTime",
"valueType": "string",
"value": "1644739200000000000"
},
{
"name": "ufb.Chorus.ExistingProductId",
"valueType": "string",
"value": "1637008551"
},
{
"name": "ufb.Chorus.ExistingProviderName",
"valueType": "string",
"value": "Vodafone Cloud"
},
{
"name": "ufb.Chorus.OrderId",
"valueType": "string",
"value": "100227300"
},
{
"name": "ufb.Chorus.OrderItemState",
"valueType": "string",
"value": "Acknowledged"
},
{
"name": "ufb.Chorus.OrderItemSubstate",
"valueType": "string",
"value": "Received"
},
{
"name": "ufb.Chorus.ProductOfferingId",
"valueType": "string",
"value": "136"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "shien"
},
{
"name": "ufb.HandoverID",
"valueType": "string",
"value": "120695030"
},
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"name": "ufb.LFCOrderID",
"valueType": "string",
"value": "100227300"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "102081672"
},
{
"name": "ufb.OrderDate",
"valueType": "string",
"value": "1644447014000000000"
},
{
"name": "ufb.OrderType",
"valueType": "string",
"value": "Transfer Primary"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "081c6839-16fd-4b88-95c1-86189c73b81c"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
}
],
"serviceSpecification": {
"id": "f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceCatalogManagement/v3/serviceSpecification/f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"name": "UFB"
},
"state": "feasibilityChecked"
},
"state": "acknowledged",
"substate": "Received"
}
],
"state": "acknowledged"
}
```
### <a>Disconnect Primary</a>
1. Query Service Qualification
[goto](#Query-Service-Qualification)
2. ServiceOrder (Disconnect Primary)
*url:*
>POST /serviceOrdering/v4/serviceOrder
*request:*
```json
{
"externalId": "TEST_CREATE_CHORUS_a5af7679-7fd9-4e02-b19b-d69f4285ca3c",
"serviceOrderItem": [
{
"id": "1",
"action": "add",
"service": {
"serviceSpecification": {
"id": "UFB"
},
"serviceCharacteristic": [
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"Name": "ufb.OrderType",
"valueType": "string",
"value": "Disconnect Primary"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "100725525"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "dbe03a40-8f87-4084-a0b6-61d42c040637"
},
{
"Name": "ufb.Chorus.ExistingProductID",
"valueType": "string",
"value": "1637006638"
},
{
"name": "ufb.Chorus.DisConnectRFSDateTime",
"valueType": "timedate",
"value": "1643270400000000000"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": ""
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "2bbecace-b1b2-4e16-91a4-7a028b6486c5"
}
]
}
}
]
}
```
*response*
```json
202 Accepted
{
"id": "3382c4a2-bd68-4d07-98e0-fe58f5e7c80d",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceOrdering/v4/serviceOrder/3382c4a2-bd68-4d07-98e0-fe58f5e7c80d",
"externalId": "TEST_CREATE_CHORUS_b44ca3c4-c6a3-4230-8f0b-09ac31fefa98",
"orderDate": "2022-01-26T10:10:16.643+13:00",
"serviceOrderItem": [
{
"@type": "serviceOrderItem",
"action": "add",
"id": "1",
"service": {
"id": "1fabccdf-6760-4d47-9d68-4ec59325fdec",
"serviceType": "UFB",
"serviceCharacteristic": [
{
"name": "ufb.ActiveASSURANCE_L1_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveASSURANCE_L2_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveBITSTREAM_UID_1",
"valueType": "string",
"value": "1636029724B01"
},
{
"name": "ufb.ActiveCIRCUIT_ID_INSERTION",
"valueType": "string",
"value": "DHCP Option 82"
},
{
"name": "ufb.ActiveDATA_HANDOVER_CONNECTION_ID",
"valueType": "string",
"value": "120695212"
},
{
"name": "ufb.ActiveDATA_VLAN_CVID",
"valueType": "string",
"value": "1000"
},
{
"name": "ufb.ActiveDATA_VLAN_SVID",
"valueType": "string",
"value": "1001"
},
{
"name": "ufb.ActiveDISCONNECT_RFS_DATE_TIME",
"valueType": "string",
"value": "1643270400000000000"
},
{
"name": "ufb.ActiveDOWNSTREAM_HP",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_CIR",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_EIR",
"valueType": "string",
"value": "300"
},
{
"name": "ufb.ActiveONT_ID",
"valueType": "string",
"value": "ONT002754652"
},
{
"name": "ufb.ActiveORDER_DATE",
"valueType": "string",
"value": "1643145018000000000"
},
{
"name": "ufb.ActivePlaceDescription",
"valueType": "string",
"value": "Please consult with customer."
},
{
"name": "ufb.ActivePlaceID",
"valueType": "string",
"value": "100725515"
},
{
"name": "ufb.ActiveProductID",
"valueType": "string",
"value": "1636029724"
},
{
"name": "ufb.ActiveProductProductOfferID",
"valueType": "string",
"value": "136"
},
{
"name": "ufb.ActiveProductProductOfferName",
"valueType": "string",
"value": "vf Private 100-20-2.5-2.5"
},
{
"name": "ufb.ActiveUNI_PORT_NUMBER",
"valueType": "string",
"value": "1"
},
{
"name": "ufb.ActiveUNI_PORT_TYPE",
"valueType": "string",
"value": "1G"
},
{
"name": "ufb.ActiveUNI_TAGGING",
"valueType": "string",
"value": "Tagged"
},
{
"name": "ufb.ActiveUPSTREAM_HP",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveUPSTREAM_LP_CIR",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveUPSTREAM_LP_EIR",
"valueType": "string",
"value": "100"
},
{
"name": "ufb.CVID",
"valueType": "string",
"value": "1000"
},
{
"name": "ufb.Chorus.ChorusOrderItemIds",
"valueType": "string",
"value": "2628198"
},
{
"name": "ufb.Chorus.DisConnectRFSDateTime",
"valueType": "string",
"value": "1643270400000000000"
},
{
"name": "ufb.Chorus.ExistingProductID",
"valueType": "string",
"value": "1636029724"
},
{
"name": "ufb.Chorus.OrderId",
"valueType": "string",
"value": "100226537"
},
{
"name": "ufb.Chorus.OrderItemState",
"valueType": "string",
"value": "Acknowledged"
},
{
"name": "ufb.Chorus.OrderItemSubstate",
"valueType": "string",
"value": "Received"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "4e1f77df-f927-4fa5-9436-f47f232ebc6a"
},
{
"name": "ufb.DesiredDateTime",
"valueType": "timedate",
"value": "2022-01-27T21:00:00.000+13:00"
},
{
"name": "ufb.HandoverID",
"valueType": "string",
"value": "120695212"
},
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"name": "ufb.LFCOrderID",
"valueType": "string",
"value": "100226537"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "100725515"
},
{
"name": "ufb.OrderDate",
"valueType": "string",
"value": "1643145018000000000"
},
{
"name": "ufb.OrderType",
"valueType": "string",
"value": "Disconnect Primary"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "8a75d4ec-907a-43df-ad41-ce32d8a2ecd8"
},
{
"name": "ufb.SVID",
"valueType": "string",
"value": "1001"
},
{
"name": "ufb.ServiceProfile",
"valueType": "string",
"value": "Business 1"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": ""
}
],
"serviceSpecification": {
"id": "f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceCatalogManagement/v3/serviceSpecification/f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"name": "UFB"
},
"state": "feasibilityChecked"
},
"state": "acknowledged",
"substate": "Received"
}
],
"state": "acknowledged"
}
```
### <a>Connect Secondary</a>
1. Query Service Qualification
[goto](#Query-Service-Qualification)
2. ServiceOrder (Connect Secondary)
*url*
>POST /serviceOrdering/v4/serviceOrder
*request*
```json
{
"externalId": "TEST_CREATE_CHORUS_a528422e-26cb-47a3-af5f-843a12e5d599",
"serviceOrderItem": [
{
"id": "1",
"action": "add",
"service": {
"serviceSpecification": {
"id": "UFB"
},
"serviceCharacteristic": [
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"Name": "ufb.OrderType",
"valueType": "string",
"value": "Connect Secondary"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "102081672"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "081c6839-16fd-4b88-95c1-86189c73b81c"
},
{
"Name": "ufb.Chorus.ProductOfferingId",
"valueType": "string",
"value": "256"
},
{
"Name": "ufb.DesiredDateTime",
"valueType": "string",
"Value": "1644881032663000000"
},
{
"name": "ufb.ActiveCIRCUIT_ID_INSERTION",
"valueType": "string",
"value": "DHCP Option 82"
},
{
"Name": "ufb.ActiveUNI_TAGGING",
"valueType": "string",
"Value": "Tagged"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "6896db07-c291-4774-956b-9e43722f4109"
}
]
}
}
]
}
```
*response*
```json
{
"id": "71eab5ba-48e7-4367-a641-66a6568898a9",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceOrdering/v4/serviceOrder/71eab5ba-48e7-4367-a641-66a6568898a9",
"externalId": "TEST_CREATE_CHORUS_a528422e-26cb-47a3-af5f-843a12e5d599",
"orderDate": "2022-02-10T12:23:52.949+13:00",
"serviceOrderItem": [
{
"@type": "serviceOrderItem",
"action": "add",
"id": "1",
"service": {
"id": "18ee51bb-4909-468f-8a19-2dea281a7368",
"serviceType": "UFB",
"serviceCharacteristic": [
{
"name": "ufb.ActiveASSURANCE_L1_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveASSURANCE_L2_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveCIRCUIT_ID_INSERTION",
"valueType": "string",
"value": "DHCP Option 82"
},
{
"name": "ufb.ActiveCONNECT_RFS_DATE_TIME",
"valueType": "string",
"value": "1644861600000000000"
},
{
"name": "ufb.ActiveDATA_HANDOVER_CONNECTION_ID",
"valueType": "string",
"value": "120695030"
},
{
"name": "ufb.ActiveDOWNSTREAM_HP",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_CIR",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_EIR",
"valueType": "string",
"value": "100"
},
{
"name": "ufb.ActiveONT_ID",
"valueType": "string",
"value": "ONT009718797"
},
{
"name": "ufb.ActiveORDER_DATE",
"valueType": "string",
"value": "1644449035000000000"
},
{
"name": "ufb.ActivePlaceDescription",
"valueType": "string",
"value": "Please consult with customer."
},
{
"name": "ufb.ActivePlaceID",
"valueType": "string",
"value": "102081672"
},
{
"name": "ufb.ActiveProductProductOfferID",
"valueType": "string",
"value": "256"
},
{
"name": "ufb.ActiveProductProductOfferName",
"valueType": "string",
"value": "Evolve 100-20 S Residential"
},
{
"name": "ufb.ActiveSiteContactName",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.ActiveSiteContactPhone",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.ActiveUNI_PORT_NUMBER",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveUNI_PORT_TYPE",
"valueType": "string",
"value": "1G"
},
{
"name": "ufb.ActiveUNI_TAGGING",
"valueType": "string",
"value": "Tagged"
},
{
"name": "ufb.ActiveUPSTREAM_HP",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveUPSTREAM_LP_CIR",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveUPSTREAM_LP_EIR",
"valueType": "string",
"value": "20"
},
{
"name": "ufb.Chorus.ChorusOrderItemIds",
"valueType": "string",
"value": "2629108"
},
{
"name": "ufb.Chorus.ConnectRFSDateTime",
"valueType": "string",
"value": "1644861600000000000"
},
{
"name": "ufb.Chorus.OrderId",
"valueType": "string",
"value": "100227304"
},
{
"name": "ufb.Chorus.OrderItemState",
"valueType": "string",
"value": "Acknowledged"
},
{
"name": "ufb.Chorus.OrderItemSubstate",
"valueType": "string",
"value": "Received"
},
{
"name": "ufb.Chorus.ProductOfferingId",
"valueType": "string",
"value": "256"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "2d341abd-63ae-4c5a-afcc-5611b8fd29d6"
},
{
"name": "ufb.DesiredDateTime",
"valueType": "timedate",
"value": "2022-02-15T12:23:52.663+13:00"
},
{
"name": "ufb.HandoverID",
"valueType": "string",
"value": "120695030"
},
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"name": "ufb.LFCOrderID",
"valueType": "string",
"value": "100227304"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "102081672"
},
{
"name": "ufb.OrderDate",
"valueType": "string",
"value": "1644449035000000000"
},
{
"name": "ufb.OrderType",
"valueType": "string",
"value": "Connect Secondary"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "081c6839-16fd-4b88-95c1-86189c73b81c"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
}
],
"serviceSpecification": {
"id": "f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceCatalogManagement/v3/serviceSpecification/f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"name": "UFB"
},
"state": "feasibilityChecked"
},
"state": "acknowledged",
"substate": "Received"
}
],
"state": "acknowledged"
}
```
### <a>Disconnect Secondary</a>
1. Query Service Qualification
[goto](#Query-Service-Qualification)
2. ServiceOrder (Disconnect Primary)
*url:*
>POST /serviceOrdering/v4/serviceOrder
*request:*
```json
{
"externalId": "TEST_CREATE_CHORUS_1c8aea2c-f457-4092-b7c8-a3a529be281a",
"serviceOrderItem": [
{
"id": "1",
"action": "add",
"service": {
"serviceSpecification": {
"id": "UFB"
},
"serviceCharacteristic": [
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"Name": "ufb.OrderType",
"valueType": "string",
"value": "Disconnect Secondary"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "102331178"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "ad5c21e5-3e4c-46cc-9bc6-ff73320df12c"
},
{
"Name": "ufb.Chorus.ExistingProductID",
"valueType": "string",
"value": "1637008807"
},
{
"name": "ufb.Chorus.DisConnectRFSDateTime",
"valueType": "timedate",
"value": "1643270400000000000"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "d3693cac-1332-4edc-b645-6273fc6ef41e"
}
]
}
}
]
}
```
*response*
```json
202 Accpeted
{
"id": "43397f69-9087-419b-aac6-fee04a7b96e6",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceOrdering/v4/serviceOrder/43397f69-9087-419b-aac6-fee04a7b96e6",
"externalId": "TEST_CREATE_CHORUS_1c8aea2c-f457-4092-b7c8-a3a529be281a",
"orderDate": "2022-01-26T10:17:51.178+13:00",
"serviceOrderItem": [
{
"@type": "serviceOrderItem",
"action": "add",
"id": "1",
"service": {
"id": "1545a297-b760-4137-9aa4-656bb71b75a4",
"serviceType": "UFB",
"serviceCharacteristic": [
{
"name": "ufb.ActiveASSURANCE_L1_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveASSURANCE_L2_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveBITSTREAM_UID_1",
"valueType": "string",
"value": "1637008807B01"
},
{
"name": "ufb.ActiveCIRCUIT_ID_INSERTION",
"valueType": "string",
"value": "DHCP Option 82"
},
{
"name": "ufb.ActiveDATA_HANDOVER_CONNECTION_ID",
"valueType": "string",
"value": "120695030"
},
{
"name": "ufb.ActiveDATA_VLAN_CVID",
"valueType": "string",
"value": "1000"
},
{
"name": "ufb.ActiveDATA_VLAN_SVID",
"valueType": "string",
"value": "1001"
},
{
"name": "ufb.ActiveDISCONNECT_RFS_DATE_TIME",
"valueType": "string",
"value": "1643270400000000000"
},
{
"name": "ufb.ActiveDOWNSTREAM_HP",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_CIR",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_EIR",
"valueType": "string",
"value": "100"
},
{
"name": "ufb.ActiveONT_ID",
"valueType": "string",
"value": "ONT006356887"
},
{
"name": "ufb.ActiveORDER_DATE",
"valueType": "string",
"value": "1643145473000000000"
},
{
"name": "ufb.ActivePlaceDescription",
"valueType": "string",
"value": "Please consult with customer."
},
{
"name": "ufb.ActivePlaceID",
"valueType": "string",
"value": "102331178"
},
{
"name": "ufb.ActiveProductID",
"valueType": "string",
"value": "1637008807"
},
{
"name": "ufb.ActiveProductProductOfferID",
"valueType": "string",
"value": "256"
},
{
"name": "ufb.ActiveProductProductOfferName",
"valueType": "string",
"value": "Evolve 100-20 S Residential"
},
{
"name": "ufb.ActiveSiteContactName",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.ActiveSiteContactPhone",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.ActiveUNI_PORT_NUMBER",
"valueType": "string",
"value": "1"
},
{
"name": "ufb.ActiveUNI_PORT_TYPE",
"valueType": "string",
"value": "1G"
},
{
"name": "ufb.ActiveUNI_TAGGING",
"valueType": "string",
"value": "Tagged"
},
{
"name": "ufb.ActiveUPSTREAM_HP",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveUPSTREAM_LP_CIR",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveUPSTREAM_LP_EIR",
"valueType": "string",
"value": "20"
},
{
"name": "ufb.CVID",
"valueType": "string",
"value": "1000"
},
{
"name": "ufb.Chorus.ChorusOrderItemIds",
"valueType": "string",
"value": "2628201"
},
{
"name": "ufb.Chorus.DisConnectRFSDateTime",
"valueType": "string",
"value": "1643270400000000000"
},
{
"name": "ufb.Chorus.ExistingProductID",
"valueType": "string",
"value": "1637008807"
},
{
"name": "ufb.Chorus.OrderId",
"valueType": "string",
"value": "100226540"
},
{
"name": "ufb.Chorus.OrderItemState",
"valueType": "string",
"value": "Acknowledged"
},
{
"name": "ufb.Chorus.OrderItemSubstate",
"valueType": "string",
"value": "Received"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "50fc3ae7-d902-48c2-895c-8dc15a0e2e3c"
},
{
"name": "ufb.HandoverID",
"valueType": "string",
"value": "120695030"
},
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"name": "ufb.LFCOrderID",
"valueType": "string",
"value": "100226540"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "102331178"
},
{
"name": "ufb.OrderDate",
"valueType": "string",
"value": "1643145473000000000"
},
{
"name": "ufb.OrderType",
"valueType": "string",
"value": "Disconnect Secondary"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "ad5c21e5-3e4c-46cc-9bc6-ff73320df12c"
},
{
"name": "ufb.SVID",
"valueType": "string",
"value": "1001"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
}
],
"serviceSpecification": {
"id": "f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceCatalogManagement/v3/serviceSpecification/f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"name": "UFB"
},
"state": "feasibilityChecked"
},
"state": "acknowledged",
"substate": "Received"
}
],
"state": "acknowledged"
}
```
### <a>Change Offer</a>
1. Query Service Qualification
[goto](#Query-Service-Qualification)
2. ServiceOrder (Change Offer)
*url*
>POST /serviceOrdering/v4/serviceOrder
*request*
```json
{
"externalId": "TEST_CREATE_CHORUS_SOME_RANDOM_ID",
"serviceOrderItem": [
{
"id": "1",
"action": "add",
"service": {
"serviceSpecification": {
"id": "UFB"
},
"serviceCharacteristic": [
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "bb57c0aa-6e6b-4256-a65b-1454f352223b"
},
{
"Name": "ufb.OrderType",
"valueType": "string",
"value": "Change Offer"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "100712727"
},
{
"Name": "ufb.Chorus.ExistingProductID",
"valueType": "string",
"Value": "1637005997"
},
{
"Name": "ufb.Chorus.ProductOfferingId",
"valueType": "string",
"value": "136"
},
{
"Name": "ufb.Chorus.ConnectRFSDateTime",
"valueType": "string",
"Value": "1643270400000000000"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "f449e830-d863-49ca-b481-70ff0f6d962a"
}
]
}
}
]
}
```
*response*
```json
202 Accepted
{
"id": "3107e777-0fc5-4f9a-a613-68a40705751a",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceOrdering/v4/serviceOrder/3107e777-0fc5-4f9a-a613-68a40705751a",
"externalId": "TEST_CREATE_CHORUS_1ad68df3-6a45-447e-ba8a-47b9ebcc45a4",
"orderDate": "2022-01-26T11:15:07.727+13:00",
"serviceOrderItem": [
{
"@type": "serviceOrderItem",
"action": "add",
"id": "1",
"service": {
"id": "73f7278c-a42a-406f-abe6-f884dc862385",
"serviceType": "UFB",
"serviceCharacteristic": [
{
"name": "ufb.ActiveASSURANCE_L1_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveASSURANCE_L2_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveBITSTREAM_UID_1",
"valueType": "string",
"value": "1637005997B01"
},
{
"name": "ufb.ActiveCIRCUIT_ID_INSERTION",
"valueType": "string",
"value": "DHCP Option 82"
},
{
"name": "ufb.ActiveCONNECT_RFS_DATE_TIME",
"valueType": "string",
"value": "1643270400000000000"
},
{
"name": "ufb.ActiveDATA_HANDOVER_CONNECTION_ID",
"valueType": "string",
"value": "120695212"
},
{
"name": "ufb.ActiveDATA_VLAN_CVID",
"valueType": "string",
"value": "1000"
},
{
"name": "ufb.ActiveDATA_VLAN_SVID",
"valueType": "string",
"value": "1001"
},
{
"name": "ufb.ActiveDOWNSTREAM_HP",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_CIR",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_EIR",
"valueType": "string",
"value": "30"
},
{
"name": "ufb.ActiveONT_ID",
"valueType": "string",
"value": "ONT020002269"
},
{
"name": "ufb.ActiveONT_MODE",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveORDER_DATE",
"valueType": "string",
"value": "1643148916000000000"
},
{
"name": "ufb.ActivePlaceDescription",
"valueType": "string",
"value": "Please consult with customer. Please consult with customer."
},
{
"name": "ufb.ActivePlaceID",
"valueType": "string",
"value": "100712727"
},
{
"name": "ufb.ActiveProductID",
"valueType": "string",
"value": "1637005997"
},
{
"name": "ufb.ActiveProductProductOfferID",
"valueType": "string",
"value": "136"
},
{
"name": "ufb.ActiveProductProductOfferName",
"valueType": "string",
"value": "vf Private 100-20-2.5-2.5"
},
{
"name": "ufb.ActiveSiteContactName",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.ActiveSiteContactPhone",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.ActiveUNI_PORT_NUMBER",
"valueType": "string",
"value": "1"
},
{
"name": "ufb.ActiveUNI_PORT_TYPE",
"valueType": "string",
"value": "1G"
},
{
"name": "ufb.ActiveUNI_TAGGING",
"valueType": "string",
"value": "Tagged"
},
{
"name": "ufb.ActiveUPSTREAM_HP",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveUPSTREAM_LP_CIR",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveUPSTREAM_LP_EIR",
"valueType": "string",
"value": "10"
},
{
"name": "ufb.CVID",
"valueType": "string",
"value": "1000"
},
{
"name": "ufb.Chorus.ChorusOrderItemIds",
"valueType": "string",
"value": "2628206"
},
{
"name": "ufb.Chorus.ConnectRFSDateTime",
"valueType": "string",
"value": "1643270400000000000"
},
{
"name": "ufb.Chorus.ExistingProductID",
"valueType": "string",
"value": "1637005997"
},
{
"name": "ufb.Chorus.OrderId",
"valueType": "string",
"value": "100226544"
},
{
"name": "ufb.Chorus.OrderItemState",
"valueType": "string",
"value": "Acknowledged"
},
{
"name": "ufb.Chorus.OrderItemSubstate",
"valueType": "string",
"value": "Received"
},
{
"name": "ufb.Chorus.ProductOfferingId",
"valueType": "string",
"value": "27"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "f449e830-d863-49ca-b481-70ff0f6d962a"
},
{
"name": "ufb.HandoverID",
"valueType": "string",
"value": "120695212"
},
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"name": "ufb.LFCOrderID",
"valueType": "string",
"value": "100226544"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "100712727"
},
{
"name": "ufb.OrderDate",
"valueType": "string",
"value": "1643148916000000000"
},
{
"name": "ufb.OrderType",
"valueType": "string",
"value": "Change Offer"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "bb57c0aa-6e6b-4256-a65b-1454f352223b"
},
{
"name": "ufb.SVID",
"valueType": "string",
"value": "1001"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
}
],
"serviceSpecification": {
"id": "f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceCatalogManagement/v3/serviceSpecification/f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"name": "UFB"
},
"state": "feasibilityChecked"
},
"state": "acknowledged",
"substate": "Received"
}
],
"state": "acknowledged"
}
```
### <a>Modify Attribute</a>
1. Query Service Qualification
[goto](#Query-Service-Qualification)
2. ServiceOrder (Modify Attribute)
*url*
>/serviceOrdering/v4/serviceOrder
*request*
```json
{
"externalId": "TEST_CREATE_CHORUS_f4a14023-2289-46ee-a1ec-538a18d6af9d",
"serviceOrderItem": [
{
"id": "1",
"action": "add",
"service": {
"serviceSpecification": {
"id": "UFB"
},
"serviceCharacteristic": [
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"Name": "ufb.Chorus.ExistingProductID",
"valueType": "string",
"Value": "1637008632"
},
{
"Name": "ufb.OrderType",
"valueType": "string",
"value": "Modify Attribute"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "e4fd4513-30a8-44f7-a831-c92054e21400"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "100734602"
},
{
"Name": "ufb.Chorus.ConnectRFSDateTime",
"valueType": "string",
"Value": "1643158800000000000"
},
{
"Name": "ufb.ActiveCIRCUIT_ID_INSERTION",
"valueType": "string",
"Value": "OFF"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "20e43dcb-1248-476e-b575-c1990c729370"
}
]
}
}
]
}
```
*response*
```json
202 Accepted
{
"id": "6c81250f-e672-4b1d-b902-d2f0bc6b06f6",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceOrdering/v4/serviceOrder/6c81250f-e672-4b1d-b902-d2f0bc6b06f6",
"externalId": "TEST_CREATE_CHORUS_f4a14023-2289-46ee-a1ec-538a18d6af9d",
"orderDate": "2022-01-26T10:07:59.701+13:00",
"serviceOrderItem": [
{
"@type": "serviceOrderItem",
"action": "add",
"id": "1",
"service": {
"id": "4d446975-452f-4c63-91b5-b7b9d3013e58",
"serviceType": "UFB",
"serviceCharacteristic": [
{
"name": "ufb.ActiveASSURANCE_L1_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveASSURANCE_L2_SLA_LEVEL",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveBITSTREAM_UID_1",
"valueType": "string",
"value": "1637008632B01"
},
{
"name": "ufb.ActiveCIRCUIT_ID_INSERTION",
"valueType": "string",
"value": "OFF"
},
{
"name": "ufb.ActiveCONNECT_RFS_DATE_TIME",
"valueType": "string",
"value": "1643158800000000000"
},
{
"name": "ufb.ActiveDATA_HANDOVER_CONNECTION_ID",
"valueType": "string",
"value": "120695212"
},
{
"name": "ufb.ActiveDATA_VLAN_CVID",
"valueType": "string",
"value": "1000"
},
{
"name": "ufb.ActiveDATA_VLAN_SVID",
"valueType": "string",
"value": "1001"
},
{
"name": "ufb.ActiveDOWNSTREAM_HP",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_CIR",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveDOWNSTREAM_LP_EIR",
"valueType": "string",
"value": "30"
},
{
"name": "ufb.ActiveONT_ID",
"valueType": "string",
"value": "ONT020005234"
},
{
"name": "ufb.ActiveONT_MODE",
"valueType": "string",
"value": "Standard"
},
{
"name": "ufb.ActiveORDER_DATE",
"valueType": "string",
"value": "1643144887000000000"
},
{
"name": "ufb.ActivePlaceDescription",
"valueType": "string",
"value": "Please consult with customer."
},
{
"name": "ufb.ActivePlaceID",
"valueType": "string",
"value": "100734602"
},
{
"name": "ufb.ActiveProductID",
"valueType": "string",
"value": "1637008632"
},
{
"name": "ufb.ActiveProductProductOfferID",
"valueType": "string",
"value": "27"
},
{
"name": "ufb.ActiveProductProductOfferName",
"valueType": "string",
"value": "Evolve 1 Residential"
},
{
"name": "ufb.ActiveSiteContactName",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.ActiveSiteContactPhone",
"valueType": "string",
"value": "0211605174"
},
{
"name": "ufb.ActiveUNI_PORT_NUMBER",
"valueType": "string",
"value": "1"
},
{
"name": "ufb.ActiveUNI_PORT_TYPE",
"valueType": "string",
"value": "1G"
},
{
"name": "ufb.ActiveUNI_TAGGING",
"valueType": "string",
"value": "Tagged"
},
{
"name": "ufb.ActiveUPSTREAM_HP",
"valueType": "string",
"value": "2.5"
},
{
"name": "ufb.ActiveUPSTREAM_LP_CIR",
"valueType": "string",
"value": "0"
},
{
"name": "ufb.ActiveUPSTREAM_LP_EIR",
"valueType": "string",
"value": "10"
},
{
"name": "ufb.CVID",
"valueType": "string",
"value": "1000"
},
{
"name": "ufb.Chorus.ChorusOrderItemIds",
"valueType": "string",
"value": "2628197"
},
{
"name": "ufb.Chorus.ConnectRFSDateTime",
"valueType": "string",
"value": "1643158800000000000"
},
{
"name": "ufb.Chorus.ExistingProductID",
"valueType": "string",
"value": "1637008632"
},
{
"name": "ufb.Chorus.OrderId",
"valueType": "string",
"value": "100226536"
},
{
"name": "ufb.Chorus.OrderItemState",
"valueType": "string",
"value": "Acknowledged"
},
{
"name": "ufb.Chorus.OrderItemSubstate",
"valueType": "string",
"value": "Received"
},
{
"name": "ufb.CustomerReference",
"valueType": "string",
"value": "20e43dcb-1248-476e-b575-c1990c729370"
},
{
"name": "ufb.HandoverID",
"valueType": "string",
"value": "120695212"
},
{
"name": "ufb.LFC",
"valueType": "string",
"value": "6"
},
{
"name": "ufb.LFCOrderID",
"valueType": "string",
"value": "100226536"
},
{
"name": "ufb.LocationID",
"valueType": "string",
"value": "100734602"
},
{
"name": "ufb.OrderDate",
"valueType": "string",
"value": "1643144887000000000"
},
{
"name": "ufb.OrderType",
"valueType": "string",
"value": "Modify Attribute"
},
{
"name": "ufb.PrequalUUID",
"valueType": "string",
"value": "e4fd4513-30a8-44f7-a831-c92054e21400"
},
{
"name": "ufb.SVID",
"valueType": "string",
"value": "1001"
},
{
"name": "ufb.contact.Name",
"valueType": "string",
"value": "Lebron James"
},
{
"name": "ufb.contact.PhoneNumber",
"valueType": "string",
"value": "0211605174"
}
],
"serviceSpecification": {
"id": "f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"href": "https://tmf.pp.naas.vodafone.co.nz/tmf-api/serviceCatalogManagement/v3/serviceSpecification/f538ee29-624e-4de7-84e7-afc7d1ae30f1",
"name": "UFB"
},
"state": "feasibilityChecked"
},
"state": "acknowledged",
"substate": "Received"
}
],
"state": "acknowledged"
}
```