Create a case contact
post
/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCaseContacts-item
Type:
Show Source
object
-
AccessApprovedBy(optional):
string
Maximum Length:
64
The username of the user who approved the case access request. -
AccessApprovedByUser(optional):
string
The name of the user who approved the case access request.
-
AccessApprovedDate(optional):
string(date-time)
The approved date for the case access request.
-
AccessComments(optional):
string
Maximum Length:
1000
The access comments provided by the case contact. -
AccessStatus(optional):
string
Title:
Online Access Status
Maximum Length:30
The access status of the case contact. -
Address1(optional):
string
Maximum Length:
240
The first line for the address of the case contact. -
Address2(optional):
string
Maximum Length:
240
The second line for the address of the case contact. -
Address3(optional):
string
Maximum Length:
240
The third line for the address of the case contact. -
Address4(optional):
string
Maximum Length:
240
The fourth line for the address of the case contact. -
AgencyComments(optional):
string
Maximum Length:
1000
The comments by the agency staff. -
BusinessName(optional):
string
Maximum Length:
254
The business name of the case contact. -
CaseContactKey(optional):
integer(int64)
The unique identifier of the case contact.
-
CaseContactPuid(optional):
string
Maximum Length:
480
The public unique identifier of the migrated case contact record. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CasePuid(optional):
string
Maximum Length:
480
The public unique identifier of the migrated case record. -
City(optional):
string
Maximum Length:
60
The city of the case contact. -
ClaimantContactType(optional):
string
Maximum Length:
255
The meaning of the contact type code. -
ClaimantUserName(optional):
string
The username of the case claimant.
-
ContactAccessStatus(optional):
string
Maximum Length:
255
The meaning of the access status code. -
ContactFullname(optional):
string
Maximum Length:
255
The full name of the responsible party. -
ContactPartyId(optional):
integer(int64)
The party ID of the case contact.
-
ContactPartyPuid(optional):
string
The public unique identifier of the migrated contact party record.
-
ContactType(optional):
string
Title:
Type
Maximum Length:15
The type of contact for the case. -
Country(optional):
string
Maximum Length:
3
The country of the case contact. -
County(optional):
string
Maximum Length:
60
The county of the case contact. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
EmailAddress(optional):
string
Maximum Length:
254
The email address of the case contact. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
LastUpdatedByUser(optional):
string
The name of the user who last updated the row.
-
LegacyApproverName(optional):
string
Maximum Length:
100
The name of the legacy system approver for the migrated data. -
links(optional):
array Items
Title:
Items
Link Relations -
PersonFirstName(optional):
string
Title:
First Name
Maximum Length:150
The first name of case contact. -
PersonLastName(optional):
string
Title:
Last Name
Maximum Length:150
The last name of case contact. -
PersonMiddleName(optional):
string
Title:
Middle Name
Maximum Length:60
The middle name of case contact. -
PersonNameSuffix(optional):
string
Title:
Name Suffix
Maximum Length:30
The suffix for the case contact. -
PersonTitle(optional):
string
Title:
Title
Maximum Length:60
The title of the case contact name. -
PhoneAreaCode(optional):
string
Maximum Length:
10
The phone area code of the responsible party. -
PhoneCountryCode(optional):
string
Maximum Length:
10
The phone country code of the responsible party. -
PhoneExtension(optional):
string
Maximum Length:
20
The phone extension code of the responsible party. -
PhoneNumber(optional):
string
Maximum Length:
100
The phone number of the case contact. -
PostalCode(optional):
string
Maximum Length:
60
The postal code of the case contact. -
PostalPlusCode(optional):
string
Maximum Length:
10
The postal plus code of the case contact. -
PrimaryFlag(optional):
string
Title:
Primary
Maximum Length:1
Indicates if the contact is the primary case contact. -
Province(optional):
string
Maximum Length:
60
The province of case contact. -
State(optional):
string
Maximum Length:
60
The state of the case contact. -
Status(optional):
string
Maximum Length:
1
Indicates the status of the responsible party. Values can be Active or Inactive. -
UserEmail(optional):
string
Maximum Length:
254
The email of the responsible party. -
UserFirstName(optional):
string
Maximum Length:
150
The first name of the case claimant. -
UserLastName(optional):
string
Maximum Length:
150
The last name of the case claimant. -
UserPhoneAreaCode(optional):
string
Maximum Length:
10
The phone area code of the responsible party. -
UserPhoneCountryCode(optional):
string
Maximum Length:
10
The phone country code of the responsible party. -
UserPhoneExtension(optional):
string
Maximum Length:
20
The phone extension of the responsible party requesting access. -
UserPhoneNumber(optional):
string
Maximum Length:
100
The phone number of the responsible party requesting access.
Nested Schema : link
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCaseContacts-item
Type:
Show Source
object
-
AccessApprovedBy(optional):
string
Maximum Length:
64
The username of the user who approved the case access request. -
AccessApprovedByUser(optional):
string
The name of the user who approved the case access request.
-
AccessApprovedDate(optional):
string(date-time)
The approved date for the case access request.
-
AccessComments(optional):
string
Maximum Length:
1000
The access comments provided by the case contact. -
AccessStatus(optional):
string
Title:
Online Access Status
Maximum Length:30
The access status of the case contact. -
Address1(optional):
string
Maximum Length:
240
The first line for the address of the case contact. -
Address2(optional):
string
Maximum Length:
240
The second line for the address of the case contact. -
Address3(optional):
string
Maximum Length:
240
The third line for the address of the case contact. -
Address4(optional):
string
Maximum Length:
240
The fourth line for the address of the case contact. -
AgencyComments(optional):
string
Maximum Length:
1000
The comments by the agency staff. -
BusinessName(optional):
string
Maximum Length:
254
The business name of the case contact. -
CaseContactKey(optional):
integer(int64)
The unique identifier of the case contact.
-
CaseContactPuid(optional):
string
Maximum Length:
480
The public unique identifier of the migrated case contact record. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CasePuid(optional):
string
Maximum Length:
480
The public unique identifier of the migrated case record. -
City(optional):
string
Maximum Length:
60
The city of the case contact. -
ClaimantContactType(optional):
string
Maximum Length:
255
The meaning of the contact type code. -
ClaimantUserName(optional):
string
The username of the case claimant.
-
ContactAccessStatus(optional):
string
Maximum Length:
255
The meaning of the access status code. -
ContactFullname(optional):
string
Maximum Length:
255
The full name of the responsible party. -
ContactPartyId(optional):
integer(int64)
The party ID of the case contact.
-
ContactPartyPuid(optional):
string
The public unique identifier of the migrated contact party record.
-
ContactType(optional):
string
Title:
Type
Maximum Length:15
The type of contact for the case. -
Country(optional):
string
Maximum Length:
3
The country of the case contact. -
County(optional):
string
Maximum Length:
60
The county of the case contact. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
EmailAddress(optional):
string
Maximum Length:
254
The email address of the case contact. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
LastUpdatedByUser(optional):
string
The name of the user who last updated the row.
-
LegacyApproverName(optional):
string
Maximum Length:
100
The name of the legacy system approver for the migrated data. -
links(optional):
array Items
Title:
Items
Link Relations -
PersonFirstName(optional):
string
Title:
First Name
Maximum Length:150
The first name of case contact. -
PersonLastName(optional):
string
Title:
Last Name
Maximum Length:150
The last name of case contact. -
PersonMiddleName(optional):
string
Title:
Middle Name
Maximum Length:60
The middle name of case contact. -
PersonNameSuffix(optional):
string
Title:
Name Suffix
Maximum Length:30
The suffix for the case contact. -
PersonTitle(optional):
string
Title:
Title
Maximum Length:60
The title of the case contact name. -
PhoneAreaCode(optional):
string
Maximum Length:
10
The phone area code of the responsible party. -
PhoneCountryCode(optional):
string
Maximum Length:
10
The phone country code of the responsible party. -
PhoneExtension(optional):
string
Maximum Length:
20
The phone extension code of the responsible party. -
PhoneNumber(optional):
string
Maximum Length:
100
The phone number of the case contact. -
PostalCode(optional):
string
Maximum Length:
60
The postal code of the case contact. -
PostalPlusCode(optional):
string
Maximum Length:
10
The postal plus code of the case contact. -
PrimaryFlag(optional):
string
Title:
Primary
Maximum Length:1
Indicates if the contact is the primary case contact. -
Province(optional):
string
Maximum Length:
60
The province of case contact. -
State(optional):
string
Maximum Length:
60
The state of the case contact. -
Status(optional):
string
Maximum Length:
1
Indicates the status of the responsible party. Values can be Active or Inactive. -
UserEmail(optional):
string
Maximum Length:
254
The email of the responsible party. -
UserFirstName(optional):
string
Maximum Length:
150
The first name of the case claimant. -
UserLastName(optional):
string
Maximum Length:
150
The last name of the case claimant. -
UserPhoneAreaCode(optional):
string
Maximum Length:
10
The phone area code of the responsible party. -
UserPhoneCountryCode(optional):
string
Maximum Length:
10
The phone country code of the responsible party. -
UserPhoneExtension(optional):
string
Maximum Length:
20
The phone extension of the responsible party requesting access. -
UserPhoneNumber(optional):
string
Maximum Length:
100
The phone number of the responsible party requesting access.
Nested Schema : link
Type:
Show Source
object
-
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.