Get a subscription party
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}
Request
Path Parameters
-
PartyPuid(required): string
The alternate identifier of the party.
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : subscriptions-parties-item-response
Type:
Show Source
object
-
contacts: array
Contacts
Title:
Contacts
The contacts resource to view, create, update, and delete the contacts in a subscription party. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the party. -
CreationDate: string
(date-time)
Read Only:
true
The date when the party was created. -
InternalFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the party is internal or not. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the party was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the party. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the party. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyName: string
Title:
Name
The name of the party. -
PartyNumber: string
Title:
Party Number
The alternate identifier of the party. -
PartyPuid: string
Maximum Length:
120
The alternate identifier of the party. -
PartyRole: string
Title:
Role
Maximum Length:20
The role of the party. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the party is primary or not. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionPartyId: integer
(int64)
The unique identifier of the subscription party.
Nested Schema : Contacts
Type:
array
Title:
Contacts
The contacts resource to view, create, update, and delete the contacts in a subscription party.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-parties-contacts-item-response
Type:
Show Source
object
-
AccessLevel: string
Maximum Length:
302
The access level of the contact. -
BillingOwnerFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether this contact is a billing owner or not. -
ContactEmail: string
Title:
Email
The contact's email address. -
ContactId: integer
(int64)
The unique identifier of the contact.
-
ContactName: string
Title:
Name
The contact name. -
ContactNumber: string
Title:
Party Contact Number
The contact number. -
ContactPuid: string
Maximum Length:
120
The alternate subscription contact. -
ContactRole: string
Title:
Role
Maximum Length:30
The contact role. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the contact. -
CreationDate: string
(date-time)
Read Only:
true
The date when the contact was created. -
EndDate: string
(date)
The end date of the contact.
-
InternalFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether this contact is internal or not. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the contact was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the contact. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number. -
OwnerFlag: boolean
Title:
Owner
Maximum Length:1
Default Value:false
Indicates whether the contact is the owner. -
PartyId: integer
The unique identifier of the party.
-
StartDate: string
(date)
The start date of the contact.
-
SubscriptionContactId: integer
(int64)
The unique identifier of the subscription contact.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionPartyId: integer
(int64)
The unique identifier of the subscription party.
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
- contacts
-
Parameters:
- PartyPuid:
$request.path.PartyPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
The contacts resource to view, create, update, and delete the contacts in a subscription party. - PartyPuid:
Examples
The following example shows how to get a subscription party by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/parties/GP-5678-PRTY-9
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "SubscriptionPartyId": 300100177254426, "PartyPuid": "GP-5678-PRTY-9", "SubscriptionId": 300100177254423, "PartyRole": "ORA_CUSTOMER", "PartyId": 1001, "PrimaryFlag": true, "InternalFlag": false, "ObjectVersionNumber": 1, "CreatedBy": "CONMGR", "CreationDate": "2019-06-04T04:25:08.026+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2019-06-04T04:25:08.875+00:00", "LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656", "PartyName": "A T & T SOLUTIONS INC", "PartyNumber": "1001", ... }