Create subscription parties
post
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties
Request
Path Parameters
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
contacts: array
Contacts
Title:
Contacts
The contacts resource to view, create, update, and delete the contacts in a subscription party. -
InternalFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the party is internal or not. -
PartyId(required): 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(required): string
Maximum Length:
120
The alternate identifier of the party. -
PartyRole(required): 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(required): 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 : schema
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. -
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. -
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.
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 : 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 examples shows how to create a subscription party by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP5678/child/parties
Request Body
The following shows the contents of the request body in JSON format.
{ "PartyPuid": "GP-5678-PRTY-24", "PartyRole": "ORA_CUSTOMER", "PartyId": 300100070252912, "PrimaryFlag": false, "InternalFlag": false }
Response Body
The following shows the contents of the response body in JSON format.
{ "SubscriptionPartyId": 300100177241440, "PartyPuid": "GP-5678-PRTY-24", "SubscriptionId": 300100177254423, "PartyRole": "ORA_CUSTOMER", "PartyId": 300100070252912, "PrimaryFlag": false, "InternalFlag": false, "ObjectVersionNumber": 1, "CreatedBy": "CONMGR", "CreationDate": "2019-06-04T18:39:36+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2019-06-04T18:39:36.173+00:00", "LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4", "PartyName": " Clarke James", "PartyNumber": "CDRM_154814", ... }