CampusAPI Messaging Services API documentation version 0.1.2
Based on OSID version 3.0.0

https://base.url/messaging

Overview

The Messaging service package manages sending and receiving of messages.

This package includes the following entities:

Messages

Messages are structures that include a sender, recipients, and a timestamp. The text of the Message is displayable as text and may include a specific structure defined using typed service extensions.

Until a Message is sent, it is stored and may be edited as a draft. Once a Message is sent, the Message includes the sending Agent as well as the addressed recipients represented by a list of Resources. A Message is received by a receiving Agent which generally is related to one of the recipients.

Sending Messages:
Once a Message has been created, it may be sent from the authenticated Agent to a specified list of recipients using the Messaging service. The same Message may be sent to additional recipients by returning to the Messaging service and using the same Message Id.

Receiving Messages:
The Message service can be used to retrieve incoming Messages. From the point of view of the receiving Agent, Messages from the this service indicate a foreign Agent as the sender and at least one recipient related to the authenticated Agent which generally, but may not always, be the receiving Agent.

The same methods are used to receive Messages as well as examine created Messages. The Messages seen in the Message services vary depending on the point of view implied by the Mailbox catalog.

On Resource & Agents:
The Agent is the identity of an authenticated actor while the Resource represents a real-world entity such as a person or organization. The mapping between Agents and Resources is managed by the Resource servie. In the Messaging service, an Agent sends a Message to a Resource, However, aspects of the service also examine messages from the recipient's point of view where the sender appears as an object instead of an actor. The Messaging service references both a sender as a Resource and a sending agent as an Agent. The Messaging service provider orchestrates the mapping between Agents and Resources as a messaging application would access a local address book for looking up full names corresponding to incoming email addresses.

FieldDescriptionType
id(read‑only)The unique id of this message, provided by system.string(osid‑id)
uri(read‑only)The uri of this message, provided by system.string(uri)
displayNameThe name of this message for display.string
descriptionThe description of this message.string
genusTypeId
(read‑only)		Id of the immutable type of this message. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this message. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
subjectLineThe subject line of this message.string
textThe text of the message.string

Receipts

NO ENTITY DOC FOUND

Mailboxes

Messages are cataloged using Mailboxes. Mailboxes be may used to store messages for different users, and may also be used to provide message folders for each user. Like all catalog objects, a Mailbox may belong to a federated hierarchy to provide federated and filtering views among multiple mailboxes.

FieldDescriptionType
id(read‑only)The unique id of this mailbox, provided by system.string(osid‑id)
uri(read‑only)The uri of this mailbox, provided by system.string(uri)
displayNameThe name of this mailbox for display.string
descriptionThe description of this mailbox.string
genusTypeId
(read‑only)		Id of the immutable type of this mailbox. Default type set by system unless specified in query parameter.string(osid‑id)
recordTypeIds
(read‑only)		Type Ids of record types available on this mailbox. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.string(osid‑id)[]
providerIdThe provider of this mailbox. References a resource.Resource object.string(osid‑id)
brandingIdsThe branding of this mailbox. References repository.Asset objects.string(osid‑id)[]
licenseThe licensing that applies to this mailbox.string

License

CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org

/messages

Collection of messages in a system, federation of systems, or in a default mailbox.

get post

get

Get all messages in the system or default mailbox.

post

Create a new message in the default mailbox.

Create a new message in the default mailbox.

