Jump to

• Request
• Response

Create a business profile of a registered public user

post

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorBusinessProfiles-item

Type: object

Show Source

• BusinessName(optional): string
  Maximum Length: 60

  The business name for a registered public user account business profile.
• BusinessType(optional): string
  Maximum Length: 30

  The business type for a registered public user account business profile.
• CntrctrVerificationStatus(optional): string
  Maximum Length: 2

  The verification status of a registered public user's standing as a contractor.
• IsContractor(optional): string
  Maximum Length: 1

  Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.
• links(optional): array Items
  Title: Items

  Link Relations
• ProfileContactPointEmail(optional): array Profile Emails
  Title: Profile Emails

  The business profiles resource is used to view, create, or modify a registered public user business profile.
• ProfileContactPointPhone(optional): array Profile Phones
  Title: Profile Phones

  The business profiles resource is used to view, create, or modify a registered public user business profile.
• ProfileId(optional): integer(int64)
  The unique identifier for a registered public user account profile.
• ProfileLocation(optional): array Profile Locations
  Title: Profile Locations

  The business profiles resource is used to view, create, or modify a registered public user business profile.
• ProfileName(optional): string
  Maximum Length: 60

  The registered public user account profile name.
• ProfileStatus(optional): string
  Maximum Length: 1

  The profile status. Valid values are A for active and I for inactive.
• PscUserId(optional): integer(int64)
  The unique identifier for a registered public user reference row.

{
    "properties":{
        "BusinessName":{
            "maxLength":60,
            "type":"string",
            "description":"The business name for a registered public user account business profile."
        },
        "BusinessType":{
            "maxLength":30,
            "type":"string",
            "description":"The business type for a registered public user account business profile."
        },
        "CntrctrVerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a contractor."
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no."
        },
        "ProfileContactPointEmail":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointEmail-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Emails"
        },
        "ProfileContactPointPhone":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointPhone-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Phones"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a registered public user account profile."
        },
        "ProfileLocation":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileLocation-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Locations"
        },
        "ProfileName":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user account profile name."
        },
        "ProfileStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A for active and I for inactive."
        },
        "PscUserId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a registered public user reference row."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Profile Emails

Type: array

Title: Profile Emails

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointEmail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointEmail-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Emails"
}

Nested Schema : Profile Phones

Type: array

Title: Profile Phones

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointPhone-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointPhone-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Phones"
}

Nested Schema : Profile Locations

Type: array

Title: Profile Locations

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileLocation-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileLocation-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Locations"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorBusinessProfiles-ProfileContactPointEmail-item

Type: object

Show Source

• ContactPointPurpose(optional): string
  Title: Type

  The email type. Valid values are BUSINESS for work and PERSONAL for home.
• ContactPtId(optional): integer(int64)
  The unique identifier for the email contact point.
• EmailAddress(optional): string
  Title: Email

  The email address for the email contact point.
• links(optional): array Items
  Title: Items

  Link Relations
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.
• ProfileId(optional): integer(int64)
  The unique identifier for the profile that is associated with the email contact point.
• Status(optional): string
  The status of the email contact point. Valid values are A for active and I for inactive.

{
    "properties":{
        "ContactPointPurpose":{
            "type":"string",
            "description":"The email type. Valid values are BUSINESS for work and PERSONAL for home.",
            "title":"Type"
        },
        "ContactPtId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the email contact point."
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email address for the email contact point.",
            "title":"Email"
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the email contact point."
        },
        "Status":{
            "type":"string",
            "description":"The status of the email contact point. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorBusinessProfiles-ProfileContactPointPhone-item

Type: object

Show Source

• ContactPointPurpose(optional): string
  Title: Type

  The phone type. Valid values are BUSINESS for work and PERSONAL for home.
• ContactPtId(optional): integer(int64)
  The unique identifier for the phone contact point.
• links(optional): array Items
  Title: Items

  Link Relations
• PhoneAreaCode(optional): string
  The phone area code.
• PhoneCountryCode(optional): string
  The phone country code.
• PhoneExtension(optional): string
  The phone extension.
• PhoneFull(optional): string
  The full formatted phone number.
• PhoneNumber(optional): string
  The phone number.
• PhoneType(optional): string
  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.
• ProfileId(optional): integer(int64)
  The unique identifier for the profile that is associated with the phone contact point.
• Status(optional): string
  The status of the phone contact point. Valid values are A for active and I for inactive.

{
    "properties":{
        "ContactPointPurpose":{
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "title":"Type"
        },
        "ContactPtId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the phone contact point."
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code."
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code."
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension."
        },
        "PhoneFull":{
            "type":"string",
            "description":"The full formatted phone number."
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number."
        },
        "PhoneType":{
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the phone contact point."
        },
        "Status":{
            "type":"string",
            "description":"The status of the phone contact point. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorBusinessProfiles-ProfileLocation-item

Type: object

Show Source

• Address1(optional): string
  The first line of the address.
• Address2(optional): string
  The second line of the address.
• Address3(optional): string
  The third line of the address.
• Address4(optional): string
  The fourth line of the address.
• AddressFull(optional): string
  The full address for a profile address.
• City(optional): string
  The city of the address.
• Country(optional): string
  The country of the address.
• County(optional): string
  The county of the address.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationSiteId(optional): integer(int64)
  The unique identifier for a profile address.
• OnlineFlag(optional): string
  Maximum Length: 1

  Indicates whether this location has a website. Valid values are Y for yes and N for no.
• PostalCode(optional): string
  The postal code of the address.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.
• ProfileId(optional): integer(int64)
  The unique identifier for the profile that is associated with the address.
• SiteUseType(optional): string
  Title: Type

  The address type. Valid values are BUSINESS for business and HOME for home.
• State(optional): string
  The state for the address.
• Status(optional): string
  The status of the address. Valid values are A for active and I for inactive.

{
    "properties":{
        "Address1":{
            "type":"string",
            "description":"The first line of the address."
        },
        "Address2":{
            "type":"string",
            "description":"The second line of the address."
        },
        "Address3":{
            "type":"string",
            "description":"The third line of the address."
        },
        "Address4":{
            "type":"string",
            "description":"The fourth line of the address."
        },
        "AddressFull":{
            "type":"string",
            "description":"The full address for a profile address."
        },
        "City":{
            "type":"string",
            "description":"The city of the address."
        },
        "Country":{
            "type":"string",
            "description":"The country of the address."
        },
        "County":{
            "type":"string",
            "description":"The county of the address."
        },
        "LocationSiteId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a profile address."
        },
        "OnlineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this location has a website. Valid values are Y for yes and N for no."
        },
        "PostalCode":{
            "type":"string",
            "description":"The postal code of the address."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the address."
        },
        "SiteUseType":{
            "type":"string",
            "description":"The address type. Valid values are BUSINESS for business and HOME for home.",
            "title":"Type"
        },
        "State":{
            "type":"string",
            "description":"The state for the address."
        },
        "Status":{
            "type":"string",
            "description":"The status of the address. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBusinessProfiles-item

Type: object

Show Source

• BusinessName(optional): string
  Maximum Length: 60

  The business name for a registered public user account business profile.
• BusinessType(optional): string
  Maximum Length: 30

  The business type for a registered public user account business profile.
• CntrctrVerificationStatus(optional): string
  Maximum Length: 2

  The verification status of a registered public user's standing as a contractor.
• IsContractor(optional): string
  Maximum Length: 1

  Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.
• links(optional): array Items
  Title: Items

  Link Relations
• ProfileContactPointEmail(optional): array Profile Emails
  Title: Profile Emails

  The business profiles resource is used to view, create, or modify a registered public user business profile.
• ProfileContactPointPhone(optional): array Profile Phones
  Title: Profile Phones

  The business profiles resource is used to view, create, or modify a registered public user business profile.
• ProfileId(optional): integer(int64)
  The unique identifier for a registered public user account profile.
• ProfileLocation(optional): array Profile Locations
  Title: Profile Locations

  The business profiles resource is used to view, create, or modify a registered public user business profile.
• ProfileName(optional): string
  Maximum Length: 60

  The registered public user account profile name.
• ProfileStatus(optional): string
  Maximum Length: 1

  The profile status. Valid values are A for active and I for inactive.
• PscUserId(optional): integer(int64)
  The unique identifier for a registered public user reference row.

{
    "properties":{
        "BusinessName":{
            "maxLength":60,
            "type":"string",
            "description":"The business name for a registered public user account business profile."
        },
        "BusinessType":{
            "maxLength":30,
            "type":"string",
            "description":"The business type for a registered public user account business profile."
        },
        "CntrctrVerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The verification status of a registered public user's standing as a contractor."
        },
        "IsContractor":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no."
        },
        "ProfileContactPointEmail":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointEmail-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Emails"
        },
        "ProfileContactPointPhone":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointPhone-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Phones"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a registered public user account profile."
        },
        "ProfileLocation":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileLocation-item"
            },
            "type":"array",
            "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
            "title":"Profile Locations"
        },
        "ProfileName":{
            "maxLength":60,
            "type":"string",
            "description":"The registered public user account profile name."
        },
        "ProfileStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The profile status. Valid values are  A for active and I for inactive."
        },
        "PscUserId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a registered public user reference row."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Profile Emails

Type: array

Title: Profile Emails

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointEmail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointEmail-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Emails"
}

Nested Schema : Profile Phones

Type: array

Title: Profile Phones

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileContactPointPhone-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileContactPointPhone-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Phones"
}

Nested Schema : Profile Locations

Type: array

Title: Profile Locations

The business profiles resource is used to view, create, or modify a registered public user business profile.

Show Source

• Array of: object publicSectorBusinessProfiles-ProfileLocation-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessProfiles-ProfileLocation-item"
    },
    "type":"array",
    "description":"The business profiles resource is used to view, create, or modify a registered public user business profile.",
    "title":"Profile Locations"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorBusinessProfiles-ProfileContactPointEmail-item

Type: object

Show Source

