Agreements

You must agree to the Specific Terms for API Use before using the Console Connect API. If you are using the Console Connect web application, you must also agree to the PCCW Global Terms of Service. To view agreement information via API, you will need your companyId, which can be retrieved through the Company API.

Get Agreements

Get the agreements your company has agreed to.

Request
path Parameters
companyId
required
string

The ObjectId of your company.

header Parameters
portal-token
required
string

Authentication token.

Responses
200

OK

get/app-user/{companyId}/agreements
Response samples
application/json
[
  • {
    }
]

Accept an Agreement

This API is used by the Console Connect Web application to record acceptance of agreements through the UI. API users must sign the Specific Terms for API Use.

Request
path Parameters
companyId
required
string

The ObjectId of your company.

header Parameters
portal-token
required
string

Authentication token.

Request Body schema: application/json

The agreement metadata.

id
string

An ObjectId used to lookup the Agreement.

companyId
string

The ObjectId of the Company that has accepted the Agreement.

userId
string

The ObjectId of the User that has accepted the Agreement on behalf of the Company.

version
string

The version number of the agreement being. accepted

date
string

The current date that the agreement is being accepted on.

type
string

The type of agreement. Corresponds to a product's set of apis.

Enum: "CONSOLE_PORT_SERVICE_TERMS" "L2_CONNECTION" "CONSOLE_CLOUDROUTER_SPECIFIC_TERMS" "GIA_SERVICE"
Responses
200

Successfully accepted the agreement.

post/app-user/{companyId}/agreements
Request samples
application/json
{
  • "id": "507f1f77bcf86cd799439011",
  • "companyId": "string",
  • "userId": "string",
  • "version": 1.2,
  • "date": "2022-08-24T05:10:59.418Z",
  • "type": "CONSOLE_PORT_SERVICE_TERMS"
}
Response samples
application/json
{
  • "id": "507f1f77bcf86cd799439011",
  • "version": "1.0,",
  • "date": "2022-08-24T05:10:59.418Z",
  • "type": "CONSOLE_PORT_SERVICE_TERMS",
  • "companyId": "507f191e810c19729de860ea"
}