Query Parameters

  • genusType: (string)

    specify a particular message type to create

    Example:

    type.Type%3AexampleMessageType%40dxtera.org
  • recordType: (array of )

    specify support for one or more message record types

    Example:

    [
  "type.Type%3AexampleMessageRecordType%40campusapi.org",
  "..."
]
  • mailboxId: (string)

    specify in which mailbox to create this message

    Example:

    messaging.Mailbox%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this message, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this message, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this message for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this message.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this message. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this message. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "subjectLine": {
      "description": "The subject line of this message.",
      "type": "string"
    },
    "text": {
      "description": "The text of the message.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Message",
  "description": "The description of this Message",
  "subjectLine": "This is the SubjectLine",
  "text": "This is the Text",
  "receiptId": "messaging.Receipt:6249@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The message has been created",
  "messageId": "messaging.Message:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a message form metadata.

get

Get form metadata for creating a new message.

get put delete

Entity representing a message

get

Get a message given its id.

put

Update a given message.

delete

Delete a given message.

Get a message given its id.

URI Parameters

  • messageId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "messaging.Message:167@base.url",
  "uri": "http://base.url/open/campusapi/messaging/message/messaging.Message%3A167%40base.url",
  "displayName": "Display Name of this Message",
  "description": "The description of this Message",
  "genusTypeId": "type.Type:defaultMessageType@base.url",
  "recordTypeIds": [ "type.Type:exampleMessageRecordType@campusapi.org", "..."],
  "subjectLine": "This is the SubjectLine",
  "text": "This is the Text",
  "receiptId": "messaging.Receipt:146@base.url"
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "message not found" }

Update a given message.

URI Parameters

  • messageId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Message",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this message, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this message, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this message for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this message.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this message. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this message. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "subjectLine": {
      "description": "The subject line of this message.",
      "type": "string"
    },
    "text": {
      "description": "The text of the message.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Message",
  "description": "The description of this Message",
  "subjectLine": "This is the SubjectLine",
  "text": "This is the Text",
  "receiptId": "messaging.Receipt:6249@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The message has been updated" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "message not found" }

Delete a given message.

URI Parameters

  • messageId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The message has been deleted" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "message not found" }

get

Entity representing a message form metadata for update

get

Get form metadata for updating an existing message.

Get form metadata for updating an existing message.

URI Parameters

  • messageId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Message",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this message, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this message, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this message for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Message.Message:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this message",
      "linked": false
    },
    "description": {
      "description": "The description of this message.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Message.Message:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this message",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this message. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this message. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "subjectLine": {
      "description": "The subject line of this message.",
      "type": "string",
      "read-only": false,
      "minLength": null,
      "maxLength": null,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "messaging.Message:subjectLine@dxtera.org",
      "existingValue": "The existing subject line",
      "elementLabel": "Subject Line",
      "instructions": "Enter a subject line for this message.",
      "linked": false
    },
    "text": {
      "description": "The text of the message.",
      "type": "string",
      "read-only": false,
      "minLength": null,
      "maxLength": null,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "messaging.Message:text@dxtera.org",
      "existingValue": "The existing text",
      "elementLabel": "Text",
      "instructions": "Enter a text for this message.",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "message not found" }

/receipts

Collection of receipts in a system, federation of systems, or in a default mailbox.

get post

get

Get all receipts in the system or default mailbox.

post

Create a new receipt in the default mailbox.

Create a new receipt in the default mailbox.

Query Parameters

  • genusType: (string)

    specify a particular receipt type to create

    Example:

    type.Type%3AexampleReceiptType%40dxtera.org
  • recordType: (array of )

    specify support for one or more receipt record types

    Example:

    [
  "type.Type%3AexampleReceiptRecordType%40campusapi.org",
  "..."
]
  • mailboxId: (string)

    specify in which mailbox to create this receipt

    Example:

    messaging.Mailbox%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Receipt",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this receipt, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this receipt, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this receipt for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this receipt.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this receipt. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this receipt. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    }



  }
}

Example:

{
  "displayName": "Display Name of this Receipt",
  "description": "The description of this Receipt",
  "messageId": "messaging.Message:4548@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The receipt has been created",
  "receiptId": "messaging.Receipt:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a receipt form metadata.

get

Get form metadata for creating a new receipt.

get put delete

Entity representing a receipt

get

Get a receipt given its id.

put

Update a given receipt.

delete

Delete a given receipt.

Get a receipt given its id.

URI Parameters

  • receiptId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "messaging.Receipt:1597@base.url",
  "uri": "http://base.url/open/campusapi/messaging/receipt/messaging.Receipt%3A1597%40base.url",
  "displayName": "Display Name of this Receipt",
  "description": "The description of this Receipt",
  "genusTypeId": "type.Type:defaultReceiptType@base.url",
  "recordTypeIds": [ "type.Type:exampleReceiptRecordType@campusapi.org", "..."],
  "messageId": "messaging.Message:5274@base.url"
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "receipt not found" }

