Skip to content

Assigned by versus defined by #322

Description

@larsolofsson

papiNet has both AssignedBy and Agency in the XML standard.
papinet has only assignedBy in the API standard.

A party can assign a code defined by an agency to a thing.
In papiNet API the supplier has the role of an agency defining codes and identifiers to be used by logistics parties.

It might be confusing in some descriptions when assigned by is used instead of defined by.
The proposal is to make difference between assigned by and defined by in descriptions
Examples:
In locations and parties

       identifierBySupplier:
          type: string
          minLength: 1
          description: The identifier assigned by the _Supplier_.

to be changed to

       identifierBySupplier:
          type: string
          minLength: 1
          description: The identifier defined by the _Supplier_.

In the reference construct

                  assignedByIdentifierBySupplier:
                    type: string
                    minLength: 1
                    description: The identifier of the assigning party assigned by the _Supplier_.

To be changed to

                  assignedByIdentifierBySupplier:
                    type: string
                    minLength: 1
                    description: The identifier of the assigning party defined by the _Supplier_.

For codes:

                    code:
                      type: object
                      unevaluatedProperties: false
                      required:
                        - value
                        - assignedBy
                      properties:
                        value:
                          type: string
                          minLength: 1
                        assignedBy:
                          type: string
                          enum:
                            - Supplier

to be changed to

                    codeBySupplier:
                       type: string
                       minLength: 1 
                       description: The code defined by the _Supplier_

Metadata

Metadata

Assignees

No one assigned

    Labels

    MUST BE DISCUSSEDMust be discussed during the next CWG meeting

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions