SuperOffice

Links

    SuperOffice API

    Getting access, Developing, Testing

    Back to SuperOffice

    Updates the existing ContactRelationEntity

    Input

    type: object properties: parameters: type: object properties: id: type: string description: The ContactRelationEntity id to update. entity: description: "Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.\r\n<para />\r\nCarrier object for ContactRelationEntity.\r\nServices for the ContactRelationEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IRelationAgent\">Relation Agent</see>." type: object properties: SourceContactId: format: int32 description: Id of the source contact. The value is mandatory. type: integer SourcePersonId: format: int32 description: >- Id of the source person. The value is not mandatory. The person must belong to the source contact. type: integer DestinationContactId: format: int32 description: Id of the destination contact. The value is mandatory. type: integer DestinationPersonId: format: int32 description: >- Id of the destination person. The value is not mandatory. The person must belong to the destination contact. type: integer RelationId: format: int32 description: Primary key type: integer Comment: description: Comment for relation type: string RelationDefinitionId: format: int32 description: Reference to definition type: integer Reversed: format: int32 description: Is direction reversed relative to definition type: integer UpdatedDate: format: date-time description: Last updated when in UTC. type: string CreatedDate: format: date-time description: Registered when in UTC. type: string CreatedBy: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAssociateAgent\">Associate Agent</see>." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer UpdatedBy: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAssociateAgent\">Associate Agent</see>." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer SourceContactName: description: Name of the source contact. type: string SourcePersonName: description: Name of the source person. type: string DestinationContactName: description: Name of the destination contact. type: string DestinationPersonName: description: Name of the destination person. type: string ActiveText: description: Active text for the relation. type: string PassiveText: description: Passive text for the relation. type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer $select: type: string description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields. Accept-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. SO-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. SO-Culture: type: string description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. SO-TimeZone: type: string description: >- Specify the timezone code that you would like date/time responses converted to. SO-AppToken: type: string description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: - id - entity title: Parameters