Access Token

Refresh Token

Subdomain

Tenant Id

SuperOffice

Please, add the SuperOffice subdomain and tenant Id below

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Appointment agent service CreateDefaultAppointmentEntity.

Set default values into a new AppointmentEntity.

Can be sorted and further filtered using OData conventions:

* Appointment?$select=col1,col2,abc/col3
* Appointment?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Appointment?$orderby=abc/col3,col1
* Appointment?$top=1000
* Appointment?$mode=full


OData returns XML or JSON carriers depending on the Accept headers.


Calls the Archive service using the "FindAppointment" archive.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of all AppointmentEntity.

Calls the Appointment agent service SaveAppointmentEntity.

Creates a new AppointmentEntity

Calls the Appointment agent service GetAppointmentEntity.

Gets a AppointmentEntity object.

Updates the existing AppointmentEntity

Calls the Appointment agent service DeleteAppointmentEntity.

Deletes the AppointmentEntity

See <a href="https://tools.ietf.org/html/rfc6902">RFC6902</a> and <a href="https://tools.ietf.org/html/rfc7386">RFC 7396</a>. Update the Department field to "foo" can be done either as a JSON PATCH:
<code lang="js">
  [ { "op": "replace", "path": "/Department", "value": "foo" } ]
</code>
or as a JSON MERGE PATCH, which describes the change directly:
<code lang="js">
  { "Department": "foo" }
</code><para />
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
<para />
Calls the {SuperOffice.CRM.Services.IAppointmentAgent} service SaveAppointmentEntity.

Update a AppointmentEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

Can be sorted and further filtered using OData conventions:

* Appointment/1234/Participants?$select=col1,col2,abc/col3
* Appointment/1234/Participants?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Appointment/1234/Participants?$orderby=abc/col3,col1
* Appointment/1234/Participants?$top=1000
* Appointment/1234/Participants?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Participants" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Participants under a specific AppointmentEntity.

Can be sorted and further filtered using OData conventions:

* Appointment/1234/Links?$select=col1,col2,abc/col3
* Appointment/1234/Links?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Appointment/1234/Links?$orderby=abc/col3,col1
* Appointment/1234/Links?$top=1000
* Appointment/1234/Links?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Links" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Links under a specific AppointmentEntity.

Check that entity is ready for saving.

This is a simpler, smaller variation of the full AppointmentEntity. Calls the Appointment agent service GetAppointment.

A simple Appointment object.

Custom fields meta-data (published user defined + extra fields) on AppointmentEntity.

Custom field meta-data (published user defined + extra fields) on AppointmentEntity.

May be different from the published version.

Current AppointmentEntity user-defined field layout.

Save AppointmentEntity user-defined field layout.

Add a new field to the current AppointmentEntity user-defined field layout.

Currently published AppointmentEntity user-defined field layout.

Get a AppointmentEntity user-defined field's details based on the prog-id or label.

Deletes the admin version of the field. The layout needs to be published before the change is visible.

Delete a AppointmentEntity user-defined field's details based on the prog-id or label.

Change a AppointmentEntity user-defined field's type based on the prog-id or label.

Get a published AppointmentEntity user-defined field's details based on the prog-id or label.

True if the AppointmentEntity user-defined field layout has been changed.

Is the UDef Layout changed? This may or may not involve moving data (which takes longer).

True if the AppointmentEntity user-defined field layout is being updated.

Is UDef Layout Publishing active?

This will trigger movement of field data etc.

Publish the AppointmentEntity user-defined field layout.

Revert all un-published AppointmentEntity udef layout changes.

Foreign keys on the AppointmentEntity.

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Ticket agent service CreateDefaultAttachmentEntity.

Set default values into a new AttachmentEntity.

Calls the Ticket agent service SaveAttachmentEntity.

Creates a new AttachmentEntity

Calls the Ticket agent service GetAttachmentEntity.

Gets a AttachmentEntity object.

Updates the existing AttachmentEntity

See <a href="https://tools.ietf.org/html/rfc6902">RFC6902</a> and <a href="https://tools.ietf.org/html/rfc7386">RFC 7396</a>. Update the Department field to "foo" can be done either as a JSON PATCH:
<code lang="js">
  [ { "op": "replace", "path": "/Department", "value": "foo" } ]
</code>
or as a JSON MERGE PATCH, which describes the change directly:
<code lang="js">
  { "Department": "foo" }
</code><para />
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
<para />
Calls the {SuperOffice.CRM.Services.ITicketAgent} service SaveAttachmentEntity.

Update a AttachmentEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

Copy CRM document to an attachment

Get the content of an attachment

