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