Update a given receipt.

URI Parameters

  • receiptId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Receipt",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this receipt, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this receipt, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this receipt for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this receipt.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this receipt. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this receipt. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    }



  }
}

Example:

{
  "displayName": "Display Name of this Receipt",
  "description": "The description of this Receipt",
  "messageId": "messaging.Message:4548@base.url"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The receipt has been updated" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "receipt not found" }

Delete a given receipt.

URI Parameters

  • receiptId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The receipt has been deleted" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "receipt not found" }

get

Entity representing a receipt form metadata for update

get

Get form metadata for updating an existing receipt.

Get form metadata for updating an existing receipt.

URI Parameters

  • receiptId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Receipt",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this receipt, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this receipt, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this receipt for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Receipt.Receipt:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this receipt",
      "linked": false
    },
    "description": {
      "description": "The description of this receipt.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Receipt.Receipt:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this receipt",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this receipt. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this receipt. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    }



  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "receipt not found" }

/mailboxes

Collection of mailboxes in a system or federation of systems.

get post

get

Get all mailboxes.

post

Create a new mailbox.

Create a new mailbox.

Query Parameters

  • genusType: (string)

    specify a particular mailbox type to create

    Example:

    type.Type%3AexampleMailboxType%40dxtera.org
  • recordType: (array of )

    specify support for one or more mailbox record types

    Example:

    [
  "type.Type%3AexampleMailboxRecordType%40campusapi.org",
  "..."
]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Mailbox",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this mailbox, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this mailbox, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this mailbox for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this mailbox.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this mailbox. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this mailbox. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this mailbox.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this mailbox. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this mailbox.",
      "type": "string"
    }



  }
}

Example:

{
  "displayName": "Display Name of this Mailbox",
  "description": "The description of this Mailbox",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Mailbox@base.url",
  "license": "The license that applies to this Mailbox"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The mailbox has been created",
  "mailboxId": "messaging.Mailbox:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a mailbox form metadata.

get

Get form metadata for creating a new mailbox.

get

The root mailboxes in the mailbox hierarchy. A node with no parents is an orphan. While all mailbox Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

get

Get all root root-mailbox

get put delete

Entity representing a mailbox

get

Get a mailbox given its id.

put

Update a given mailbox.

delete

Delete a given mailbox.

Get a mailbox given its id.

URI Parameters

  • mailboxId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "messaging.Mailbox:237@base.url",
  "uri": "http://base.url/open/campusapi/messaging/mailbox/messaging.Mailbox%3A237%40base.url",
  "displayName": "Display Name of this Mailbox",
  "description": "The description of this Mailbox",
  "genusTypeId": "type.Type:defaultMailboxType@base.url",
  "recordTypeIds": [ "type.Type:exampleMailboxRecordType@campusapi.org", "..."],
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Mailbox@base.url",
  "license": "The license that applies to this Mailbox"
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "mailbox not found" }

Update a given mailbox.

URI Parameters

  • mailboxId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Mailbox",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this mailbox, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this mailbox, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this mailbox for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this mailbox.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this mailbox. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this mailbox. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this mailbox.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this mailbox. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this mailbox.",
      "type": "string"
    }



  }
}

Example:

{
  "displayName": "Display Name of this Mailbox",
  "description": "The description of this Mailbox",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Mailbox@base.url",
  "license": "The license that applies to this Mailbox"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The mailbox has been updated" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "mailbox not found" }

Delete a given mailbox.

URI Parameters

  • mailboxId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The mailbox has been deleted" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "mailbox not found" }

get

Entity representing a mailbox form metadata for update

get

Get form metadata for updating an existing mailbox.

Get form metadata for updating an existing mailbox.

URI Parameters

  • mailboxId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Mailbox",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this mailbox, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this mailbox, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this mailbox for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Mailbox.Mailbox:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this mailbox",
      "linked": false
    },
    "description": {
      "description": "The description of this mailbox.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Mailbox.Mailbox:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this mailbox",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this mailbox. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this mailbox. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this mailbox.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Mailbox.Mailbox:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this mailbox",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this mailbox. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Mailbox.Mailbox:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this mailbox",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this mailbox.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Mailbox.Mailbox:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this mailbox",
      "linked": false
    }



  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{"message": "mailbox not found" }

