Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SuiteDataSourceInstanceId | query | Guid | Yes | Guid representing the external systems data source information. |
AlternateKey | query | string | Yes | The unique key that represents the contact role on the external system. |
ObjectId | query | Guid | No | Guid of the contact role object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key. |
ContactRole | query | SubscriptionContactRoleModel | Yes | Object containing all details of the contact role to be inserted or updated. |
IgnoreValidation | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ValidationErrors | form | List<RuleValidationResult> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RuleCode | form | string | No | |
Message | form | string | No | |
Key | form | string | No | |
Tag | form | string | No | |
ErrorCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RoleName | query | string | No | Name of the role. |
RoleShortName | query | string | No | Short version of the role name. |
RoleDescription | query | string | No | Description of the role purpose. |
RequireContactsToAccept | query | bool | No | If true, the role will be pending for a contact until they accept it. |
ContactTypes | query | List<Guid> | No | Contact Types that may have this role. |
ListItemFilters | query | List<Guid> | No | Role Filters this role should be added to. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/SaveContactRole HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AlternateKey: String,
ContactRole:
{
RoleName: String,
RoleShortName: String,
RoleDescription: String,
RequireContactsToAccept: False,
ContactTypes:
[
00000000-0000-0000-0000-000000000000
],
ListItemFilters:
[
00000000-0000-0000-0000-000000000000
]
},
IgnoreValidation: False,
ValidationErrors:
[
{
RuleCode: String,
Message: String,
Key: String,
Tag: String,
ErrorCode: String
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } }