logo
API docs by Redocly

Communications (2.17)

Download OpenAPI specification:Download

Communications Concepts

The Communications API is a restful web service which allows end developers a way to integrate with IDI Billing Solutions communication infrastruture.

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the communications system is up and running.

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "systemHealthy": true,
  • "componentsStatus": "AllComponentsOK",
  • "components": [
    ]
}

Archive

Archive Messages

Archives the bodies of messages. Message bodies that have been archived are no longer searchable [1.21]

Note

  • If linkType and linkRefernceID are provided, all messages for the referenced object will be archived and the contents of their message bodies will no longer be searchable.
  • If messageDateStart and messageDateEnd are provided, all unlinked messages between those dates will be archived and the contents of their message bodies will no longer be searchable.
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
linkReferenceID
integer

Unique identifier for the referenced object.

Note:

  • If linkReferenceID is provied, linkType must also be provided.
linkType
integer

The type of the referenced object.

Note:

  • If linkType is provied, linkReferenceID must also be provided.
messgeDateEnd
string <datetime>

The end date for which unlinked messages will be archived for

Note:

  • If messageDateStart is provied, messageDateEnd must also be provided.
  • If both messageDateEnd and linkType or linkReferenceID are provided, messageDateEnd will be ignored
messgeDateStart
string <datetime>

The start date for which unlinked messages will be archived for.

Note:

  • If messageDateEnd is provied, messageDateStart must also be provided.
  • If both messageDateStart and linkType or linkReferenceID are sent, messageDateStart will be ignored

Responses

Request samples

Content type
application/json
{
  • "linkReferenceID": 1,
  • "linkType": "ticket",
  • "messgeDateEnd": "2016-09-09T21:35:09.000Z",
  • "messgeDateStart": "2016-09-09T19:35:09.000Z"
}

Response samples

Content type
application/json
{
  • "hasMoreResults": true,
  • "messagesArchived": 7
}

Bounce

Search Bounces

Searches the list of Bounced email addresses. [Rev 1.20]

Authorizations:
SWT
query Parameters
email
string
Example: email=IDI@example.com

The Email address or part of the email address for the search to filter on.

NOTE:

Email must be at least 3 characters and at most 255 characters

endDate
string <date-time>
Example: endDate=2019-05-01T18:00:00.000Z

The ending date and time from which the the results will be filtered to.

top
integer
Example: top=1

The number of results to retrieve.

skip
integer
Example: skip=1

The number of results to skip.

startDate
string <date-time>
Example: startDate=2019-05-01T14:00:00.0000-04:00

The starting date and time from which the the results will be filtered to.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@odata.firstLink": "https://comms.idibilling.com/comm/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "@odata.lastLink": "https://comms.idibilling.com/comm/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "@odata.nextLink": "https://comms.idibilling.com/comm/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "@odata.previousLink": "https://comms.idibilling.com/comm/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Delete Bounce

Delete the provided list of Bounced email addresses. [Rev 1.20]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array of objects (DeleteBounceEmail)

List of email addresses to remove from the bounce list.

deleteAll
boolean

When set to True all bounced emails will be deleted. The provided email list is ignored.

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "deleteAll": true
}

Company

Companies must be added to Communications before messages can be sent from their environment(s). Each company is allowed a single domain configuration which will allow for the sending and receiving of messages. Each domain object will contain entries which must be created with the appropriate hosting provider in order for them to validated. Domains must be validated before they can be used to send and receiving messages.

Create Company

Provides the ability to create company.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
companyID
required
integer

The unique identifier for the company.

companyName
required
string

Name of the company that this domain information is associated with.

createDate
string <datetime>

Date the company was created

createUser
string

User that created the company.

required
Array of objects (DomainInfo)

List of domains configured in communications for this company.

primaryEnvironment
required
string

Name of the primary environment to be used by this Company in Communications.

Responses

Request samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T19:00:00.000Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T14:00:00.156Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Retrieve Company

Provides the ability to retrieve the company configuration.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Id of Company to retrieve.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T14:00:00.156Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Delete Company

Delete a company configuration.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Id of Company to delete.

Responses

Update Company

Provides the ability to update properties of a company. This operation uses the JSON Patch document structure for defining updates to the company objects. Read more about JSON Patch (RFC 6902) Here.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Id of Company to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string
path
required
string
value
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T14:00:00.156Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Create Subdomain

Create a subdomain on an existing Company.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Id of the Company to valiate the Domain information for.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
domain
required
string

Domain name.

subdomain
required
string

Subdomain on domain that this configuration is for.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T14:00:00.156Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Delete Subdomain

Delete a subdomain from a company.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Id of the Company to valiate the Domain information for.

fullDomainName
required
string
Example: em1.example.com

Full domain name for the domain of the Company.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T14:00:00.156Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Configure Inbound Webhook

Configure the given domain to receive inbound messages.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Id of the Company to create an inbound webhook for.

fullDomainName
required
string
Example: em1.example.com

Full domain name for the domain to receive messages on.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T14:00:00.156Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Configure Event Notification Webhook

Configure the given domain to receive event notifications.[Rev 1.20]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of the Company to create an event notifications webhook for.

fullDomainName
required
string
Example: em1.example.com

Full domain name for the domain to receive notifications on.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T14:00:00.156Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Remove Event Notification Webhook

Removes the event notification webhook causing the domain to no longer receive event notifications. [Rev 1.20]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Id of the Company to remove the webhook for.

fullDomainName
required
string
Example: em1.example.com

Full domain name for the domain to remove the webhook for.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "createDate": "1996-01-01T14:00:00.156Z",
  • "createUser": "Don",
  • "domains": [
    ],
  • "primaryEnvironment": "IDI01_P_PRODUCTION"
}

Validate Subdomain

Validate a domain configuration for a Company.

Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Id of the Company to valiate the Domain information for.

fullDomainName
required
string
Example: em1.example.com

Full domain name for the domain of the Company to validate.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "companyID": 1,
  • "companyName": "IDI Billing Solutions",
  • "dnsValidationResults": [
    ],
  • "isValid": true
}

Data Format

Retrieve DataFormat Collection

Retrieve a list of supported data formats to be used in template creation.

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://comms.idibilling.com/comm/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Message

Search For Messages

Search for messages.

Available Fields

The following is a list of fields from the Message and how the can be used within the search.

  • Searchable : bcc, body, cc, from, receivingAddress, replyTo, subject, to
  • Filterable : environment, createDate, createUser, direction, inReplyToMessageID, hasAttachments, lastReadDate, lastReadUser, lastModifiedDate, lastModifiedUser, linkReferenceType, linkReferenceID, read, sendDate, sendUser, status, threadID
  • Sortable : createDate, direction, from, sendDate, status, subject
  • Facetable : threadID
Authorizations:
SWT
query Parameters
searchMode
string (searchMode)
Enum: "any" "full"
Example: searchMode=any
  • Specifies whether any or all of the search terms must be matched in order to count the document as a match.
searchFields
string
Example: searchFields="body"
  • The list of comma-separated field names to search for the specified text. Target fields must be marked as searchable.
queryType
string (queryType)
Enum: "simple" "full"
Example: queryType=simple
  • When set to simple, search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields (or fields indicated in searchFields) in each document by default.
$skip
number
Example: $skip=10
  • The number of search results to skip. This value cannot be greater than 100,000.
$top
number
Example: $top=1
  • The number of search results to retrieve. If you specify a value greater than 1000 and there are more than 1000 results, only the first 1000 results will be returned.
$count
boolean
Example: $count=true
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$orderBy
string <datetime>
Example: $orderBy="createDate"
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There is a limit of 32 clauses for $orderby.
$select
string
Example: $select="subject"
  • A list of comma-separated fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. You can also explicitly request all fields by setting this parameter to *.
$filter
string
Example: $filter="subject eq 'Important'"
  • A structured search expression in standard OData syntax.
facets
string
Example: facets=threadID
  • The facet(s) to include in the search results. A single facet can be specified with just the facets parameter. Multiple facets can be specified with the following syntax: facets[0]=<FACET_SPEC>&facets[1]=<FACET_SPEC>&....

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://comms.idibilling.com/comm/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ],
  • "facets": {
    }
}

Create Message

Provides the ability to create a message. If the createAsDraft is TRUE then the message will be created with a status of Drafting, otherwise the message will be created with a status of Pending and will be immediately queued to be sent.

Note

Conditionally Required Fields

The following fields are required for a message to be sent. Any messages created with createAsDraft equal to FALSE will be sent immediately, and must supply the following fields:

  • body
  • from
  • subject
  • to
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array of objects (Participant)

List of blind carbon copy recipients for this message.

body
string

Contents of the message. This field accepts HTML and plain text content. Communications will dynamically determine the content type provided by inspecting the body. This field is required if createAsDraft is FALSE.

bodyContentType
string

Content type of the message. If not specified, the message will be sent as text/html. To send a plain text message, set this value to text/plain.

Array of objects (Participant)

List of carbon copy recipients for this message.

createAsDraft
boolean

Indicates if the message should be created as a draft. Draft messages will have a status of Drafting and will not be sent upon creation.

object (Participant)
inReplyToMessageID
string

Identifier of the message that this message is in response to.

Array of objects (LinkReference)

The object(s) to which the message is linked.

subject
string

Subject of the message. This field is required if createAsDraft is FALSE.

Array of objects (Participant)

List of recipients of the message. This field is required if createAsDraft is FALSE.

Responses

Request samples

Content type
application/json
{
  • "bcc": [
    ],
  • "body": "<p>This is the contents of the message.</p>",
  • "bodyContentType": "text/html",
  • "cc": [
    ],
  • "createAsDraft": false,
  • "from": {
    },
  • "inReplyToMessageID": "41c01fd1-0b9d-42d8-8f99-05138d85ee66",
  • "linkReferences": [
    ],
  • "subject": "This is the subject.",
  • "to": [
    ]
}

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "inReplyToMessageID": "41c01fd1-0b9d-42d8-8f99-05138d85ee66",
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "messageID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "receivingAddress": "johndoe@domain.com",
  • "replyTo": {
    },
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Retrieve Message

Retrieve a specific message by id.

Note

Format of Response

Use the format query string parameter to change the output format from this API. The format query string accepts the following values:

  • default : Indicates that all standard fields should be returned. This will include all metadata and the body of the message, in HTML if available.
  • allContent : Indicates that all standard fields should be returned, in addition all available content properties should be included.
Authorizations:
SWT
path Parameters
id
required
string

Id of the message to retrieve.

query Parameters
format
string (format)
Enum: "default" "allContent"
Example: format=default

Indicates the response format to be used when returning the message.

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "inReplyToMessageID": "41c01fd1-0b9d-42d8-8f99-05138d85ee66",
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "messageID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "receivingAddress": "johndoe@domain.com",
  • "replyTo": {
    },
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Delete Message

Provides the ability to delete a message.

Authorizations:
SWT
path Parameters
id
required
string

Id of the message to update.

query Parameters
format
string

Responses

Update Message

Provides the ability to update specific properties of a message. This operation uses the JSON Patch document structure for defining updates to the Message objects. Read more about JSON Patch (RFC 6902) Here. Updating the read status of a message will automatically cause lastReadDate and lastReadUser to be captured.

Note

Patchable Fields (NON-DRAFT)

The following is a list of properties of a non-draft Message that can be patched.

  • linkReferences : add, remove, replace
  • read: replace

    Patchable Fields (DRAFT)

    The following is a list of properties of a draft Message that can be patched.
  • contents: add, replace
    • content: replace
    • contentType: replace
  • bcc: add, remove, replace
    • address: replace
    • name: add, remove, replace
  • cc: add, remove, replace
    • address: replace
    • name: add, remove, replace
  • from: add, remove, replace
    • address: replace
    • name: add, remove, replace
  • linkReferences: add, remove, replace
    • referenceId: replace
    • referenceType: replace
  • subject: add, remove, replace
  • to: add, remove, replace
    • address: replace
    • name: add, remove, replace
