Jump to

• Request
• Response

Update a contact person

patch

/fscmRestApi/resources/11.13.18.05/publicSectorContactLists/{ContactId}

Request

Supported Media Types

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

Path Parameters

• ContactId: integer
  The unique identifier for a contact person.

Body ()

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

Root Schema : publicSectorContactLists-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  The first address line for the contact person.
• Address2(optional): string
  Maximum Length: 240

  The second address line for the contact person.
• Address3(optional): string
  Maximum Length: 240

  The third address line for the contact person.
• Address4(optional): string
  Maximum Length: 240

  The fourth address line for the contact person.
• AddressFull(optional): string
  The formatted address for the contact person.
• City(optional): string
  Maximum Length: 60

  The city for the contact person's address.
• ContactId(optional): integer(int64)
  The unique identifier for a contact person.
• Country(optional): string
  Maximum Length: 3

  The country for the contact person.
• County(optional): string
  Maximum Length: 60

  The county for the contact person's address.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the contact person.
• CreationDate(optional): string(date-time)
  The date and time that the contact person was created.
• EmailAddress(optional): string
  Title: Email

  Maximum Length: 320

  The email address information for the contact person.
• LastUpdateDate(optional): string(date-time)
  The date and time when the contact person was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the contact person.
• links(optional): array Items
  Title: Items

  Link Relations
• OrganizationName(optional): string
  Title: Business

  Maximum Length: 360

  The name of the business that the contact person is associated with.
• PersonFirstName(optional): string
  Title: First Name

  Maximum Length: 150

  The contact person's first name.
• PersonFullName(optional): string
  The contact person's full name.
• PersonLastName(optional): string
  Title: Last Name

  Maximum Length: 150

  The contact person's last name.
• PersonMiddleName(optional): string
  Title: Middle Name

  Maximum Length: 60

  The contact person's middle name.
• PhoneAreaCode(optional): string
  Maximum Length: 10

  The phone area code for the contact person.
• PhoneCountryCode(optional): string
  Maximum Length: 10

  The phone country code for the contact person.
• PhoneExtension(optional): string
  Maximum Length: 20

  The phone extension for the contact person.
• PhoneFull(optional): string
  The formatted phone number for the contact person.
• PhoneNumber(optional): string
  Maximum Length: 40

  The phone number for the contact person.
• PostalCode(optional): string
  Maximum Length: 60

  The postal code for the contact person's address.
• PostalPlus4Code(optional): string
  Maximum Length: 60

  The postal plus-four value for the contact person's address.
• ProfileId(optional): integer(int64)
  The unique identifier for a registered public user profile.
• Province(optional): string
  Maximum Length: 60

  The province for the contact person's address.
• State(optional): string
  Maximum Length: 60

  The state for the contact person's address.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first address line for the contact person."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address line for the contact person."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third address line for the contact person."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line for the contact person."
        },
        "AddressFull":{
            "type":"string",
            "description":"The formatted address for the contact person."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city for the contact person's address."
        },
        "ContactId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a contact person."
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country for the contact person."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county for the contact person's address."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact person."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contact person was created."
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address information for the contact person.",
            "title":"Email"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the contact person was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact person."
        },
        "OrganizationName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the business that the contact person is associated with.",
            "title":"Business"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The contact person's first name.",
            "title":"First Name"
        },
        "PersonFullName":{
            "type":"string",
            "description":"The contact person's full name."
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The contact person's last name.",
            "title":"Last Name"
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The contact person's middle name.",
            "title":"Middle Name"
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code for the contact person."
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code for the contact person."
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension for the contact person."
        },
        "PhoneFull":{
            "type":"string",
            "description":"The formatted phone number for the contact person."
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number for the contact person."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the contact person's address."
        },
        "PostalPlus4Code":{
            "maxLength":60,
            "type":"string",
            "description":"The postal plus-four value for the contact person's address."
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a registered public user  profile."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province for the contact person's address."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state for the contact person's address."
        },
        "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 : 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"
}

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 : publicSectorContactLists-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  The first address line for the contact person.
• Address2(optional): string
  Maximum Length: 240

  The second address line for the contact person.
• Address3(optional): string
  Maximum Length: 240

  The third address line for the contact person.
• Address4(optional): string
  Maximum Length: 240

  The fourth address line for the contact person.
• AddressFull(optional): string
  The formatted address for the contact person.
• City(optional): string
  Maximum Length: 60

  The city for the contact person's address.
• ContactId(optional): integer(int64)
  The unique identifier for a contact person.
• Country(optional): string
  Maximum Length: 3

  The country for the contact person.
• County(optional): string
  Maximum Length: 60

  The county for the contact person's address.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the contact person.
• CreationDate(optional): string(date-time)
  The date and time that the contact person was created.
• EmailAddress(optional): string
  Title: Email

  Maximum Length: 320

  The email address information for the contact person.
• LastUpdateDate(optional): string(date-time)
  The date and time when the contact person was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the contact person.
• links(optional): array Items
  Title: Items

  Link Relations
• OrganizationName(optional): string
  Title: Business

  Maximum Length: 360

  The name of the business that the contact person is associated with.
• PersonFirstName(optional): string
  Title: First Name

  Maximum Length: 150

  The contact person's first name.
• PersonFullName(optional): string
  The contact person's full name.
• PersonLastName(optional): string
  Title: Last Name

  Maximum Length: 150

  The contact person's last name.
• PersonMiddleName(optional): string
  Title: Middle Name

  Maximum Length: 60

  The contact person's middle name.
• PhoneAreaCode(optional): string
  Maximum Length: 10

  The phone area code for the contact person.
• PhoneCountryCode(optional): string
  Maximum Length: 10

  The phone country code for the contact person.
• PhoneExtension(optional): string
  Maximum Length: 20

  The phone extension for the contact person.
• PhoneFull(optional): string
  The formatted phone number for the contact person.
• PhoneNumber(optional): string
  Maximum Length: 40

  The phone number for the contact person.
• PostalCode(optional): string
  Maximum Length: 60

  The postal code for the contact person's address.
• PostalPlus4Code(optional): string
  Maximum Length: 60

  The postal plus-four value for the contact person's address.
• ProfileId(optional): integer(int64)
  The unique identifier for a registered public user profile.
• Province(optional): string
  Maximum Length: 60

  The province for the contact person's address.
• State(optional): string
  Maximum Length: 60

  The state for the contact person's address.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first address line for the contact person."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address line for the contact person."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third address line for the contact person."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line for the contact person."
        },
        "AddressFull":{
            "type":"string",
            "description":"The formatted address for the contact person."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city for the contact person's address."
        },
        "ContactId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a contact person."
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country for the contact person."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county for the contact person's address."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact person."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contact person was created."
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address information for the contact person.",
            "title":"Email"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the contact person was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact person."
        },
        "OrganizationName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the business that the contact person is associated with.",
            "title":"Business"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The contact person's first name.",
            "title":"First Name"
        },
        "PersonFullName":{
            "type":"string",
            "description":"The contact person's full name."
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The contact person's last name.",
            "title":"Last Name"
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The contact person's middle name.",
            "title":"Middle Name"
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code for the contact person."
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code for the contact person."
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension for the contact person."
        },
        "PhoneFull":{
            "type":"string",
            "description":"The formatted phone number for the contact person."
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number for the contact person."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the contact person's address."
        },
        "PostalPlus4Code":{
            "maxLength":60,
            "type":"string",
            "description":"The postal plus-four value for the contact person's address."
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a registered public user  profile."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province for the contact person's address."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state for the contact person's address."
        },
        "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 : 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"
}

Back to Top