Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "GeographyName":{
            "title":"Geography Served",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the geography being served.",
            "nullable":false
        },
        "GeographyId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the geography being served.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerId":{
            "type":"integer",
            "description":"The identifier of the entity that owns the relationship with the dimension data. For example, partner profile, partner program, or enrollment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartnerDimMembersId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The unique identifier for the partner geography .",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : partners-geographies-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionMemberName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the geography served.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the geography being served.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"The identifier of the entity that owns the relationship with the dimension data. For example, partner profile, partner program, or enrollment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography Served",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the geography being served.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartnerDimMembersId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The unique identifier for the partner geography .",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "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

AllGeographyLookup

Back to Top