Jump to

• Request
• Response

Create an agency email option

post

/fscmRestApi/resources/11.13.18.05/publicSectorAgencyEmailOptions

Request

Header Parameters

• 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

• AgencyId: integer (int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this setup applies.
• DefaultEmailFlag: string
  Title: Agency Default

  Maximum Length: 1

  The default value of the email ID.
• EmailAddressType: string
  Title: Address Type

  Maximum Length: 30

  The email address type of the recipient.
• EmailDescr: string
  Title: Description

  Maximum Length: 750

  The description of the email ID.
• EmailId: string
  Title: Email

  Maximum Length: 300

  The value of the email ID.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the email ID is enabled or not.
• FunctionalCategory: string
  Title: Functional Category

  Maximum Length: 30

  The functional category of the email address.
• OfferingId: string
  Title: Offering

  Maximum Length: 30

  The email address of the feature.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this setup applies.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "DefaultEmailFlag":{
            "title":"Agency Default",
            "maxLength":1,
            "type":"string",
            "description":"The default value of the email ID.",
            "nullable":false
        },
        "EmailAddressType":{
            "title":"Address Type",
            "maxLength":30,
            "type":"string",
            "description":"The email address type of the recipient.",
            "nullable":false
        },
        "EmailDescr":{
            "title":"Description",
            "maxLength":750,
            "type":"string",
            "description":"The description of the email ID.",
            "nullable":true
        },
        "EmailId":{
            "title":"Email",
            "maxLength":300,
            "type":"string",
            "description":"The value of the email ID.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the email ID is enabled or not.",
            "nullable":false
        },
        "FunctionalCategory":{
            "title":"Functional Category",
            "maxLength":30,
            "type":"string",
            "description":"The functional category of the email address.",
            "nullable":false
        },
        "OfferingId":{
            "title":"Offering",
            "maxLength":30,
            "type":"string",
            "description":"The email address of the feature.",
            "nullable":false
        }
    }
}

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 : publicSectorAgencyEmailOptions-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this setup applies.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the setup.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the setup was created.
• DefaultEmailFlag: string
  Title: Agency Default

  Maximum Length: 1

  The default value of the email ID.
• EmailAddressType: string
  Title: Address Type

  Maximum Length: 30

  The email address type of the recipient.
• EmailDescr: string
  Title: Description

  Maximum Length: 750

  The description of the email ID.
• EmailId: string
  Title: Email

  Maximum Length: 300

  The value of the email ID.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the email ID is enabled or not.
• FunctionalCategory: string
  Title: Functional Category

  Maximum Length: 30

  The functional category of the email address.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the setup was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who updated last.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The time when the login was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The version number of the object.
• OfferingId: string
  Title: Offering

  Maximum Length: 30

  The email address of the feature.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this setup applies.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the setup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the setup was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultEmailFlag":{
            "title":"Agency Default",
            "maxLength":1,
            "type":"string",
            "description":"The default value of the email ID.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailAddressType":{
            "title":"Address Type",
            "maxLength":30,
            "type":"string",
            "description":"The email address type of the recipient.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailDescr":{
            "title":"Description",
            "maxLength":750,
            "type":"string",
            "description":"The description of the email ID.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email",
            "maxLength":300,
            "type":"string",
            "description":"The value of the email ID.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the email ID is enabled or not.",
            "nullable":false,
            "x-queryable":true
        },
        "FunctionalCategory":{
            "title":"Functional Category",
            "maxLength":30,
            "type":"string",
            "description":"The functional category of the email address.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the setup was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The time when the login was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated last.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of the object.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OfferingId":{
            "title":"Offering",
            "maxLength":30,
            "type":"string",
            "description":"The email address of the feature.",
            "nullable":false,
            "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