Upload the content for an attachment

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Chat agent service CreateDefaultChatSessionEntity.

Set default values into a new ChatSessionEntity.

Can be sorted and further filtered using OData conventions:

* ChatSession?$select=col1,col2,abc/col3
* ChatSession?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* ChatSession?$orderby=abc/col3,col1
* ChatSession?$top=1000
* ChatSession?$mode=full


OData returns XML or JSON carriers depending on the Accept headers.


Calls the Archive service using the "ChatSession" archive.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of all ChatSessionEntity.

Calls the Chat agent service SaveChatSessionEntity.

Creates a new ChatSessionEntity

Calls the Chat agent service GetChatSessionEntity.

Gets a ChatSessionEntity object.

Updates the existing ChatSessionEntity

Calls the Chat agent service DeleteChatSessionEntity.

Deletes the ChatSessionEntity

See <a href="https://tools.ietf.org/html/rfc6902">RFC6902</a> and <a href="https://tools.ietf.org/html/rfc7386">RFC 7396</a>. Update the Department field to "foo" can be done either as a JSON PATCH:
<code lang="js">
  [ { "op": "replace", "path": "/Department", "value": "foo" } ]
</code>
or as a JSON MERGE PATCH, which describes the change directly:
<code lang="js">
  { "Department": "foo" }
</code><para />
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
<para />
Calls the {SuperOffice.CRM.Services.IChatAgent} service SaveChatSessionEntity.

Update a ChatSessionEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

Members means that you have at least one of: Can Respond, Notifications, Listen or Manager

Get all chat sessions which this user is a member of.

If the session does not belong to the user, nothing happens.

Request to send the session to another user.

If the session is not being transferred, nothing happens.

Accept the transfer: assign the session to the user.

Deny the transfer to the user. If the session is not being transferred, nothing happens.

Do not want.

The welcome message is sent to the customer. Returns NULL if session was not in queue.

'answer' the session: assign the session to the user.

The welcome message is sent to the customer.

'answer' the first available session from the queue: assign the session to the user.

Used by bots to hand off a session to human

Reset chat session, put it back on the queue for pickup.

Get the chat transcript, formatted as plain text or html

Get all or some of the messages in a chat session

Add a new message to a chat session

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Chat agent service CreateDefaultChatTopicEntity.

Set default values into a new ChatTopicEntity.

Calls the Chat agent service SaveChatTopicEntity.

Creates a new ChatTopicEntity

Calls the Chat agent service GetChatTopicEntity.

Gets a ChatTopicEntity object.

Updates the existing ChatTopicEntity

Calls the Chat agent service DeleteChatTopicEntity.

Deletes the ChatTopicEntity

See <a href="https://tools.ietf.org/html/rfc6902">RFC6902</a> and <a href="https://tools.ietf.org/html/rfc7386">RFC 7396</a>. Update the Department field to "foo" can be done either as a JSON PATCH:
<code lang="js">
  [ { "op": "replace", "path": "/Department", "value": "foo" } ]
</code>
or as a JSON MERGE PATCH, which describes the change directly:
<code lang="js">
  { "Department": "foo" }
</code><para />
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
<para />
Calls the {SuperOffice.CRM.Services.IChatAgent} service SaveChatTopicEntity.

Update a ChatTopicEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

Can be sorted and further filtered using OData conventions:

* ChatTopic/1234/Sessions?$select=col1,col2,abc/col3
* ChatTopic/1234/Sessions?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* ChatTopic/1234/Sessions?$orderby=abc/col3,col1
* ChatTopic/1234/Sessions?$top=1000
* ChatTopic/1234/Sessions?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "ChatSession" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Sessions under a specific ChatTopicEntity.

Will use timezones to calculate if configured.

Check if we are right now within the opening hours of the given topic.

Get all chat topics which this user is a member of.

Users with Chat-CALs from the MDO list 'chatuser'

Get list of users that can be assigned to chat topics.

Get list of users assigned to a chat topic

Update users roles in a chat topic

Add a user to a chat topic

Get a user assigned to a topic

Update a user's role in a chat topic

Remove a user from a topic

Create a new session on a chat topic

The actual bitmap is accessible via /api/v1/contact/123/image.

Get the Blob that describes the given contact's picture.

Update the Blob that describes the given contact's picture.

The image is returned as stored. If width/height or format is specified, then the image is 
scaled and converted to the requested type.

The contact's picture.

Updating the image will update the ImageInfo automatically.

Save an image to a contact.

Remove the contact image.

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Contact agent service CreateDefaultContactEntity.

Set default values into a new ContactEntity.

Can be sorted and further filtered using OData conventions:

