| Feature | Version | |
|---|---|---|
| status | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The ID of the user resource.
User statuses only contain the statusId property and additional members specific to a user.
Clients need to retrieve
status messages
in order to map to a status message (for messageText etc.) using the statusId property.
Required
The unique identifier for this user status to update. This is the IC User name.
Required
The ID of the status message that the specified user is currently set to.
The value represented by this property should be treated as case-insensitive.
The status message notes set by user.
The forward number set by user.
The user status until time.
This property can be null.
Property type documentation:
Clients must supply a complete UTC dateTime, regardless of the user specifying only date or only time. The hasDate and hasTime members have to do with UI, not the completeness of untilDateTime. If a user specifies only a date, clients must use the UTC dateTime converted from midnight local time for that date. If a user specifies only a time, clients must use the UTC dateTime converted from today's date at that local time.
Required
The status until date and time.This property will only be applied if CanHaveDate and CanHaveTime are true.
Required
This has to do with UI, not the untilDateTime.Required
This has to do with UI, not the untilDateTime.This property indicates whether the user is on phone.
This property is updated when status on onPhone changes.
This property is update when user status changes.
The stations on which the user is logged in.
The name of the icServers to which the user is connected to.
The name of the server that is providing status for this user.
Indicates whether or not the user is logged into a station.
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.Updates the specified user's status.
The notes member is not cleared unless explicitly set to an empty string. The until member, however, is cleared if not included. As an example:
Update status with notes and untilDateTime:
{"statusId" : "On Vacation","notes" : "Touring France","until" : {"untilDateTime":"2012-02-16T16:42Z","hasDate":true,"hasTime":true}}
Update status to On Vacation:
{"statusId" : "On Vacation"}
The net result of the two example requests above does not have an until member set; the user status does have notes.
| Feature | Version | |
|---|---|---|
| status | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The ID of the user resource.Required
The ID of the new status. This ID can access the status message definition in StatusMessageList.
The value represented by this property should be treated as case-insensitive.
This property can be null.
Property type documentation:
Clients must supply a complete UTC dateTime, regardless of the user specifying only date or only time. The hasDate and hasTime members have to do with UI, not the completeness of untilDateTime. If a user specifies only a date, clients must use the UTC dateTime converted from midnight local time for that date. If a user specifies only a time, clients must use the UTC dateTime converted from today's date at that local time.
Required
The status until date and time.This property will only be applied if CanHaveDate and CanHaveTime are true.
Required
This has to do with UI, not the untilDateTime.Required
This has to do with UI, not the untilDateTime.Required
The ID associated with the asynchronous operation request. This can be used to correlate future events and operations.Required
The JSON type representing this option.Required
When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.
Required
Required
This property can be null.
Property type documentation:
Provides additional detail for an error.
Required
A message that describes the current error.| Feature | Version | |
|---|---|---|
| status | 2 |
| Feature | Version | |
|---|---|---|
| status | 2 |
Multiple options:
The value can be assigned any of the following options.Required
A message that describes the current error.Required
The JSON type representing this option.Required
A message that describes the current error.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.