get

get

Get child mailboxes for the given mailbox in the hierarchy.

Get child mailboxes for the given mailbox in the hierarchy.

URI Parameters

  • mailboxId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "messaging.Mailbox:237@base.url",
    "uri": "http://base.url/open/campusapi/messaging/mailbox/messaging.Mailbox%3A237%40base.url",
    "displayName": "Display Name of this Mailbox",
    "description": "The description of this Mailbox",
    "genusTypeId": "type.Type:defaultMailboxType@base.url",
    "recordTypeIds": [ "type.Type:exampleMailboxRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Mailbox@base.url",
    "license": "The license that applies to this Mailbox"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add mailbox as child of the given mailbox in the hierarchy.

delete

Remove the given mailbox as a child of the given mailbox in the hierarchy.

Add mailbox as child of the given mailbox in the hierarchy.

URI Parameters

  • mailboxId: required(string)
  • childId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The child mailbox has been added to the hierarchy" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "mailbox not found" }

Remove the given mailbox as a child of the given mailbox in the hierarchy.

URI Parameters

  • mailboxId: required(string)
  • childId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The child mailbox has been removed from the hierarchy" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

get

Get parent mailboxes for the given mailbox in the hierarchy.

Get parent mailboxes for the given mailbox in the hierarchy.

URI Parameters

  • mailboxId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "messaging.Mailbox:237@base.url",
    "uri": "http://base.url/open/campusapi/messaging/mailbox/messaging.Mailbox%3A237%40base.url",
    "displayName": "Display Name of this Mailbox",
    "description": "The description of this Mailbox",
    "genusTypeId": "type.Type:defaultMailboxType@base.url",
    "recordTypeIds": [ "type.Type:exampleMailboxRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Mailbox@base.url",
    "license": "The license that applies to this Mailbox"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

get

Get all messages in this mailbox

Get all messages in this mailbox

URI Parameters

  • mailboxId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "messaging.Message:167@base.url",
    "uri": "http://base.url/open/campusapi/messaging/message/messaging.Message%3A167%40base.url",
    "displayName": "Display Name of this Message",
    "description": "The description of this Message",
    "genusTypeId": "type.Type:defaultMessageType@base.url",
    "recordTypeIds": [ "type.Type:exampleMessageRecordType@campusapi.org", "..."],
    "subjectLine": "This is the SubjectLine",
    "text": "This is the Text",
    "receiptId": "messaging.Receipt:146@base.url"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given message to this mailbox

delete

Remove the given message from the mailbox.

Add the given message to this mailbox

URI Parameters

  • mailboxId: required(string)
  • messageId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "message has been added to mailbox" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "message not found" }

Remove the given message from the mailbox.

URI Parameters

  • mailboxId: required(string)
  • messageId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "message has been removed" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "message not found" }

get

get

Get all receipts in this mailbox

Get all receipts in this mailbox

URI Parameters

  • mailboxId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "messaging.Receipt:1597@base.url",
    "uri": "http://base.url/open/campusapi/messaging/receipt/messaging.Receipt%3A1597%40base.url",
    "displayName": "Display Name of this Receipt",
    "description": "The description of this Receipt",
    "genusTypeId": "type.Type:defaultReceiptType@base.url",
    "recordTypeIds": [ "type.Type:exampleReceiptRecordType@campusapi.org", "..."],
    "messageId": "messaging.Message:5274@base.url"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

put delete

put

Add the given receipt to this mailbox

delete

Remove the given receipt from the mailbox.

Add the given receipt to this mailbox

URI Parameters

  • mailboxId: required(string)
  • receiptId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "receipt has been added to mailbox" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "receipt not found" }

Remove the given receipt from the mailbox.

URI Parameters

  • mailboxId: required(string)
  • receiptId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "receipt has been removed" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{ "message": "receipt not found" }