Jump to

• Request
• Response

Create a subscription account relationship

post

/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship

Request

Path Parameters

• SubscrAccountNumber(required): string
  The alternate unique identifier of the subscription account.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Comments: string
  Title: Comments

  Maximum Length: 2000

  The comments for subscription account relationship.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the subscription account relationship. 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.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The date when the record was created.
• PartyId: integer (int64)
  Title: Sales Account ID

  The unique identifier of the party.
• PartyNumber: string
  Title: Registry ID

  Maximum Length: 30

  The alternate identifier of the record.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  The type of the relationship.
• SubscriptionAccountId: integer (int64)
  Title: Subscription Account ID

  The unique identifier of the subscription account.
• SubscriptionAccountRelationshipNumber: string
  Title: Subscription Account Relationship Number

  Maximum Length: 30

  The alternate identifier of the subscription account relationship.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the record.",
            "nullable":false
        },
        "PartyId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriptionAccountRelationshipNumber":{
            "title":"Subscription Account Relationship Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the subscription account relationship.",
            "nullable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments for subscription account relationship.",
            "nullable":true
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartyId",
                    "PartyNumber",
                    "PartyType"
                ]
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the subscription account relationship. 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.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : subscriptionAccounts-subscriptionAccountRelationship-item-response

Type: object

Show Source

• Comments: string
  Title: Comments

  Maximum Length: 2000

  The comments for subscription account relationship.
• ContactId: integer
  Title: Contact ID

  Read Only: true

  The unique identifier of the contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code associated with the subscription account relationship. 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 record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The date when the record was created.
• DeleteFlag: boolean
  Read Only: true

  The rate of currency conversion for a subscription account.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates whether the account relationship can be deleted.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The login of the user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The date when the record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Sales Account ID

  The unique identifier of the party.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the party.
• PartyNumber: string
  Title: Registry ID

  Maximum Length: 30

  The alternate identifier of the record.
• PartyType: string
  Title: Party Type

  Read Only: true

  Maximum Length: 30

  The type of the party.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  The type of the relationship.
• RelationshipTypeLookup: string
  Title: Relationship Type Lookup Code

  Read Only: true

  The relationship type lookup associated with the subscription account relationship. It's used to expose the Lookup code of RelationshipType field based on Party Type.
• SalesAccountId: integer
  Title: Sales Account ID

  Read Only: true

  The unique identifier of the sales account.
• SubscrAccountNumber: string
  Title: Subscription Account Number

  Read Only: true

  Maximum Length: 30

  The alternate identifier of the subscription account.
• SubscriptionAccountId: integer (int64)
  Title: Subscription Account ID

  The unique identifier of the subscription account.
• SubscriptionAccountRelationshipId: integer (int64)
  Title: Subscription Account Relationship ID

  Read Only: true

  The unique identifier of the subscription account relationship.
• SubscriptionAccountRelationshipNumber: string
  Title: Subscription Account Relationship Number

  Maximum Length: 30

  The alternate identifier of the subscription account relationship.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionAccountRelationshipNumber":{
            "title":"Subscription Account Relationship Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the subscription account relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The comments for subscription account relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartyId",
                    "PartyNumber",
                    "PartyType"
                ]
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionAccountRelationshipId":{
            "title":"Subscription Account Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"The rate of currency conversion for a subscription account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipTypeLookup":{
            "title":"Relationship Type Lookup Code",
            "type":"string",
            "description":"The relationship type lookup associated with the subscription account relationship. It's used to expose the Lookup code of RelationshipType field based on Party Type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyType"
                ]
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the subscription account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the subscription account relationship. 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.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates whether the account relationship can be deleted.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesAccountId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the sales account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

OrganizationVA

Operation: /crmRestApi/resources/11.13.18.05/accounts

The following properties are defined on the LOV link relation:

• Source Attribute: SalesAccountId; Target Attribute: PartyId
• Display Attribute: PartyUniqueName

PersonVA

Operation: /crmRestApi/resources/11.13.18.05/contacts

The following properties are defined on the LOV link relation:

• Source Attribute: ContactId; Target Attribute: PartyId
• Display Attribute: ContactName

RelationshipTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3D{RelationshipTypeLookup}

The following properties are defined on the LOV link relation:

• Source Attribute: RelationshipType; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top