Cocon Fiber Transactional API (v1)

Download OpenAPI specification:Download

The Cocon Fiber Transactional API provides asset management functionality.

Contact

Create a contact

Authorizations:

Api-Key-HeaderClient-Id-Header

Request Body schema: application/json

name	string or null Name of the contact
customerId	string or null Id of the customer the contact belongs to
isPrimaryContact	boolean Indicates whether the contact is the primary contact
phoneNumber	string or null Phone number of the contact
emailAddresses	Array of strings or null Email address(es) of the contact

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"customerId": "string",
"isPrimaryContact": true,
"phoneNumber": "string",
"emailAddresses": ["string"
]
}

Response samples

200
400
401
403
500

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"isPrimaryContact": true,
"phoneNumber": "string",
"emailAddresses": ["string"
]
}

Update a contact

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Request Body schema: application/merge-patch+json

name	string or null Name of the contact
isPrimaryContact	boolean Indicates whether the contact is the primary contact
phoneNumber	string or null Phone number of the contact
emailAddresses	Array of strings or null Email address(es) of the contact

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"name": "string",
"isPrimaryContact": true,
"phoneNumber": "string",
"emailAddresses": ["string"
]
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"isPrimaryContact": true,
"phoneNumber": "string",
"emailAddresses": ["string"
]
}

Delete a contact

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"timestamp": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": 0,
"errors": [{"code": "string",
"message": "string"
}
],
"message": "string"
}

Get contacts by customer id and contact id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

contactId

required

string

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"isPrimaryContact": true,
"phoneNumber": "string",
"emailAddresses": ["string"
]
}

Get contacts by customer id and contact id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id required	string Example: 10 or 1abc Unique identifier
contactId required	string The id of the contact to retrieve

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"isPrimaryContact": true,
"phoneNumber": "string",
"emailAddresses": ["string"
]
}

Customer

Create a customer

Authorizations:

Api-Key-HeaderClient-Id-Header

Request Body schema: application/json

clientCode	string or null Client code of the customer
name	string or null Name of the customer
	object (PostalAddress)
	object (OutageContactInformation)
	object or null Only accepts the following key: ExternalReference

Responses

Request samples

Payload

Content type

application/json

{"clientCode": "string",
"name": "string",
"postalAddress": {"street": "string",
"houseNumber": "string",
"zipCode": "string",
"city": "string",
"country": "string"
},
"outageContactInformation": {"emailAddresses": ["string"
],
"phoneNumber": "string"
},
"additionalInformation": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
401
403
500

Content type

application/json

{"id": "string",
"name": "string",
"postalAddress": "string",
"emailAddresses": ["string"
],
"phoneNumber": "string",
"additionalInformation": {"property1": "string",
"property2": "string"
}
}

Get customers by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"postalAddress": "string",
"emailAddresses": ["string"
],
"phoneNumber": "string",
"additionalInformation": {"property1": "string",
"property2": "string"
}
}

Update a customer

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Request Body schema: application/merge-patch+json

The customer to update

clientCode	string or null Client code of the customer
name	string or null Name of the customer
	object (PostalAddress)
	object (OutageContactInformation)
	object or null Only accepts the following key: ExternalReference

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"clientCode": "string",
"name": "string",
"postalAddress": {"street": "string",
"houseNumber": "string",
"zipCode": "string",
"city": "string",
"country": "string"
},
"outageContactInformation": {"emailAddresses": ["string"
],
"phoneNumber": "string"
},
"additionalInformation": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"postalAddress": "string",
"emailAddresses": ["string"
],
"phoneNumber": "string",
"additionalInformation": {"property1": "string",
"property2": "string"
}
}

Delete a customer

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"timestamp": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": 0,
"errors": [{"code": "string",
"message": "string"
}
],
"message": "string"
}

Get contacts by customer id and contact id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

contactId

required

string

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"isPrimaryContact": true,
"phoneNumber": "string",
"emailAddresses": ["string"
]
}

Get contacts by customer id and contact id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id required	string Example: 10 or 1abc Unique identifier
contactId required	string The id of the contact to retrieve

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"isPrimaryContact": true,
"phoneNumber": "string",
"emailAddresses": ["string"
]
}

Customer contract

Create a customer contract

Authorizations:

Api-Key-HeaderClient-Id-Header

Request Body schema: application/json

name	string or null Name of the customer contract
customerId	string or null Id of the customer the contract is related to
contactIds	Array of strings or null The ids of the contacts realted to this contract
startDate	string or null <date> The start date of the contract
endDate	string <date> The end date of the contract
owner	string or null The owner of the contract
comment	string or null Comment
other	string or null Other information
servicePriority	string or null The priority of this service
allowDivergentPriority	boolean Allow the priority of the provided service to divert from its set priority
contractTypeName	string or null Name of the type of the contract

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"customerId": "string",
"contactIds": ["string"
],
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"owner": "string",
"comment": "string",
"other": "string",
"servicePriority": "string",
"allowDivergentPriority": true,
"contractTypeName": "string"
}

Response samples

200
400
401
403
500

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"owner": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"remarks": "string",
"additionalInformation": "string",
"contacts": [{"id": "string",
"href": "string"
}
]
}

Get a customer contract by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"owner": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"remarks": "string",
"additionalInformation": "string",
"contacts": [{"id": "string",
"href": "string"
}
]
}

Update a customer contract

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Request Body schema: application/merge-patch+json

name	string or null Name of the customer contract
contactIds	Array of strings or null The ids of the contects realted to this contract
startDate	string or null <date> The start date of the contract
endDate	string <date> The end date of the contract
owner	string or null The owner of the contract
comment	string or null Comment
other	string or null Other information
allowDivergentPriority	boolean Allow the priority of the provided service to divert from its set priority
contractTypeName	string or null Name of the type of the contract

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"name": "string",
"contactIds": ["string"
],
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"owner": "string",
"comment": "string",
"other": "string",
"allowDivergentPriority": true,
"contractTypeName": "string"
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"customerName": "string",
"owner": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"remarks": "string",
"additionalInformation": "string",
"contacts": [{"id": "string",
"href": "string"
}
]
}

Delete a customer contract

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

400
401
403
404
500

Content type

application/json

{"timestamp": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": 0,
"errors": [{"code": "string",
"message": "string"
}
],
"message": "string"
}

Delayed connection

Create a delayed connection for a building

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Request Body schema: application/json

frameName	string or null Short name of the frame
terminationUnitType	string or null Name of the fiber termination unit type that is placed in the frame
attenuation1	number <double> First attenuation
attenuation2	number <double> Second attenuation
installationCompanyName	string or null Name of the installation company
	object (LineString) GeoJSon geometry https://tools.ietf.org/html/rfc7946#section-3
isWithoutGeometry	boolean Specifies that the newRoute value is intentionally omitted

Responses

Request samples

Payload

Content type

application/json

{"frameName": "string",
"terminationUnitType": "string",
"attenuation1": 0.1,
"attenuation2": 0.1,
"installationCompanyName": "string",
"newRoute": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
},
"isWithoutGeometry": true
}

Response samples

Content type

application/json

{"buildingId": "string",
"cableId": "string",
"frameId": "string",
"patchPosition1Id": "string",
"patchPosition2Id": "string"
}

Create a delayed connection

Authorizations:

Api-Key-HeaderClient-Id-Header

Request Body schema: application/json

frameName	string or null Name of the frame
terminationUnitType	string or null Name of the fiber termination unit type that is placed in the frame
attenuation1	number <double> First attenuation
attenuation2	number <double> Second attenuation
installationCompanyName	string or null Name of the installation company
	object (LineString) GeoJSon geometry https://tools.ietf.org/html/rfc7946#section-3
isWithoutGeometry	boolean Specifies that the newRoute value is intentionally omitted
buildingName	string or null Building name

Responses

Request samples

Payload

Content type

application/json

{"frameName": "string",
"terminationUnitType": "string",
"attenuation1": 0.1,
"attenuation2": 0.1,
"installationCompanyName": "string",
"newRoute": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
},
"isWithoutGeometry": true,
"buildingName": "string"
}

Response samples

Content type

application/json

{"buildingId": "string",
"cableId": "string",
"frameId": "string",
"patchPosition1Id": "string",
"patchPosition2Id": "string"
}

Get status details for a delayed connections batch operation

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"batchId": "string",
"status": "string",
"success": [{"buildingName": "string",
"details": {"buildingId": "string",
"cableId": "string",
"frameId": "string",
"patchPosition1Id": "string",
"patchPosition2Id": "string"
}
}
],
"failure": [{"buildingName": "string",
"errors": [{"timestamp": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": 0,
"errors": [{"code": "string",
"message": "string"
}
],
"message": "string"
}
]
}
],
"pending": [{"buildingName": "string"
}
]
}

Register a batch to create multiple delayed connections

Authorizations:

Api-Key-HeaderClient-Id-Header

Request Body schema: application/json

installationCompanyName	string or null Installation company that applies to all jobs in the batch
	Array of objects or null (DelayedConnectionRequestShort) Batch of delayed connections

Responses

Request samples

Payload

Content type

application/json

{"installationCompanyName": "string",
"delayedConnections": [{"buildingName": "string",
"frameName": "string",
"terminationUnitType": "string",
"attenuation1": 0.1,
"attenuation2": 0.1,
"newRoute": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
},
"isWithoutGeometry": true
}
]
}

Response samples

200
400
401
403
500

Content type

application/json

{"batchId": "string"
}

Project asset approval

Create a project asset approval

Authorizations:

Api-Key-HeaderClient-Id-Header

Request Body schema: application/json

projectName	string or null Name of the project this asset is part of and approved for
timestamp	string <date-time> Date and time of the moment of approval
approver	string or null Name of the original approver
	object (AssetApproval)

Responses

Request samples

Payload

Content type

application/json

{"projectName": "string",
"timestamp": "2019-08-24T14:15:22Z",
"approver": "string",
"assetApproval": {"asset": {"type": "Building",
"name": "string"
},
"installationCompany": "string",
"type": "Photo",
"author": "string"
}
}

Response samples

400
401
403
500

Content type

application/json

{"timestamp": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": 0,
"errors": [{"code": "string",
"message": "string"
}
],
"message": "string"
}