Jump to

• Request
• Response

Get an Event Invitation

get

/crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventInvitations/{InvitationNumber}

Request

Path Parameters

• EventNumber: string
  Identifier to Events
• InvitationNumber: string
  Identifier to Event Invitations

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : autoEvents-EventInvitations-item

Type: object

Show Source

• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  A system-generated read-only attribute used by the application framework.
• CorpCurrencyCode(optional): string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the record was created.
• CurcyConvRateType(optional): string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the record.
• CurrencyCode(optional): string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the record like USD or EUR.
• CustomerId(optional): integer(int64)
  Title: Customer ID

  The unique identifier of the customer.
• EmailAddress(optional): string
  Title: Email

  Maximum Length: 100

  The email Id of the guest.
• EventId(optional): integer(int64)
  Title: Event ID

  The unique identifier of the event.
• EventInviteId(optional): integer(int64)
  Title: Event Invite ID

  The unique identifier of the event invite.
• GuestFirstName(optional): string
  Title: First Name

  Maximum Length: 100

  The first name of the guest.
• GuestLastName(optional): string
  Title: Last Name

  Maximum Length: 100

  The last name of the guest.
• GuestPhoneNumber1(optional): string
  Title: Mobile Phone 1

  Maximum Length: 30

  The phone number of guest.
• GuestPhoneNumber2(optional): string
  Title: Mobile Phone 2

  Maximum Length: 30

  The phone number of guest.
• GuestPhoneNumber3(optional): string
  Title: Mobile Phone 3

  Maximum Length: 30

  The phone number of guest.
• InvitationNumber(optional): string
  Title: Invitation

  Maximum Length: 30

  The public unique identifier of the invitation.
• InvitationSentDate(optional): string(date)
  Title: Sent Date

  The date when the invitation was sent.
• InvitationStatus(optional): string
  Title: Status

  Maximum Length: 30

  The status of the invitations.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the record was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin(optional): string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the record.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  A system-generated read-only attribute used by the application framework.
• OrgId(optional): integer(int64)
  Title: Business Unit

  The business unit associated with the record.
• OriginSystem(optional): string
  Title: Origin System Reference

  Maximum Length: 400

  The application from where the order originated.
• OriginSystemReference(optional): string
  Title: Origin System Reference

  Maximum Length: 400

  The unique identifier of the record in the source application.

{
    "properties":{
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Attribute Category"
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the record.",
            "title":"Corporate Currency Code"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was created.",
            "title":"Creation Date"
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the record.",
            "title":"Conversion Rate Type"
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the record like USD or EUR.",
            "title":"Currency Code"
        },
        "CustomerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the customer.",
            "title":"Customer ID"
        },
        "EmailAddress":{
            "maxLength":100,
            "type":"string",
            "description":"The email Id of the guest.",
            "title":"Email"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the event.",
            "title":"Event ID"
        },
        "EventInviteId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the event invite. ",
            "title":"Event Invite ID"
        },
        "GuestFirstName":{
            "maxLength":100,
            "type":"string",
            "description":"The first name of the guest.",
            "title":"First Name"
        },
        "GuestLastName":{
            "maxLength":100,
            "type":"string",
            "description":"The last name of the guest.",
            "title":"Last Name"
        },
        "GuestPhoneNumber1":{
            "maxLength":30,
            "type":"string",
            "description":"The phone number of guest.",
            "title":"Mobile Phone 1"
        },
        "GuestPhoneNumber2":{
            "maxLength":30,
            "type":"string",
            "description":"The phone number of guest.",
            "title":"Mobile Phone 2"
        },
        "GuestPhoneNumber3":{
            "maxLength":30,
            "type":"string",
            "description":"The phone number of guest.",
            "title":"Mobile Phone 3"
        },
        "InvitationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the invitation.",
            "title":"Invitation"
        },
        "InvitationSentDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the invitation was sent.",
            "title":"Sent Date"
        },
        "InvitationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the invitations.",
            "title":"Status"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "title":"Last Update Login"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Last Updated By"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Object Version Number"
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The business unit associated with the record.",
            "title":"Business Unit"
        },
        "OriginSystem":{
            "maxLength":400,
            "type":"string",
            "description":"The application from where the order originated.",
            "title":"Origin System Reference"
        },
        "OriginSystemReference":{
            "maxLength":400,
            "type":"string",
            "description":"The unique identifier of the record in the source application.",
            "title":"Origin System Reference"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "x-links":[
        {
            "rel":"lov",
            "title":"InvitationStatus LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: InvitationStatus; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_AHT_EVNT_INVITE_STATUS",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        }
    ],
    "type":"object"
}

Relationships

InvitationStatus LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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