Authorizations:
SWT
path Parameters
id
required
string

Id of the message to update.

query Parameters
format
string
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

object (JSONPatchMessageValueObjectExample)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "inReplyToMessageID": "41c01fd1-0b9d-42d8-8f99-05138d85ee66",
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "messageID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "receivingAddress": "johndoe@domain.com",
  • "replyTo": {
    },
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Add Attachment

Provides the ability to add a file attachment to an existing message. The message must be in either the In Error or Drafting status.

Note

Form Data

The file attachment should be included as one part of the form data. Only the first file found will be uploaded, the rest will be ignored.

Authorizations:
SWT
path Parameters
id
required
string
header Parameters
Content-Type
required
string
Example: multipart/form-data
Authoriation
required
string
Example: WRAP access_token="mytoken"

Responses

Response samples

Content type
application/json
{
  • "attachmentID": "9f73e081-d074-4d8c-b1b0-f69f254eeae2",
  • "contentType": "image/png",
  • "fileName": "violet.png",
  • "size": 680540
}

Forward an existing message

Provides the ability to forward an existing message. The message returned will be a draft that can be futher updated before being sent. All attachments on the original message will be copied over to the new, forwarded message. Only messages in a status of Processed can be forwarded.

Authorizations:
SWT
path Parameters
id
required
string
header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "inReplyToMessageID": "41c01fd1-0b9d-42d8-8f99-05138d85ee66",
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "messageID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "receivingAddress": "johndoe@domain.com",
  • "replyTo": {
    },
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Send an existing message

Provides the ability to send an existing message, for example if the message was created as a draft and is in the Drafting status.

Note

Required Fields

The following fields are required for a message to be sent.

  • body
  • from
  • subject
  • to
Authorizations:
SWT
path Parameters
id
required
string
header Parameters
Content-Type
required
string
Example: application/json

Responses

Retrieve Attachment

Provides the ability to get the contents of an attachment.

Note

Response

If successful, the response from this call will be the attachment data. Response headers will be populated with the appropriate file name and media type.

Authorizations:
SWT
path Parameters
messageId
required
string

The unique identifier of the message containing the attachment.

attachmentId
required
string

The unique identifier of the attachment to get.

Responses

Response samples

Content type
application/json
{}

Delete Attachment

Provides the ability to remove an attachment from a message. The message must be in either the In Error or Drafting status.

Authorizations:
SWT
path Parameters
messageId
required
string

The unique identifier of the message on which to delete the attachment.

attachmentId
required
string

The unique identifier of the attachment to delete.

Responses

Create a message from template

Create a new message from a template. The newly created message will have a status of Drafting.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
data
object

Data to be used when generating the template.

inReplyToMessageID
string

Identifier of the message that this message is in response to.

Array of objects (LinkReference)

The object(s) to which the message is linked.

templateID
required
string

Identifier of the template to generate the message from.

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "inReplyToMessageID": "41c01fd1-0b9d-42d8-8f99-05138d85ee66",
  • "linkReferences": [
    ],
  • "templateID": "f306224a-0a8c-4f1b-a2de-1ff9ca2cfd1b"
}

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "inReplyToMessageID": "41c01fd1-0b9d-42d8-8f99-05138d85ee66",
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "messageID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "receivingAddress": "johndoe@domain.com",
  • "replyTo": {
    },
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Notification

Search For Notifications

Search for notifications. [Rev 1.16]

Available Fields

The following is a list of fields from the Notification and how the can be used within the search.

  • Searchable : bcc, body, cc, from, subject, to
  • Filterable : environment, createDate, createUser, direction, hasAttachments, lastReadDate, lastReadUser, lastModifiedDate, lastModifiedUser, linkReferenceType, linkReferenceID, read, sendDate, sendUser, status, threadID
  • Sortable : createDate, direction, from, sendDate, status, subject
  • Facetable : threadID"
Authorizations:
SWT
query Parameters
searchMode
string (searchMode)
Enum: "any" "full"
Example: searchMode=any
  • Specifies whether any or all of the search terms must be matched in order to count the document as a match.
searchFields
string
Example: searchFields="body"
  • The list of comma-separated field names to search for the specified text. Target fields must be marked as searchable.
queryType
string (queryType)
Enum: "simple" "full"
Example: queryType=simple
  • When set to simple, search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields (or fields indicated in searchFields) in each document by default.
$skip
number
Example: $skip=10
  • The number of search results to skip. This value cannot be greater than 100,000.
$top
number
Example: $top=1
  • The number of search results to retrieve. If you specify a value greater than 1000 and there are more than 1000 results, only the first 1000 results will be returned.
$count
boolean
Example: $count=true
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$orderBy
string
Example: $orderBy="createDate"
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There is a limit of 32 clauses for $orderby.
$select
string
Example: $select="subject"
  • A list of comma-separated fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. You can also explicitly request all fields by setting this parameter to *.
$filter
string
Example: $filter="subject eq 'Important'"
  • A structured search expression in standard OData syntax.
facets
string
Example: facets=threadID
  • The facet(s) to include in the search results. A single facet can be specified with just the facets parameter. Multiple facets can be specified with the following syntax: facets[0]=<FACET_SPEC>&facets[1]=<FACET_SPEC>&....

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://comms.idibilling.com/comm/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ],
  • "facets": {
    }
}

Create Notification

Provides the ability to create a notification. If the createAsDraft is TRUE then the notification will be created with a status of Drafting, otherwise the notification will be created with a status of Pending and will be immediately queued to be sent. [Rev 1.16]

Note

Conditionally Required Fields

The following fields are required for a notification to be sent. Any notifications created with createAsDraft equal to FALSE will be sent immediately, and must supply the following fields:

  • body
  • from
  • subject
  • to
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array of objects (Participant)

List of blind carbon copy recipients for this notification.

body
string

Contents of the notification. This field accepts HTML and plain text content. Communications will dynamically determine the content type provided by inspecting the body. This field is required if createAsDraft is FALSE.

bodyContentType
string

Content type of the notification. If not specified, the notification will be sent as text/html. To send a plain text notification, set this value to text/plain.

Array of objects (Participant)

List of carbon copy recipients for this notification.

createAsDraft
boolean

Indicates if the notification should be created as a draft. Draft notification will have a status of Drafting and will not be sent upon creation.

fromAlias
string

Alias for the from address of the notification. If no value is provided the system configured value will be used.

Array of objects (LinkReference)

The object(s) to which the notification is linked.

subject
string

Subject of the notification. This field is required if createAsDraft is FALSE.

Array of objects (Participant)

List of recipients of the notification. This field is required if createAsDraft is FALSE.

Responses

Request samples

Content type
application/json
{
  • "bcc": [
    ],
  • "body": "<p>This is the contents of the notification.</p>",
  • "bodyContentType": "text/html",
  • "cc": [
    ],
  • "createAsDraft": false,
  • "fromAlias": "No-Reply.",
  • "linkReferences": [
    ],
  • "subject": "This is the subject.",
  • "to": [
    ]
}

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "notificationID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Retrieve Notification

Retrieve a specific notification by id. [Rev 1.16]

Note

Format of Response

Use the format query string parameter to change the output format from this API. The format query string accepts the following values:

  • default : Indicates that all standard fields should be returned. This will include all metadata and the body of the notification, in HTML if available.
  • allContent : Indicates that all standard fields should be returned, in addition all available content properties should be included.
Authorizations:
SWT
path Parameters
id
required
string

Id of the notification to retrieve.

query Parameters
format
string (format)
Enum: "default" "allContent"
Example: format=default

Indicates the response format to be used when returning the notification.

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "notificationID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Delete Notification

Provides the ability to delete a notification. [Rev 1.16]

Authorizations:
SWT
path Parameters
id
required
string

Id of the notification to update.

query Parameters
format
string

Responses

Update Notification

"Provides the ability to update specific properties of a notification.This operation uses the JSON Patch document structure for defining updates to the Notification objects. Read more about JSON Patch (RFC 6902) <a href="https://tools.ietf.org/html/rfc6902\" target="blank">Here.\nUpdating the read status of a notification will automatically cause lastReadDate and lastReadUser to be captured. [Rev 1.16]

Note

Patchable Fields (NON-DRAFT)

The following is a list of properties of a non-draft Notification that can be patched.

  • linkReferences : add, remove, replace
  • read: replace

    Patchable Fields (DRAFT)

    The following is a list of properties of a draft Message that can be patched.
  • contents: add, replace
    • content: replace
    • contentType: replace
  • bcc: add, remove, replace
    • address: replace
    • name: add, remove, replace
  • cc: add, remove, replace
    • address: replace
    • name: add, remove, replace
  • fromAlias: replace
  • linkReferences: add, remove, replace
    • referenceId: replace
    • referenceType: replace
  • subject: add, remove, replace
  • to: add, remove, replace
    • address: replace
    • name: add, remove, replace"
Authorizations:
SWT
path Parameters
id
required
string

Id of the notification to update.

query Parameters
format
string
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

object (JSONPatchNotificationValueObjectExample)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "notificationID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Add Attachment

Provides the ability to add a file attachment to an existing notification. The notification must be in either the In Error or Drafting status.

Note

Form Data

The file attachment should be included as one part of the form data. Only the first file found will be uploaded, the rest will be ignored. [Rev 1.16]

Authorizations:
SWT
path Parameters
id
required
string
header Parameters
Content-Type
required
string
Example: multipart/form-data
Authoriation
required
string
Example: WRAP access_token="mytoken"

Responses

Response samples

Content type
application/json
{
  • "attachmentID": "9f73e081-d074-4d8c-b1b0-f69f254eeae2",
  • "contentType": "image/png",
  • "fileName": "violet.png",
  • "size": 680540
}

Resubmit an existing notification

Provides the ability to resubmit an existing notification as long as it is not in the Drafting or Pending status. [Rev 1.16]

Authorizations:
SWT
path Parameters
id
required
string
header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "notificationID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "resubmitted": false,
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Send an existing notification

Provides the ability to send an existing notification, for example if the notification was created as a draft and is in the Drafting status. [Rev 1.16]

Note

Required Fields

The following fields are required for a notification to be sent.

  • body
  • from
  • subject
  • to
Authorizations:
SWT
path Parameters
id
required
string
header Parameters
Content-Type
required
string
Example: application/json

Responses

Retrieve Attachment

Provides the ability to get the contents of an attachment. [Rev 1.16]

Note

Response

If successful, the response from this call will be the attachment data. Response headers will be populated with the appropriate file name and media type.

Authorizations:
SWT
path Parameters
notificationId
required
string

The unique identifier of the notification containing the attachment.

attachmentId
required
string

The unique identifier of the attachment to get.

Responses

Response samples

Content type
application/json
{}

Delete Attachment

Provides the ability to remove an attachment from a notification. The notification must be in either the In Error or Drafting status. [Rev 1.16]

Authorizations:
SWT
path Parameters
notificationId
required
string

The unique identifier of the notification on which to delete the attachment.

attachmentId
required
string

The unique identifier of the attachment to delete.

Responses

Create a notification from template

Create a new notification from a template. The newly created notification will have a status of Drafting. [Rev 1.16]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
data
object

Data to be used when generating the template.

Array of objects (LinkReference)

The object(s) to which the notification is linked.

templateID
required
string

Identifier of the template to generate the notification from.

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "linkReferences": [
    ],
  • "templateID": "f306224a-0a8c-4f1b-a2de-1ff9ca2cfd1b"
}

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "bcc": [
    ],
  • "cc": [
    ],
  • "contents": [
    ],
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "direction": "Outbound",
  • "environment": "myenvironment",
  • "from": {
    },
  • "lastReadDate": "2016-09-09T17:35:09.156Z",
  • "lastReadUser": "user1",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "linkReferences": [
    ],
  • "notificationID": "bf942102-60bf-49a6-8564-961199a8c82f",
  • "read": true,
  • "sendDate": "2016-09-09T17:35:09.156Z",
  • "sendUser": "user1",
  • "status": "Pending",
  • "subject": "This is the subject.",
  • "templateReference": {
    },
  • "threadID": "c4aac6f9-d3f5-43e2-bb2c-0D1ff4814226",
  • "to": [
    ]
}

Templates

Search For Templates

Search for templates.

Available Fields

The following is a list of fields from the Message and how the can be used within the search.

  • Searchable : description, name, templateType
  • Filterable : templateID, isAvailable, templateTypeID, createDate, createUser, environment, lastModifiedDate, lastModifiedUser
  • Sortable : createDate, lastModifiedDate, name
Authorizations:
SWT
query Parameters
searchMode
string (searchMode)
Enum: "any" "full"
Example: searchMode=any
  • Specifies whether any or all of the search terms must be matched in order to count the document as a match.
searchFields
string
Example: searchFields=description
  • The list of comma-separated field names to search for the specified text. Target fields must be marked as searchable.
queryType
string (queryType)
Enum: "simple" "full"
Example: queryType=simple
  • When set to simple, search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields (or fields indicated in searchFields) in each document by default.
$skip
number
Example: $skip=10
  • The number of search results to skip. This value cannot be greater than 100,000.
$top
number
Example: $top=1
  • The number of search results to retrieve. If you specify a value greater than 1000 and there are more than 1000 results, only the first 1000 results will be returned.
$count
boolean
Example: $count=true
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$orderBy
string
Example: $orderBy=createDate
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There is a limit of 32 clauses for $orderby.
$select
string
Example: $select=name
  • A list of comma-separated fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. You can also explicitly request all fields by setting this parameter to *.
$filter
string
Example: $filter=isAvailable eq true
  • A structured search expression in standard OData syntax.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://comms.idibilling.com/comm/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Create Template

Provides the ability to create a new template.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
description
required
string

Description of the template.

name
required
string

Name of the template.

templateTypeID
required
string

Type identifier of the template type.

Responses

Request samples

Content type
application/json
{
  • "description": "Description for My Template",
  • "name": "My Template",
  • "templateTypeID": "fa126c55-621f-4fc4-b902-2ebc96abc112"
}

Response samples

Content type
application/json
{
  • "description": "Description for My Template",
  • "isAvailable": true,
  • "name": "My Template",
  • "templateTypeID": "fa126c55-621f-4fc4-b902-2ebc96abc112",
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "environment": "myenvironment",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "templateID": "6fd987c7-621f-4fc4-b902-2bbe96abc126",
  • "templateTypeCode": "custom",
  • "versions": [
    ]
}

Retrieve Template

Retrieve a specific template by ID.

Authorizations:
SWT
path Parameters
id
required
string

ID of the template to retrieve.

Responses

Response samples

Content type
application/json
{
  • "description": "Description for My Template",
  • "isAvailable": true,
  • "name": "My Template",
  • "templateTypeID": "fa126c55-621f-4fc4-b902-2ebc96abc112",
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "environment": "myenvironment",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "templateID": "6fd987c7-621f-4fc4-b902-2bbe96abc126",
  • "templateTypeCode": "custom",
  • "versions": [
    ]
}

Delete Template

Delete a template.

Authorizations:
SWT
path Parameters
id
required
string

Id of the template to delete.

Responses

Update Template

Provides the ability to update specific properties of a template. This operation uses the JSON Patch document structure for defining updates to the company objects. Read more about JSON Patch (RFC 6902) Here.

Patchable Fields

The following is a list of properties of a Template that can be patched.

  • name : replace
  • description : replace
  • isAvailable : replace
Authorizations:
SWT
path Parameters
id
required
string

Id of the template to update.

Request Body schema: text/plain
Array
object

Responses

Response samples

Content type
application/json
{
  • "description": "Description for My Template",
  • "isAvailable": true,
  • "name": "My Template",
  • "templateTypeID": "fa126c55-621f-4fc4-b902-2ebc96abc112",
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "environment": "myenvironment",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "templateID": "6fd987c7-621f-4fc4-b902-2bbe96abc126",
  • "templateTypeCode": "custom",
  • "versions": [
    ]
}

Generate template preview

Generate a preview for the given template id.

Authorizations:
SWT
path Parameters
id
required
string

ID of the template to generate the preview from.

Request Body schema: application/json
data
object

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{
  • "body": "Hello Sir...",
  • "subject": "Welcome to IDI Billing Solutions",
  • "templateID": "6fd987c7-621f-4fc4-b902-2bbe96abc126",
  • "templateVersionID": "aa126c55-cd9d-4792-bd66-5eebb9bd0339"
}

Retrieve Template Version

Retrieve a specific template version by ID.

Authorizations:
SWT
path Parameters
id
required
string

ID of the template associated with which the template version is associated.

versionID
required
string

ID of the template version to retrieve.

Responses

Response samples

Content type
application/json
{
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "environment": "myenvironment",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "body": "This is the body of my awesome template!",
  • "dataDefinitions": [
    ],
  • "note": "Updated link location",
  • "subject": "Template Subject",
  • "templateVersionID": "aa126c55-cd9d-4792-bd66-5eebb9bd0339"
}

Update Template Version

Provides the ability to update specific properties of a template version. This operation uses the JSON Patch document structure for defining updates to the company objects. Read more about JSON Patch (RFC 6902) Here.

Patchable Fields

The following is a list of properties of a Template that can be patched.

  • subject : add, replace
  • body : add, replace
  • isAvailable : replace
  • dataDefinitions * defaultValue : add, replace, remove
Authorizations:
SWT
path Parameters
id
required
string

ID of the template associated with which the template version is associated.

versionID
required
string

ID of the template version to update.

Request Body schema: application/json
Array
op
required
string
path
required
string
value
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "environment": "myenvironment",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "body": "This is the body of my awesome template!",
  • "dataDefinitions": [
    ],
  • "note": "Updated link location",
  • "subject": "Template Subject",
  • "templateVersionID": "aa126c55-cd9d-4792-bd66-5eebb9bd0339"
}

Template Type

Retrieve TemplateType Collection

Retrieve a list of template types currently installed.

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Retrieve TemplateType

Retrieve a specific template by ID.

Authorizations:
SWT
path Parameters
id
required
string

ID of the template type to retrieve.

Responses

Response samples

Content type
application/json
{
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "user1",
  • "environment": "myenvironment",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "user1",
  • "dataDefinitions": [
    ],
  • "description": "A template type for general communications",
  • "name": "Custom",
  • "templateTypeCode": "custom",
  • "templateTypeID": "aabbccdd-4444-5555-6666-eeff00112233"
}

Utilization

Retrieve Monthly Utilization

Retrieve monthly communications utilization for the given company. If no company is supplied then the company associated with current environment is used.

Authorizations:
SWT
query Parameters
companyId
required
number

ID of the company to retrieve utilization statistics for.

Responses

Response samples

Content type
application/json
{
  • "companyID": 1007,
  • "entries": [
    ]
}

Release Notes

Release Notes 2.17

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.16

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.15

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.14

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.13

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.12

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.11

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.10

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.09

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.08

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.07

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.06

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.05

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.04

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.21

Release Notes 1.20

Release Notes 1.19

  • Corrected standard oData query string parameters include $ in the name.

Release Notes 1.18

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.17

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.16

Release Notes 1.15

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.14

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.13

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.12

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.11

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.10

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.09

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.08

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.07

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.06

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.05

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

  • GET api/message - Added lastReadDate, lastReadUser, read.
  • GET api/message({id}) - Added lastReadDate, lastReadUser, read.
  • PATCH api/message({id}) - Added ability to set read flag on a message.

Release Notes 1.03

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.02

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.00

  • Initial release