• ContactPointPurpose(optional): string
  Title: Type

  The email type. Valid values are BUSINESS for work and PERSONAL for home.
• ContactPtId(optional): integer(int64)
  The unique identifier for the email contact point.
• EmailAddress(optional): string
  Title: Email

  The email address for the email contact point.
• links(optional): array Items
  Title: Items

  Link Relations
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.
• ProfileId(optional): integer(int64)
  The unique identifier for the profile that is associated with the email contact point.
• Status(optional): string
  The status of the email contact point. Valid values are A for active and I for inactive.

{
    "properties":{
        "ContactPointPurpose":{
            "type":"string",
            "description":"The email type. Valid values are BUSINESS for work and PERSONAL for home.",
            "title":"Type"
        },
        "ContactPtId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the email contact point."
        },
        "EmailAddress":{
            "type":"string",
            "description":"The email address for the email contact point.",
            "title":"Email"
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the email contact point."
        },
        "Status":{
            "type":"string",
            "description":"The status of the email contact point. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorBusinessProfiles-ProfileContactPointPhone-item

Type: object

Show Source

• ContactPointPurpose(optional): string
  Title: Type

  The phone type. Valid values are BUSINESS for work and PERSONAL for home.
• ContactPtId(optional): integer(int64)
  The unique identifier for the phone contact point.
• links(optional): array Items
  Title: Items

  Link Relations
• PhoneAreaCode(optional): string
  The phone area code.
• PhoneCountryCode(optional): string
  The phone country code.
• PhoneExtension(optional): string
  The phone extension.
• PhoneFull(optional): string
  The full formatted phone number.
• PhoneNumber(optional): string
  The phone number.
• PhoneType(optional): string
  The phone type. Valid values are WORK, HOME, and MOBILE.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.
• ProfileId(optional): integer(int64)
  The unique identifier for the profile that is associated with the phone contact point.
• Status(optional): string
  The status of the phone contact point. Valid values are A for active and I for inactive.

{
    "properties":{
        "ContactPointPurpose":{
            "type":"string",
            "description":"The phone type. Valid values are BUSINESS for work and PERSONAL for home.",
            "title":"Type"
        },
        "ContactPtId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the phone contact point."
        },
        "PhoneAreaCode":{
            "type":"string",
            "description":"The phone area code."
        },
        "PhoneCountryCode":{
            "type":"string",
            "description":"The phone country code."
        },
        "PhoneExtension":{
            "type":"string",
            "description":"The phone extension."
        },
        "PhoneFull":{
            "type":"string",
            "description":"The full formatted phone number."
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The phone number."
        },
        "PhoneType":{
            "type":"string",
            "description":"The phone type. Valid values are WORK, HOME, and MOBILE."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the phone contact point."
        },
        "Status":{
            "type":"string",
            "description":"The status of the phone contact point. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorBusinessProfiles-ProfileLocation-item

Type: object

Show Source

• Address1(optional): string
  The first line of the address.
• Address2(optional): string
  The second line of the address.
• Address3(optional): string
  The third line of the address.
• Address4(optional): string
  The fourth line of the address.
• AddressFull(optional): string
  The full address for a profile address.
• City(optional): string
  The city of the address.
• Country(optional): string
  The country of the address.
• County(optional): string
  The county of the address.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationSiteId(optional): integer(int64)
  The unique identifier for a profile address.
• OnlineFlag(optional): string
  Maximum Length: 1

  Indicates whether this location has a website. Valid values are Y for yes and N for no.
• PostalCode(optional): string
  The postal code of the address.
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.
• ProfileId(optional): integer(int64)
  The unique identifier for the profile that is associated with the address.
• SiteUseType(optional): string
  Title: Type

  The address type. Valid values are BUSINESS for business and HOME for home.
• State(optional): string
  The state for the address.
• Status(optional): string
  The status of the address. Valid values are A for active and I for inactive.

{
    "properties":{
        "Address1":{
            "type":"string",
            "description":"The first line of the address."
        },
        "Address2":{
            "type":"string",
            "description":"The second line of the address."
        },
        "Address3":{
            "type":"string",
            "description":"The third line of the address."
        },
        "Address4":{
            "type":"string",
            "description":"The fourth line of the address."
        },
        "AddressFull":{
            "type":"string",
            "description":"The full address for a profile address."
        },
        "City":{
            "type":"string",
            "description":"The city of the address."
        },
        "Country":{
            "type":"string",
            "description":"The country of the address."
        },
        "County":{
            "type":"string",
            "description":"The county of the address."
        },
        "LocationSiteId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a profile address."
        },
        "OnlineFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this location has a website. Valid values are Y for yes and N for no."
        },
        "PostalCode":{
            "type":"string",
            "description":"The postal code of the address."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no.",
            "title":"Primary"
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the profile that is associated with the address."
        },
        "SiteUseType":{
            "type":"string",
            "description":"The address type. Valid values are BUSINESS for business and HOME for home.",
            "title":"Type"
        },
        "State":{
            "type":"string",
            "description":"The state for the address."
        },
        "Status":{
            "type":"string",
            "description":"The status of the address. Valid values are A for active and I for inactive."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top