Jump to

• Request
• Response

Add New User Assignment

post

/api/1.0/userassignment

This endpoint is used to add a new user assignment.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• contentType(optional): string
  The content type of request or response body.
• userId: string
  The user ID of requesting user.

Body ()

This request Body contains data required for creating a new User Assignment.

Root Schema : DmTmUserAssignmentDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmUserAssignmentDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "assignmentCd":{
                    "description":"Assignment Code",
                    "type":"string"
                },
                "assignmentDescr":{
                    "description":"Assignment Description",
                    "type":"string"
                },
                "priority":{
                    "description":"Priority",
                    "type":"integer"
                },
                "productProcessorCd":{
                    "description":"Product Processor Code",
                    "type":"string"
                },
                "groupBasis":{
                    "description":"Group Basis",
                    "type":"string"
                },
                "ignoreGroupBasisFlg":{
                    "description":"Ignore Group Basis Flag",
                    "type":"boolean"
                },
                "assigmentMethodCd":{
                    "description":"Assignment Method Code",
                    "type":"string"
                },
                "effectiveDate":{
                    "description":"Effective Date",
                    "type":"string"
                },
                "expiryDate":{
                    "description":"Expiry Date",
                    "type":"string"
                },
                "ruleCd":{
                    "description":"Rule Code",
                    "type":"string"
                },
                "DmTmUserAssignmentGroupsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmUserAssignmentGroupsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmUserAssignmentDTO-allOf[1]

Type: object

Show Source

• assigmentMethodCd(optional): string
  Assignment Method Code
• assignmentCd(optional): string
  Assignment Code
• assignmentDescr(optional): string
  Assignment Description
• DmTmUserAssignmentGroupsDTO(optional): array DmTmUserAssignmentGroupsDTO
• effectiveDate(optional): string
  Effective Date
• expiryDate(optional): string
  Expiry Date
• groupBasis(optional): string
  Group Basis
• ignoreGroupBasisFlg(optional): boolean
  Ignore Group Basis Flag
• priority(optional): integer
  Priority
• productProcessorCd(optional): string
  Product Processor Code
• ruleCd(optional): string
  Rule Code

{
    "type":"object",
    "properties":{
        "assignmentCd":{
            "description":"Assignment Code",
            "type":"string"
        },
        "assignmentDescr":{
            "description":"Assignment Description",
            "type":"string"
        },
        "priority":{
            "description":"Priority",
            "type":"integer"
        },
        "productProcessorCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "groupBasis":{
            "description":"Group Basis",
            "type":"string"
        },
        "ignoreGroupBasisFlg":{
            "description":"Ignore Group Basis Flag",
            "type":"boolean"
        },
        "assigmentMethodCd":{
            "description":"Assignment Method Code",
            "type":"string"
        },
        "effectiveDate":{
            "description":"Effective Date",
            "type":"string"
        },
        "expiryDate":{
            "description":"Expiry Date",
            "type":"string"
        },
        "ruleCd":{
            "description":"Rule Code",
            "type":"string"
        },
        "DmTmUserAssignmentGroupsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmUserAssignmentGroupsDTO"
            }
        }
    }
}

Nested Schema : DmTmUserAssignmentGroupsDTO

Type: array

Show Source

• Array of: object DmTmUserAssignmentGroupsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmUserAssignmentGroupsDTO"
    }
}

Nested Schema : DmTmUserAssignmentGroupsDTO

Type: object

Show Source

• activeFlg(optional): boolean
  Active Flag
• id(optional): string
  ID of the User Group
• userAssignmentMasterId(optional): string
  ID of the User Assignment
• userGroupCd(optional): string
  User Group Code

{
    "type":"object",
    "properties":{
        "userGroupCd":{
            "description":"User Group Code",
            "type":"string"
        },
        "activeFlg":{
            "description":"Active Flag",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID of the User Group"
        },
        "userAssignmentMasterId":{
            "type":"string",
            "description":"ID of the User Assignment"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Headers

• Location: string
  URL of newly created User Assignment.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input.

500 Response

Internal error.

Back to Top