Jump to

• Request
• Response

Create a contact person

post

/fscmRestApi/resources/11.13.18.05/publicSectorContactLists

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address1: string
  Maximum Length: 240

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

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

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

  The fourth address line for the contact person.
• City: string
  Maximum Length: 60

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

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

  The county for the contact person's address.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The email address information for the contact person.
• JobTitle: string
  Maximum Length: 60

  The business job title of the contact.
• OrganizationName: string
  Title: Business

  Maximum Length: 360

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

  Maximum Length: 150

  The contact person's first name.
• PersonLastName: string
  Title: Last Name

  Maximum Length: 150

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

  Maximum Length: 60

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

  The phone area code of the contact person.
• PhoneCountryCode: string
  Maximum Length: 10

  The phone country code of the contact person.
• PhoneExtension: string
  Maximum Length: 20

  The phone extension for the contact person.
• PhoneNumber: string
  Maximum Length: 40

  The phone number of the contact person.
• PostalCode: string
  Maximum Length: 60

  The postal code of the contact person's address.
• PostalPlus4Code: string
  Maximum Length: 60

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

  The province of the contact person's address.
• State: string
  Maximum Length: 60

  The state of the contact person's address.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for a registered public user  profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationName":{
            "title":"Business",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the business that the contact person is associated with.",
            "nullable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The contact person's last name.",
            "nullable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second address line for the contact person.",
            "nullable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third address line for the contact person.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the contact person's address.",
            "nullable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier for a contact person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Address1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first address line for the contact person.",
            "nullable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The city for the contact person's address.",
            "nullable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The contact person's first name.",
            "nullable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The contact person's middle name.",
            "nullable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"The county for the contact person's address.",
            "nullable":true
        },
        "JobTitle":{
            "maxLength":"60",
            "type":"string",
            "description":"The business job title of the contact.",
            "nullable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address information for the contact person.",
            "nullable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"The province of the contact person's address.",
            "nullable":true
        },
        "PhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The phone extension for the contact person.",
            "nullable":true
        },
        "PhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone area code of the contact person.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The phone country code of the contact person.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal plus-four value for the contact person's address.",
            "nullable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line for the contact person.",
            "nullable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state of the contact person's address.",
            "nullable":true
        },
        "Country":{
            "maxLength":"3",
            "type":"string",
            "description":"The country for the contact person.",
            "nullable":false
        },
        "PhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the contact person.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• Address1: string
  Maximum Length: 240

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

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

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

  The fourth address line for the contact person.
• AddressFull: string
  Read Only: true

  The formatted address of the contact person.
• City: string
  Maximum Length: 60

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

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

  The county for the contact person's address.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the contact person.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the contact person was created.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The email address information for the contact person.
• JobTitle: string
  Maximum Length: 60

  The business job title of the contact.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the contact person was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the contact person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationName: string
  Title: Business

  Maximum Length: 360

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

  Maximum Length: 150

  The contact person's first name.
• PersonFullName: string
  Read Only: true

  The full name of the contact person.
• PersonLastName: string
  Title: Last Name

  Maximum Length: 150

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

  Maximum Length: 60

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

  The phone area code of the contact person.
• PhoneCountryCode: string
  Maximum Length: 10

  The phone country code of the contact person.
• PhoneExtension: string
  Maximum Length: 20

  The phone extension for the contact person.
• PhoneFull: string
  Read Only: true

  The formatted phone number of the contact person.
• PhoneNumber: string
  Maximum Length: 40

  The phone number of the contact person.
• PostalCode: string
  Maximum Length: 60

  The postal code of the contact person's address.
• PostalPlus4Code: string
  Maximum Length: 60

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

  The province of the contact person's address.
• State: string
  Maximum Length: 60

  The state of the contact person's address.

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

Back to Top