Items on ~.UcClient.~ Unified Communications

Get Item

Mon, 01 Jan 0001 00:00:00 +0000

Get Item #

Gets a specific directory item.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Example #

This request will get a specific item from a directory us its id.

Request #

GET https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123 HTTP/1.1
Authorization: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
	"page_size": 1,
	"data":  [{
            "id": "00000000-0000-0000-0000-000000000123",
            "fields": {
                "title": "Mr",
                "fullName": "CRM2",
                "companyName": "Company",
                "jobTitle": "Job Title",
                "phone1": "+44XXXXXXXXXX",
                "email": "Email Address",
                "field1": "field1",
                "field2": "field2",
                "crmId": "00000000-0000-0000-0000-000000000001"
            }
        }
    ],
	"status": "success",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Errors #

Unauthorized #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorized

Get Items

Mon, 01 Jan 0001 00:00:00 +0000

Get Items #

Gets any directory items matching the supplied filter.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items?filter={FILTER}&fields={FIELDS}

warning
Remember to URL Encode any parameters being passed in the 'filter' parameter.

note
When searching on 'phoneX' fields, the numbers are stored in E.164 format.

Example #

This request will query all items with a phone field containing +44XXXXXXXXXX

Create Item

Mon, 01 Jan 0001 00:00:00 +0000

Create Item #

Creates a new directory item in the supplied directory.

POST /v1.0/contactdirectories/{DIRECTORY_ID}/items

Example #

This request will create a new directory item.

Request #

POST https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items HTTP/1.1
Content-Type: application/json
accept-charges: true
Authorization: Bearer {TOKEN}
Connection: keep-alive
{
	"fields": {
        "title": "Mr",
        "fullName": "CRM3a",
        "companyName": "Company",
        "jobTitle": "Job Title",
        "phone1": "+44XXXXXXXXXX",
        "email": "Email Address",
        "field1": "field1",
        "field2": "field2",
        "crmId": "00000000-0000-0000-0000-000000000001"
    }
}

Response #

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Content-Length: xx
Location: https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items
{
	"data": {
        "id": "00000000-0000-0000-0000-000000000123",
        "fields": {
            "title": "Mr",
            "fullName": "CRM3a",
            "companyName": "Company",
            "jobTitle": "Job Title",
            "phone1": "+44XXXXXXXXXX",
            "email": "Email Address",
            "field1": "field1",
            "field2": "field2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "success",
	"timestamp": "2019-11-29T16:03:23.9251680Z"
}

Errors #

Unauthorized #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorized

Replace Item

Mon, 01 Jan 0001 00:00:00 +0000

Replace Item #

Replaces and existing directory item.

PUT /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Example #

This request will update an existing directory item.

Request #

PUT https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123 HTTP/1.1
Content-Type: application/json
accept-charges: true
Authorization: Bearer {TOKEN}
Connection: keep-alive
{
    "fields": {
        "title": "Mr",
        "fullName": "CRM3a",
        "companyName": "Company",
        "jobTitle": "Job Title",
        "phone1": "+44XXXXXXXXXX",
        "email": "Email Address",
        "field1": "field1",
        "field2": "field2",
        "crmId": "00000000-0000-0000-0000-000000000001"
    }
}

Response #

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Content-Length: xx
Location: https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123
{
	"data": {
        "id": "00000000-0000-0000-0000-000000000123",
        "fields": {
            "title": "Mr",
            "fullName": "CRM3a",
            "companyName": "Company",
            "jobTitle": "Job Title",
            "phone1": "+44XXXXXXXXXX",
            "email": "Email Address",
            "field1": "field1",
            "field2": "field2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "success",
	"timestamp": "2019-11-29T16:03:23.9251680Z"
}

Errors #

Unauthorized #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorized

Patch Item

Mon, 01 Jan 0001 00:00:00 +0000

Patch Item #

Updates a specific set of properties of a directory item. This uses the JSON Patch format for any changes.

PATCH /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Example #

This request will add anew phone field to an existing directory item.

Request #

PATCH https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123 HTTP/1.1
Content-Type: application/json
accept-charges: true
Authorization: Bearer {TOKEN}
Connection: keep-alive
{
    "path": "/fields/phone2",
    "op": "add",
    "value": "+44YYYYYYYYYY"
}

Response #

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
Content-Length: xx
Location: https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123
{
	"data": {
        "id": "00000000-0000-0000-0000-000000000123",
        "fields": {
            "title": "Mr",
            "fullName": "CRM3a",
            "companyName": "Company",
            "jobTitle": "Job Title",
            "phone1": "+44XXXXXXXXXX",
            "phone2": "+44YYYYYYYYYY",
            "email": "Email Address",
            "field1": "field1",
            "field2": "field2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "success",
	"timestamp": "2019-11-29T16:03:23.9251680Z"
}

Errors #

Unauthorized #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorized

Delete Item

Mon, 01 Jan 0001 00:00:00 +0000

Delete Item #

Deletes an existing item from a directory.

Request #

DELETE /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Example #

This request will delete the specific item within the directory.

Request #

DELETE https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123 HTTP/1.1
Authorization: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
	"data": {
        "id": "00000000-0000-0000-0000-000000000123",
        "fields": {
            "title": "Mr",
            "fullName": "CRM3a",
            "companyName": "Company",
            "jobTitle": "Job Title",
            "phone1": "+44XXXXXXXXXX",
            "email": "Email Address",
            "field1": "field1",
            "field2": "field2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "success",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Errors #

Unauthorized #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorized