Jump to

• Request
• Response

Update a meeting participant

patch

/fscmRestApi/resources/11.13.18.05/publicSectorMeetingParticipants/{publicSectorMeetingParticipantsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorMeetingParticipantsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- ParticipantNum and MeetingId ---for the Meeting Participants resource and used to uniquely identify an instance of Meeting Participants. The client should not generate the hash key value. Instead, the client should query on the Meeting Participants collection resource with a filter on the primary key values in order to navigate to a specific instance of Meeting Participants.
  
  For example: publicSectorMeetingParticipants?q=ParticipantNum=<value1>;MeetingId=<value2>

Body ()

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

Root Schema : publicSectorMeetingParticipants-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the public sector agency.
• IsOrganizer(optional): string
  Title: Organizer

  Maximum Length: 1

  The identifier to indicate that the user the meeting organizer.
• links(optional): array Items
  Title: Items

  Link Relations
• MeetingId(optional): integer(int64)
  Title: Meeting ID

  The unique identifier of the meeting to which the participant is associated.
• ParticipantNum(optional): integer(int64)
  Indicates the participant associated with the meeting.
• PartyId(optional): integer(int64)
  Title: Registered Public User ID

  The identifier of the registered user.
• PersonId(optional): integer(int64)
  Title: Worker ID

  The identifier of the agency staff.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "IsOrganizer":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate that the user the meeting organizer.",
            "title":"Organizer"
        },
        "MeetingId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the meeting to which the participant is associated.",
            "title":"Meeting ID"
        },
        "ParticipantNum":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the participant associated with the meeting."
        },
        "PartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the registered user.",
            "title":"Registered Public User ID"
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of  the agency staff.",
            "title":"Worker ID"
        },
        "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 : publicSectorMeetingParticipants-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the public sector agency.
• IsOrganizer(optional): string
  Title: Organizer

  Maximum Length: 1

  The identifier to indicate that the user the meeting organizer.
• links(optional): array Items
  Title: Items

  Link Relations
• MeetingId(optional): integer(int64)
  Title: Meeting ID

  The unique identifier of the meeting to which the participant is associated.
• ParticipantNum(optional): integer(int64)
  Indicates the participant associated with the meeting.
• PartyId(optional): integer(int64)
  Title: Registered Public User ID

  The identifier of the registered user.
• PersonId(optional): integer(int64)
  Title: Worker ID

  The identifier of the agency staff.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "IsOrganizer":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier to indicate that the user the meeting organizer.",
            "title":"Organizer"
        },
        "MeetingId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the meeting to which the participant is associated.",
            "title":"Meeting ID"
        },
        "ParticipantNum":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the participant associated with the meeting."
        },
        "PartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the registered user.",
            "title":"Registered Public User ID"
        },
        "PersonId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of  the agency staff.",
            "title":"Worker ID"
        },
        "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