Jump to

• Request
• Response

Create one contact

post

/fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/contacts

Request

Path Parameters

• CarrierId(required): integer(int64)
  The value that uniquely identifies the carrier. It is a primary key that the application generates when it creates a carrier.

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

• EmailAddress: string
  Title: E-Mail

  Maximum Length: 320

  The email address of the person who is a contact at the carrier.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the person who is a contact at the carrier.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the person who is a contact at the carrier.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the person who is a contact at the carrier. This attribute is required.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The phone number of the person who is a contact at the carrier.

{
    "type":"object",
    "properties":{
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the person who is a contact at the carrier.",
            "nullable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person who is a contact at the carrier. This attribute is required.",
            "nullable":false
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the person who is a contact at the carrier.",
            "nullable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person who is a contact at the carrier.",
            "nullable":true
        },
        "EmailAddress":{
            "title":"E-Mail",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the person who is a contact at the carrier.",
            "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(required):
  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(required):
  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 : carriers-contacts-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• EmailAddress: string
  Title: E-Mail

  Maximum Length: 320

  The email address of the person who is a contact at the carrier.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the person who is a contact at the carrier.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the person who is a contact at the carrier.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the person who is a contact at the carrier. This attribute is required.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The phone number of the person who is a contact at the carrier.
• RelationshipRecordId: integer
  Read Only: true

  The value that uniquely identifies the contact for the carrier. It is a value that the application generates when it creates a contact.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipRecordId":{
            "type":"integer",
            "description":"The value that uniquely identifies the contact for the carrier. It is a value that the application generates when it creates a contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person who is a contact at the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the person who is a contact at the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person who is a contact at the carrier. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the person who is a contact at the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"E-Mail",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the person who is a contact at the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "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