Update a subscription account role
patch
/crmRestApi/resources/11.13.18.05/subscriptionAccountRoles/{SubscrAccRoleNumber}
Request
Path Parameters
-
SubscrAccRoleNumber(required): string
The alternate unique identifier of the subscription account role.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the subscription account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the subscription account to which the role is associated. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The unique alternate identifier for the subscription account. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. -
RoleName: string
Title:
Role
Maximum Length:30
The role name of the subscription account.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptionAccountRoles-item-response
Type:
Show Source
object
-
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the subscription account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the subscription account role. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the subscription account role was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the role is to be deleted. If the value is Y, then the role has to be deleted. The default value is N. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The primary email address of the party. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the subscription account role was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the subscription account role. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the subscription account role. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the subscription account to which the role is associated. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the subscription account. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The unique alternate identifier for the subscription account. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
The type of the party associated with the subscription account. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. -
RoleName: string
Title:
Role
Maximum Length:30
The role name of the subscription account. -
SubscrAccMgmtRoleId: integer
(int64)
Title:
Subscription Account Roles ID
Read Only:true
The unique identifier of the subscription account role. -
SubscrAccountNumber: string
Title:
Subscription Account Number
Maximum Length:30
The alternate unique identifier of the subscription account. -
SubscrAccRoleNumber: string
Title:
Subscription Account Role Number
Maximum Length:30
The alternate unique identifier of the subscription account role. -
SubscriptionAccountId: integer
(int64)
Title:
Subscription Account ID
The unique identifier of the subscription account associated with the role. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the role can be updated. If the value is Y, then the role can be updated. The default value is N.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- RoleNameListVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_ROLE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: RoleName; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: