Jump to

• Request
• Response

Post payroll connect delivery result record

post

/hcmRestApi/resources/11.13.18.05/payrollConnectDeliveryResults

Request

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  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: string
  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: string
  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

• Actionee: string
  Maximum Length: 80

  User type to which person is assigned
• DeliveryResultDtlsId: integer (int64)
  Unique Identifier for delivery result record
• DeliverySourceId: string
  Maximum Length: 50

  Identifier for delivery source type
• DeliverySourceType: string
  Maximum Length: 10

  Type of delivery source
• ErrorCode: string
  Maximum Length: 60

  Error Code for error generated while processing for new hire
• ErrorMessage: string
  Maximum Length: 4000

  Error Message for error generated while processing for new hire
• IsUpdatable: string
  Maximum Length: 255

  Flag to indicate if delivery result record status can be updated
• NewHireEmail: string
  Maximum Length: 80

  Email address of the new hire
• NotificationDate: string (date-time)
  Date the notification was sent
• NotificationMessage: string
  Maximum Length: 4000

  Message sent in the notification
• PayrollId: integer (int64)
  Payroll for new hire
• Status: string
  Maximum Length: 80

  Processing status of the error message
• SubmittedDate: string (date-time)
  Date the error was generated
• SysEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "Actionee":{
            "maxLength":80,
            "type":"string",
            "description":"User type to which person is assigned",
            "nullable":true
        },
        "DeliveryResultDtlsId":{
            "type":"integer",
            "description":"Unique Identifier for delivery result record",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DeliverySourceId":{
            "maxLength":50,
            "type":"string",
            "description":"Identifier for delivery source type",
            "nullable":false
        },
        "DeliverySourceType":{
            "maxLength":10,
            "type":"string",
            "description":"Type of delivery source",
            "nullable":false
        },
        "ErrorCode":{
            "maxLength":60,
            "type":"string",
            "description":"Error Code for error generated while processing for new hire",
            "nullable":true
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Error Message for error generated while processing for new hire",
            "nullable":true
        },
        "IsUpdatable":{
            "maxLength":255,
            "type":"string",
            "description":"Flag to indicate if delivery result record status can be updated",
            "nullable":true,
            "x-queryable":false
        },
        "NewHireEmail":{
            "maxLength":80,
            "type":"string",
            "description":"Email address of the new hire",
            "nullable":true
        },
        "NotificationDate":{
            "type":"string",
            "description":"Date the notification was sent",
            "format":"date-time",
            "nullable":true
        },
        "NotificationMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Message sent in the notification",
            "nullable":true
        },
        "PayrollId":{
            "type":"integer",
            "description":"Payroll for new hire",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"Processing status of the error message",
            "nullable":false
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date the error was generated",
            "format":"date-time",
            "nullable":true
        },
        "SysEffectiveDate":{
            "type":"string",
            "format":"date",
            "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 : payrollConnectDeliveryResults-item-response

Type: object

Show Source

• Actionee: string
  Maximum Length: 80

  User type to which person is assigned
• DeliveryResultDtlsId: integer (int64)
  Unique Identifier for delivery result record
• DeliverySourceId: string
  Maximum Length: 50

  Identifier for delivery source type
• DeliverySourceType: string
  Maximum Length: 10

  Type of delivery source
• ErrorCode: string
  Maximum Length: 60

  Error Code for error generated while processing for new hire
• ErrorMessage: string
  Maximum Length: 4000

  Error Message for error generated while processing for new hire
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  First Name of the newly hired person for whom delivery failed
• FullName: string
  Title: Full Name

  Read Only: true

  Maximum Length: 2000

  Full Name of the newly hired person for whom delivery failed
• IsUpdatable: string
  Maximum Length: 255

  Flag to indicate if delivery result record status can be updated
• LastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Last Name of newly hired person for whom delivery failed
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewHireEmail: string
  Maximum Length: 80

  Email address of the new hire
• NotificationDate: string (date-time)
  Date the notification was sent
• NotificationMessage: string
  Maximum Length: 4000

  Message sent in the notification
• PayrollId: integer (int64)
  Payroll for new hire
• PersonId: integer (int64)
  Read Only: true

  Identifier for person
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name for new hire
• PersonNameId: integer (int64)
  Read Only: true

  Name identifier for new hire
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number for new hire
• Status: string
  Maximum Length: 80

  Processing status of the error message
• SubmittedDate: string (date-time)
  Date the error was generated
• SysEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "Actionee":{
            "maxLength":80,
            "type":"string",
            "description":"User type to which person is assigned",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveryResultDtlsId":{
            "type":"integer",
            "description":"Unique Identifier for delivery result record",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeliverySourceId":{
            "maxLength":50,
            "type":"string",
            "description":"Identifier for delivery source type",
            "nullable":false,
            "x-queryable":true
        },
        "DeliverySourceType":{
            "maxLength":10,
            "type":"string",
            "description":"Type of delivery source",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":60,
            "type":"string",
            "description":"Error Code for error generated while processing for new hire",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Error Message for error generated while processing for new hire",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First Name of the newly hired person for whom delivery failed",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":2000,
            "type":"string",
            "description":"Full Name of the newly hired person for whom delivery failed",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsUpdatable":{
            "maxLength":255,
            "type":"string",
            "description":"Flag to indicate if delivery result record status can be updated",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last Name of newly hired person for whom delivery failed",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NewHireEmail":{
            "maxLength":80,
            "type":"string",
            "description":"Email address of the new hire",
            "nullable":true,
            "x-queryable":true
        },
        "NotificationDate":{
            "type":"string",
            "description":"Date the notification was sent",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "NotificationMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Message sent in the notification",
            "nullable":true,
            "x-queryable":true
        },
        "PayrollId":{
            "type":"integer",
            "description":"Payroll for new hire",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Identifier for person",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name for new hire",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNameId":{
            "type":"integer",
            "description":"Name identifier for new hire",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number for new hire",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"Processing status of the error message",
            "nullable":false,
            "x-queryable":true
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date the error was generated",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SysEffectiveDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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