Create a geography for a partner
post
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies
Request
Path Parameters
-
CompanyNumber(required): string
The alternate key identifier of the partner's company.
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
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
GeographyId: string
Maximum Length:
30
The unique identifier of the geography being served. -
GeographyName: string
Title:
Geography Served
Maximum Length:360
The name of the geography being served. -
OwnerId: integer
(int64)
The identifier of the entity that owns the relationship with the dimension data. For example, partner profile, partner program, or enrollment.
-
PartnerDimMembersId: integer
(int64)
Title:
Geography ID
The unique identifier for the partner geography .
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : partners-geographies-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DimensionMemberName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the geography served. -
GeographyId: string
Maximum Length:
30
The unique identifier of the geography being served. -
GeographyName: string
Title:
Geography Served
Maximum Length:360
The name of the geography being served. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerId: integer
(int64)
The identifier of the entity that owns the relationship with the dimension data. For example, partner profile, partner program, or enrollment.
-
PartnerDimMembersId: integer
(int64)
Title:
Geography ID
The unique identifier for the partner geography .
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
- AllGeographyLookup