Utility resources
Applies to: Partner Center | Partner Center operated by 21Vianet | Partner Center for Microsoft Cloud for US Government
The Partner Center REST API contains many resources that describe general-purpose data models used throughout the SDK.
Address
Address to use for the customer or partner profiles. For more information about the supported formats and properties in different countries/regions, see Get address formatting rules by market.
| Property | Type | Length (min, max) | Description |
|---|---|---|---|
| AddressLine1 | string | (1, 200) | The first line of the address. |
| AddressLine2 | string | (0, 200) | The second line of the address. This property is optional. |
| City | string | n/a | The city. |
| State | string | (0, 2) | The state. |
| PostalCode | string | n/a | The ZIP code or postal code. |
| Country | string | (2, 2) | The country/region in ISO country code format. |
| Region | string | n/a | The region. |
| FirstName | string | (1, 50) | The first name of a contact at the customer's company/organization. |
| LastName | string | (1, 50) | The last name of a contact at the customer's company/organization. |
| PhoneNumber | string | n/a | The phone number of a contact at the customer's company/organization. This property is optional. |
| PhoneNumber | string | n/a | The phone number of a contact at the customer's company/organization. In customer profile, this property is mandatory for customer’s company/organization located in the following countries/regions: Armenia(AM), Azerbaijan(AZ), Belarus(BY), Hungary(HU), Kazakhstan(KZ), Kyrgyzstan(KG), Moldova(MD), Russia(RU), Tajikistan(TJ), Uzbekistan(UZ), Ukraine(UA)), India, Brazil, South Africa, Poland, United Arab Emirates, Saudi Arabia, Türkiye, Thailand, Vietnam, Myanmar, Iraq, South Sudan, and Venezuela. Otherwise this is optional. |
Contact
Describes contact information for a specific individual.
| Property | Type | Description |
|---|---|---|
| FirstName | string | The contact's first name. |
| LastName | string | The contact's last name. |
| string | The contact's email address. | |
| PhoneNumber | string | The contact's phone number. |
| MiddleName | string | The contact's middle name. |
FieldFilter
Describes a filter that can be applied to search results.
| Property | Type | Description |
|---|---|---|
| Operator | string | The filter operator: "equals", "not_equals", "greater_than", "greater_than_or_equals", "less_than", "less_than_or_equals", "substring", "and", "or", "starts_with", "not_starts_with". |
FileInfo
Represents an external file uploaded to Partner Center.
| Property | Type | Description |
|---|---|---|
| Comment | string | A comment associated with the file upload. |
| FileExtension | string | The file extension. |
| FileNameWithoutExtension | string | The name of the file, extension not included. |
| FileSize | long | The size of the file. |
| Id | string | The unique ID for the file upload. |
| Location | string | The file URI. |
Link
Contains a URI link and associated information.
| Property | Type | Description |
|---|---|---|
| URI | string | The URI. |
| Method | string | The method represented by the URI. |
| Headers | Array of KeyValuePairs | The headers for the link. |
PasswordProfile
Describes a specific password and if that password needs to be changed.
Note
Unsupported on Partner Center operated by 21Vianet.
| Property | Type | Description |
|---|---|---|
| Password | SecureString | The password. |
| ForceChangePassword | boolean | Determines if the password needs to be forcibly changed on next sign-in. |
ResourceLinks
Contains a list of links for a resource.
| Property | Type | Description |
|---|---|---|
| Self | Link | The self URI. |
| Next | Link | The next page of items. |
| Previous | Link | The previous page of items. |
| Attributes | ResourceAttributes | The metadata attributes corresponding to the user. |
ResourceAttributes
Contains attribute metadata for a resource.
| Property | Type | Description |
|---|---|---|
| Etag | string | The etag, also known as the object version. |
| ObjectType | string | The type of object of the base resource. |
SecureString
Stores secured information, such as a password.
| Property | Type | Description |
|---|---|---|
| Length | int | The length of the secured string. |
ValidationCode
Represents a partner's Government Community Cloud validation code.
| Property | Type | Description |
|---|---|---|
| PartnerId | GUID | Partner identifier |
| OrganizationName | string | The organization name provided during the validation process |
| ValidationId | int | A unique identifier for validation |
| MaxCreates | nullable int | The maximum customers allowed to be created with this validation code |
| RemainingCreates | nullable int | Remaining customer creates under this validation ID |
| ETag | string | The specific version of this resource. Changes when resource is changed. |