* Contact?$select=col1,col2,abc/col3
* Contact?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact?$orderby=abc/col3,col1
* Contact?$top=1000
* Contact?$mode=full


OData returns XML or JSON carriers depending on the Accept headers.


Calls the Archive service using the "SimpleContact" archive.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of all ContactEntity.

Calls the Contact agent service SaveContactEntity.

Creates a new ContactEntity

Calls the Contact agent service GetContactEntity.

Gets a ContactEntity object.

Updates the existing ContactEntity

Calls the Contact agent service DeleteContactEntity.

Deletes the ContactEntity

See <a href="https://tools.ietf.org/html/rfc6902">RFC6902</a> and <a href="https://tools.ietf.org/html/rfc7386">RFC 7396</a>. Update the Department field to "foo" can be done either as a JSON PATCH:
<code lang="js">
  [ { "op": "replace", "path": "/Department", "value": "foo" } ]
</code>
or as a JSON MERGE PATCH, which describes the change directly:
<code lang="js">
  { "Department": "foo" }
</code><para />
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
<para />
Calls the {SuperOffice.CRM.Services.IContactAgent} service SaveContactEntity.

Update a ContactEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

Can be sorted and further filtered using OData conventions:

* Contact/1234/Activities?$select=col1,col2,abc/col3
* Contact/1234/Activities?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact/1234/Activities?$orderby=abc/col3,col1
* Contact/1234/Activities?$top=1000
* Contact/1234/Activities?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "ContactActivity" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Activities under a specific ContactEntity.

Can be sorted and further filtered using OData conventions:

* Contact/1234/Appointments?$select=col1,col2,abc/col3
* Contact/1234/Appointments?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact/1234/Appointments?$orderby=abc/col3,col1
* Contact/1234/Appointments?$top=1000
* Contact/1234/Appointments?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Appointment" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Appointments under a specific ContactEntity.

Can be sorted and further filtered using OData conventions:

* Contact/1234/Documents?$select=col1,col2,abc/col3
* Contact/1234/Documents?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact/1234/Documents?$orderby=abc/col3,col1
* Contact/1234/Documents?$top=1000
* Contact/1234/Documents?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Document" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Documents under a specific ContactEntity.

Can be sorted and further filtered using OData conventions:

* Contact/1234/Projects?$select=col1,col2,abc/col3
* Contact/1234/Projects?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact/1234/Projects?$orderby=abc/col3,col1
* Contact/1234/Projects?$top=1000
* Contact/1234/Projects?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "ContactProjects" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Projects under a specific ContactEntity.

Can be sorted and further filtered using OData conventions:

* Contact/1234/Sales?$select=col1,col2,abc/col3
* Contact/1234/Sales?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact/1234/Sales?$orderby=abc/col3,col1
* Contact/1234/Sales?$top=1000
* Contact/1234/Sales?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "SaleFilteredWithStakeholder" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Sales under a specific ContactEntity.

Can be sorted and further filtered using OData conventions:

* Contact/1234/Persons?$select=col1,col2,abc/col3
* Contact/1234/Persons?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact/1234/Persons?$orderby=abc/col3,col1
* Contact/1234/Persons?$top=1000
* Contact/1234/Persons?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Person" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Persons under a specific ContactEntity.

Can be sorted and further filtered using OData conventions:

* Contact/1234/Relations?$select=col1,col2,abc/col3
* Contact/1234/Relations?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact/1234/Relations?$orderby=abc/col3,col1
* Contact/1234/Relations?$top=1000
* Contact/1234/Relations?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Relation" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Relations under a specific ContactEntity.

Can be sorted and further filtered using OData conventions:

* Contact/1234/Tickets?$select=col1,col2,abc/col3
* Contact/1234/Tickets?$filter=col1 eq 'foo' and startswith(col2, 'baz')
* Contact/1234/Tickets?$orderby=abc/col3,col1
* Contact/1234/Tickets?$top=1000
* Contact/1234/Tickets?$mode=full


OData returns XML or JSON carriers depending on the HTTP Accept header.


Calls the Archive service using the "Ticket" archive provider.


## Filter Operators: ##

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,  

list ids: oneOf, NotOneOf, 

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)


OData list of Tickets under a specific ContactEntity.

Retrieve all available duplicate rules for contact

Set which duplicate rules should be active or not

Merge two contacts.

Get duplicates based on the contact name and department

Get summary of contact and its recent activity.

Check that entity is ready for saving, return error messages by field.

This is a simpler, smaller variation of the full ContactEntity. Calls the Contact agent service GetContact.

SuperOffice API Integration Profile

Data Collections

Operations

Supercharge your product integrations today