openapi: 3.2.0 info: title: Open Gateway Operate API Onboarding and Ordering Application Owner API description: "**TMF931 - API Ordering, Developer & Application Onboarding and Management** \n\nThis Operate API specification covers the onboarding operations between Channel Partners and Operators as described by GSMA. It offers a consolidation of multiple TM Forum based APIs into a single specification (a component suite). This API specification proposes : \n- Application Owner (Developer) Management (acceptance, onboarding, lifecycle management) \n- Application Management (acceptance, onboarding, lifecycle management) \n- Service API Management (ordering, retrieving)\n\nThis API is a composite DCS (Domain Context Specialization) of the following TMF Open APIs for Open Gateway context\n- TMF622 Product Ordering Management v5.0\n- TMF637 Product Inventory Management v5.0\n- TMF669 Party Role Management v5.0\n- TMF639 Resource Inventory v5.0\n\nCopyright © TM Forum 2025. All Rights Reserved\n" version: 5.2.1 x-generation-tooling-version: v8.5.15 x-generation-data-model-version: unknown x-generation-date: '2025-12-11T09:49:01.463Z' x-api-id: TMF931 license: name: Apache License 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 servers: - url: '{apiRoot}/openGatewayOperateAPIOnboardingAndOrdering/v5/' variables: apiRoot: default: https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5 enum: - https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5 tags: - name: applicationOwner description: Operations for ApplicationOwner Resource paths: /applicationOwner: post: tags: - applicationOwner summary: Creates a ApplicationOwner description: This operation creates a ApplicationOwner entity. operationId: createApplicationOwner parameters: - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/ApplicationOwner_FVO' responses: '201': $ref: '#/components/responses/201ApplicationOwner' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' get: tags: - applicationOwner summary: List or find ApplicationOwner objects description: List or find ApplicationOwner objects operationId: listApplicationOwner parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200ApplicationOwnerArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' /applicationOwner/{id}: get: tags: - applicationOwner summary: Retrieves a ApplicationOwner by ID description: This operation retrieves a ApplicationOwner entity. Attribute selection enabled for all first level attributes. operationId: retrieveApplicationOwner parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200ApplicationOwner_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' patch: tags: - applicationOwner summary: Updates partially a ApplicationOwner description: This operation updates partially a ApplicationOwner entity. operationId: patchApplicationOwner parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/ApplicationOwner_MVO' responses: '200': $ref: '#/components/responses/200ApplicationOwner_Patch' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' components: schemas: ApplicationOwner_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Application Owner represents the role played by the organization that owns an Application that can consume API products. It's a specialization of a PartyRole in the Open Gateway context. properties: name: type: string description: A word, term, or phrase by which the ApplicationOwner is known and distinguished from other PartyRoles. It's the name of the ApplicationOwner unique entity. description: type: string description: A description of the ApplicationOwner. engagedParty: $ref: '#/components/schemas/ApplicationOwnerOrganization_FVO' required: - engagedParty - name - description discriminator: propertyName: '@type' mapping: ApplicationOwner: '#/components/schemas/ApplicationOwner_FVO' ApplicationOwnerOrganization_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Application Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data. It's a specialization of Party in the Open Gateway context. properties: name: type: string description: Organization name (department name for example) nameType: type: string description: 'Type of the name : Co, Inc, Ltd, etc.' tradingName: type: string description: Name that the organization (unit) trades under organizationType: $ref: '#/components/schemas/DpvOrganizationType' organizationIdentification: type: array items: $ref: '#/components/schemas/OrganizationIdentification_FVO' description: List of official identifiers given to the organization, for example company number in the registry of companies isLegalEntity: type: boolean description: If value is true, the organization is a legal entity known by a national referential. externalReference: type: array items: $ref: '#/components/schemas/ExternalIdentifier_FVO' description: List of identifiers of the Party in an external system, for example when party information is imported from a commerce system contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium_FVO' description: List of means for contacting the party, e.g. mobile phone, email address legalRepresentative: $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' localRepresentative: type: array items: $ref: '#/components/schemas/ApplicationOwnerRelatedLocalRepresentative_FVO' description: Represents a Party representing the Organization within a geographic localization. dataProtectionOfficer: $ref: '#/components/schemas/ApplicationOwnerPartyOrPartyRole_FVO' privacyManager: $ref: '#/components/schemas/ApplicationOwnerPartyOrPartyRole_FVO' registeredGeographicAddress: $ref: '#/components/schemas/LightGeographicAddress_FVO' taxNumber: type: string description: Tax number of the Organization in the country privacyPolicyURL: type: string description: Url to privacy policy. required: - contactMedium - name - organizationIdentification - registeredGeographicAddress - taxNumber - tradingName discriminator: propertyName: '@type' mapping: ApplicationOwnerOrganization: '#/components/schemas/ApplicationOwnerOrganization_FVO' Entity: type: object description: Base entity schema for use in TMForum Open-APIs. Property. allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' LightGeographicSubAddress: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Representation of a GeographicSubAddress. It is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building. properties: buildingName: type: string description: allows for buildings that have well-known names levelNumber: type: string description: used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2 levelType: type: string description: describes level types within a building privateStreetName: type: string description: private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office. privateStreetNumber: type: string description: private streets numbers internal to a private street discriminator: propertyName: '@type' mapping: LightGeographicSubAddress: '#/components/schemas/LightGeographicSubAddress' Error: discriminator: propertyName: '@type' mapping: Error: '#/components/schemas/Error' allOf: - $ref: '#/components/schemas/Extensible' - type: object required: - code - reason properties: code: type: string description: Application relevant detail, defined in the API or a common list. reason: type: string description: Explanation of the reason for the error which can be shown to a client user. message: type: string description: More details and corrective actions related to the error which can be shown to a client user. status: type: string description: HTTP Error code extension referenceError: type: string description: URI of documentation describing the error. description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx) ApplicationOwnerRelatedLocalRepresentative_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApplicationOwnerRelatedLocalRepresentative represents a Party representing the Organization within a geographic localization. properties: countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' representative: $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' required: - representative - countryCode discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedLocalRepresentative: '#/components/schemas/ApplicationOwnerRelatedLocalRepresentative_FVO' Addressable: type: object description: Base schema for addressable entities properties: href: type: string description: Hyperlink reference id: type: string description: unique identifier ContactMedium: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'Indicates the contact medium that could be used to contact the party. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : EmailContactMedium, FaxContactMedium, PhoneContactMedium, GeographicAddressContactMedium, SocialMediaContactMedium...' properties: id: type: string description: Identifier for this contact medium. preferred: type: boolean description: If true, indicates that is the preferred contact medium contactType: type: string description: Type of the contact medium to qualify it like pro email / personal email. This is not used to define the contact medium used. validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: ContactMedium: '#/components/schemas/ContactMedium' EmailContactMedium: '#/components/schemas/EmailContactMedium' FaxContactMedium: '#/components/schemas/FaxContactMedium' GeographicAddressContactMedium: '#/components/schemas/GeographicAddressContactMedium' PhoneContactMedium: '#/components/schemas/PhoneContactMedium' SocialContactMedium: '#/components/schemas/SocialContactMedium' WebFormContactMedium: '#/components/schemas/WebFormContactMedium' AttachmentRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures properties: description: type: string description: A narrative text describing the content of the attachment url: description: Link to the attachment media/content type: string discriminator: propertyName: '@type' mapping: AttachmentRef: '#/components/schemas/AttachmentRef' ApplicationOwner_RES: type: object description: Response object for ApplicationOwner allOf: - $ref: '#/components/schemas/ApplicationOwner' required: - id - href discriminator: propertyName: '@type' mapping: ApplicationOwner: '#/components/schemas/ApplicationOwner' ISO31661Alpha2StandardIdentifier: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: The corresponding identification of the resource in different standard, regulatory definitions. The standard specification identifier (e.g., ISO 3166-1 Alpha-2) and the corresponding value (e.g., BE) relevant to a particular resource. properties: value: type: string description: The value of the resource in the ISO 3166-1 Alpha 2 standard pattern: '[A-Z]{2}' example: GB discriminator: propertyName: '@type' mapping: ISO31661Alpha2StandardIdentifier: '#/components/schemas/ISO31661Alpha2StandardIdentifier' Attachment_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Complements the description of an element (for instance a product) through video, pictures... properties: name: type: string description: The name of the attachment description: type: string description: A narrative text describing the content of the attachment example: Photograph of the Product url: type: string description: Uniform Resource Locator, is a web page address (a subset of URI) example: https://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f content: type: string format: base64 description: The actual contents of the attachment object, if embedded, encoded as base64 size: $ref: '#/components/schemas/Quantity' validFor: $ref: '#/components/schemas/TimePeriod' attachmentType: type: string description: a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy mimeType: type: string description: a technical characterization of the attachment content format using IETF Mime Types required: - attachmentType - mimeType discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment_FVO' Attachment: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Complements the description of an element (for instance a product) through video, pictures... properties: name: type: string description: The name of the attachment description: type: string description: A narrative text describing the content of the attachment example: Photograph of the Product url: type: string description: Uniform Resource Locator, is a web page address (a subset of URI) example: https://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f content: type: string format: base64 description: The actual contents of the attachment object, if embedded, encoded as base64 size: $ref: '#/components/schemas/Quantity' validFor: $ref: '#/components/schemas/TimePeriod' attachmentType: type: string description: a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy mimeType: type: string description: a technical characterization of the attachment content format using IETF Mime Types discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment' JsonPatch: type: object description: A JSONPatch document as defined by RFC 6902 required: - op - path properties: op: type: string description: The operation to be performed enum: - add - remove - replace - move - copy - test path: type: string description: A JSON-Pointer value: description: The value to be used within the operations. from: type: string description: A string containing a JSON Pointer value. OrganizationIdentification_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Represents our registration of information used as proof of identity by an organization properties: identificationId: type: string description: Identifier issuingAuthority: type: string description: Authority which has issued the identifier (chamber of commerce...) issuingDate: type: string format: date-time description: Date at which the identifier was issued identificationType: type: string description: Type of identification information used to identify the company in a country or internationally validFor: $ref: '#/components/schemas/TimePeriod' attachment: $ref: '#/components/schemas/AttachmentRefOrValue_FVO' required: - identificationId discriminator: propertyName: '@type' mapping: OrganizationIdentification: '#/components/schemas/OrganizationIdentification_FVO' ApplicationOwnerOrganization: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Application Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data. It's a specialization of Party in the Open Gateway context. properties: name: type: string description: Organization name (department name for example) nameType: type: string description: 'Type of the name : Co, Inc, Ltd, etc.' tradingName: type: string description: Name that the organization (unit) trades under organizationType: $ref: '#/components/schemas/DpvOrganizationType' organizationIdentification: type: array items: $ref: '#/components/schemas/OrganizationIdentification' description: List of official identifiers given to the organization, for example company number in the registry of companies isLegalEntity: type: boolean description: If value is true, the organization is a legal entity known by a national referential. externalReference: type: array items: $ref: '#/components/schemas/ExternalIdentifier' description: List of identifiers of the Party in an external system, for example when party information is imported from a commerce system contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium' description: List of means for contacting the party, e.g. mobile phone, email address legalRepresentative: $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual' localRepresentative: type: array items: $ref: '#/components/schemas/ApplicationOwnerRelatedLocalRepresentative' description: Represents a Party representing the Organization within a geographic localization. dataProtectionOfficer: $ref: '#/components/schemas/ApplicationOwnerPartyOrPartyRole' privacyManager: $ref: '#/components/schemas/ApplicationOwnerPartyOrPartyRole' registeredGeographicAddress: $ref: '#/components/schemas/LightGeographicAddress' taxNumber: type: string description: Tax number of the Organization in the country privacyPolicyURL: type: string description: Url to privacy policy. discriminator: propertyName: '@type' mapping: ApplicationOwnerOrganization: '#/components/schemas/ApplicationOwnerOrganization' ApplicationOwnerRelatedIndividual: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApplicationOwnerRelatedIndividual represents an Individual that has a role within the ApplicationOwner, in the Open Gateway context. Typically an employee of the company. properties: familyName: type: string description: Contains the non-chosen or inherited name. Also known as last name in the Western context givenName: type: string description: First name of the individual contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium' description: List of means for contacting the party, e.g. mobile phone, email address discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedIndividual: '#/components/schemas/ApplicationOwnerRelatedIndividual' ApplicationOwnerStatusType: enum: - active - inactive type: string description: Used to track the lifecycle status of the ApplicationOwner in Channel Partner IT. So this attribute is allowed to be contributed by the Channel Partner and patchable. OrganizationIdentification: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Represents our registration of information used as proof of identity by an organization properties: identificationId: type: string description: Identifier issuingAuthority: type: string description: Authority which has issued the identifier (chamber of commerce...) issuingDate: type: string format: date-time description: Date at which the identifier was issued identificationType: type: string description: Type of identification information used to identify the company in a country or internationally validFor: $ref: '#/components/schemas/TimePeriod' attachment: $ref: '#/components/schemas/AttachmentRefOrValue' discriminator: propertyName: '@type' mapping: OrganizationIdentification: '#/components/schemas/OrganizationIdentification' JsonPatchOperations: description: JSONPatch Operations document as defined by RFC 6902 type: array items: $ref: '#/components/schemas/JsonPatch' ApplicationOwnerRelatedIndividual_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApplicationOwnerRelatedIndividual represents an Individual that has a role within the ApplicationOwner, in the Open Gateway context. Typically an employee of the company. properties: familyName: type: string description: Contains the non-chosen or inherited name. Also known as last name in the Western context givenName: type: string description: First name of the individual contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium_FVO' description: List of means for contacting the party, e.g. mobile phone, email address required: - familyName - givenName - contactMedium discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedIndividual: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' ISO31661Alpha2StandardIdentifier_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: The corresponding identification of the resource in different standard, regulatory definitions. The standard specification identifier (e.g., ISO 3166-1 Alpha-2) and the corresponding value (e.g., BE) relevant to a particular resource. properties: value: type: string description: The value of the resource in the ISO 3166-1 Alpha 2 standard pattern: '[A-Z]{2}' example: GB required: - value discriminator: propertyName: '@type' mapping: ISO31661Alpha2StandardIdentifier: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' ApplicationOwnerRelatedOrganization: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApplicationOwnerRelatedOrganization represents an Organization that has a role within the ApplicationOwner, in the Open Gateway context. Typically a department inside the company. properties: name: type: string description: Organization name (department name for example) contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium' description: List of means for contacting the party, e.g. mobile phone, email address organizationType: $ref: '#/components/schemas/DpvOrganizationType' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedOrganization: '#/components/schemas/ApplicationOwnerRelatedOrganization' DpvOrganizationType: enum: - dpv:AcademicScientificOrganisation - dpv:ForProfitOrganisation - dpv:GovernmentalOrganisation - dpv:IndustryConsortium - dpv:InternationalOrganisation - dpv:NonGovernmentalOrganisation - dpv:NonProfitOrganisation - dpv:OrganisationalUnit type: string description: Valid values for a type of organization based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv. ApplicationOwnerRelatedOrganization_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApplicationOwnerRelatedOrganization represents an Organization that has a role within the ApplicationOwner, in the Open Gateway context. Typically a department inside the company. properties: name: type: string description: Organization name (department name for example) contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium_FVO' description: List of means for contacting the party, e.g. mobile phone, email address organizationType: $ref: '#/components/schemas/DpvOrganizationType' required: - name - contactMedium discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedOrganization: '#/components/schemas/ApplicationOwnerRelatedOrganization_FVO' ApplicationOwner_MVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Application Owner represents the role played by the organization that owns an Application that can consume API products. It's a specialization of a PartyRole in the Open Gateway context. properties: name: type: string description: A word, term, or phrase by which the ApplicationOwner is known and distinguished from other PartyRoles. It's the name of the ApplicationOwner unique entity. description: type: string description: A description of the ApplicationOwner. engagedParty: $ref: '#/components/schemas/ApplicationOwnerOrganization' status: $ref: '#/components/schemas/ApplicationOwnerStatusType' statusReason: type: string description: A string providing an explanation on the value of the Status lifecycle. For instance if the Status is Rejected, statusReason will provide the reason for rejection. discriminator: propertyName: '@type' mapping: ApplicationOwner: '#/components/schemas/ApplicationOwner_MVO' Quantity: type: object description: An amount in a given unit properties: amount: type: number format: float default: 1 description: Numeric value in a given unit units: type: string description: Unit LightGeographicAddress_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress' properties: streetNr: type: string description: Number identifying a specific property on a public street. streetName: type: string description: Name of the street locality: type: string description: An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature, or a suburb, a bounded locality within a city, town or shire principally of urban character city: type: string description: City that the address is in stateOrProvince: type: string description: the State or Province that the address is in countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' postcode: type: string description: descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode) geographicSubAddress: $ref: '#/components/schemas/LightGeographicSubAddress' required: - city - countryCode discriminator: propertyName: '@type' mapping: LightGeographicAddress: '#/components/schemas/LightGeographicAddress_FVO' ApplicationOwnerRelatedLocalRepresentative: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApplicationOwnerRelatedLocalRepresentative represents a Party representing the Organization within a geographic localization. properties: countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' representative: $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedLocalRepresentative: '#/components/schemas/ApplicationOwnerRelatedLocalRepresentative' ApplicationOwnerPartyOrPartyRole_FVO: type: object description: Schema that permits to identify an Individual or an Organisation in the Open Gateway context. oneOf: - $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' - $ref: '#/components/schemas/ApplicationOwnerRelatedOrganization_FVO' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedIndividual: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' ApplicationOwnerRelatedOrganization: '#/components/schemas/ApplicationOwnerRelatedOrganization_FVO' ApplicationOwner: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Application Owner represents the role played by the organization that owns an Application that can consume API products. It's a specialization of a PartyRole in the Open Gateway context. properties: name: type: string description: A word, term, or phrase by which the ApplicationOwner is known and distinguished from other PartyRoles. It's the name of the ApplicationOwner unique entity. description: type: string description: A description of the ApplicationOwner. engagedParty: $ref: '#/components/schemas/ApplicationOwnerOrganization' channelPartner: $ref: '#/components/schemas/PartyRoleRef' approvalStatus: $ref: '#/components/schemas/ApprovalStatusType' approvalStatusReason: type: string description: The reason why the approval status changed. status: $ref: '#/components/schemas/ApplicationOwnerStatusType' statusReason: type: string description: A string providing an explanation on the value of the Status lifecycle. For instance if the Status is Rejected, statusReason will provide the reason for rejection. validFor: $ref: '#/components/schemas/TimePeriod' creationDate: type: string format: date-time description: Date and time when the ApplicationOwner was created discriminator: propertyName: '@type' mapping: ApplicationOwner: '#/components/schemas/ApplicationOwner' ContactMedium_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'Indicates the contact medium that could be used to contact the party. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : EmailContactMedium, FaxContactMedium, PhoneContactMedium, GeographicAddressContactMedium, SocialMediaContactMedium...' properties: id: type: string description: Identifier for this contact medium. preferred: type: boolean description: If true, indicates that is the preferred contact medium contactType: type: string description: Type of the contact medium to qualify it like pro email / personal email. This is not used to define the contact medium used. validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: ContactMedium: '#/components/schemas/ContactMedium_FVO' EmailContactMedium: '#/components/schemas/EmailContactMedium' FaxContactMedium: '#/components/schemas/FaxContactMedium' GeographicAddressContactMedium: '#/components/schemas/GeographicAddressContactMedium' PhoneContactMedium: '#/components/schemas/PhoneContactMedium' SocialContactMedium: '#/components/schemas/SocialContactMedium' WebFormContactMedium: '#/components/schemas/WebFormContactMedium_FVO' EntityRef: allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' - type: object description: Entity reference schema to be use for all entityRef class. properties: id: type: string description: The identifier of the referred entity. href: type: string description: The URI of the referred entity. name: type: string description: Name of the referred entity. '@referredType': type: string description: The actual type of the target instance when needed for disambiguation. required: - id Extensible: type: object description: Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type properties: '@type': type: string description: When sub-classing, this defines the sub-class Extensible name '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string description: A URI to a JSON-Schema file that defines additional attributes and relationships required: - '@type' TimePeriod: type: object description: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both properties: startDateTime: description: Start of the time period, using IETC-RFC-3339 format type: string format: date-time example: '1985-04-12T23:20:50.52Z' endDateTime: description: End of the time period, using IETC-RFC-3339 format type: string format: date-time example: '1985-04-12T23:20:50.52Z' ExternalIdentifier: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier' ExternalIdentifier_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. required: - id discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier_FVO' AttachmentRefOrValue_FVO: type: object description: The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself oneOf: - $ref: '#/components/schemas/Attachment_FVO' - $ref: '#/components/schemas/AttachmentRef' discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment_FVO' AttachmentRef: '#/components/schemas/AttachmentRef' AttachmentRefOrValue: type: object description: The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself oneOf: - $ref: '#/components/schemas/Attachment' - $ref: '#/components/schemas/AttachmentRef' discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment' AttachmentRef: '#/components/schemas/AttachmentRef' ApplicationOwnerPartyOrPartyRole: type: object description: Schema that permits to identify an Individual or an Organisation in the Open Gateway context. oneOf: - $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual' - $ref: '#/components/schemas/ApplicationOwnerRelatedOrganization' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedIndividual: '#/components/schemas/ApplicationOwnerRelatedIndividual' ApplicationOwnerRelatedOrganization: '#/components/schemas/ApplicationOwnerRelatedOrganization' LightGeographicAddress: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress' properties: streetNr: type: string description: Number identifying a specific property on a public street. streetName: type: string description: Name of the street locality: type: string description: An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature, or a suburb, a bounded locality within a city, town or shire principally of urban character city: type: string description: City that the address is in stateOrProvince: type: string description: the State or Province that the address is in countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' postcode: type: string description: descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode) geographicSubAddress: $ref: '#/components/schemas/LightGeographicSubAddress' discriminator: propertyName: '@type' mapping: LightGeographicAddress: '#/components/schemas/LightGeographicAddress' PartyRoleRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: Party role reference. A party role represents the part played by a party in a given context. properties: partyId: type: string description: The identifier of the engaged party that is linked to the PartyRole object. partyName: type: string description: The name of the engaged party that is linked to the PartyRole object. discriminator: propertyName: '@type' mapping: PartyRoleRef: '#/components/schemas/PartyRoleRef' ApprovalStatusType: enum: - pendingApproval - approved - rejected type: string description: Valid values for an ApprovalStatus in the context of an approval process. headers: X-Total-Count: description: Total number of items matching criteria schema: type: integer X-Result-Count: description: Actual number of items returned in the response body schema: type: integer requestBodies: ApplicationOwner_FVO: description: The ApplicationOwner to be created content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_FVO' examples: Create_an_ApplicationOwner: $ref: '#/components/examples/Create_an_ApplicationOwner_request' required: true ApplicationOwner_MVO: description: The ApplicationOwner to be patched content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_MVO' examples: Update_an_ApplicationOwner_with_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_json_content_type_request' application/merge-patch+json: schema: $ref: '#/components/schemas/ApplicationOwner_MVO' examples: Update_an_ApplicationOwner_with_merge-patch_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_merge-patch_json_content_type_request' application/json-patch+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: Update_an_ApplicationOwner_with_json-patch_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_json-patch_json_content_type_request' application/json-patch-query+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: Update_an_ApplicationOwner_with_json-patch-query_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_json-patch-query_json_content_type_request' required: true examples: Update_an_ApplicationOwner_with_merge-patch_json_content_type_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: dpv:ForProfitOrganisation privacyPolicyURL: https://www.funtasticgames.com/privacy taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: inactive approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an ApplicationOwner object. Update_an_ApplicationOwner_with_json-patch-query_json_content_type_request: value: - op: replace path: /engagedParty.contactMedium?id=1 value: '@type': EmailContactMedium id: '1' preferred: true emailAddress: newContact@funtasticgames.com description: An example of a request for updating an Application object. Retrieve_a_list_of_ApplicationOwner_with_field_selection_and_filter_response: value: - '@type': ApplicationOwner href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 id: e05b75dc-f843-40d9-8d16-112275a28385 approvalStatus: approved description: A collection of ApplicationOwner with field selection and filter Update_an_ApplicationOwner_with_json-patch_json_content_type_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: dpv:ForProfitOrganisation privacyPolicyURL: https://www.funtasticgames.com/privacy taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: inactive approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an ApplicationOwner object. Create_an_ApplicationOwner_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: dpv:ForProfitOrganisation privacyPolicyURL: https://www.funtasticgames.com/privacy taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: active approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: POST ApplicationOwner Response Example Retrieve_an_ApplicationOwner_from_its_identifier_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: dpv:ForProfitOrganisation privacyPolicyURL: https://www.funtasticgames.com/privacy taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: active approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: ApplicationOwner representation. Create_an_ApplicationOwner_request: value: '@type': ApplicationOwner name: Funtastic Games application owner role description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: dpv:ForProfitOrganisation privacyPolicyURL: https://www.funtasticgames.com/privacy taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com description: POST ApplicationOwner Request Example Update_an_ApplicationOwner_with_json-patch-query_json_content_type_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: dpv:ForProfitOrganisation privacyPolicyURL: https://www.funtasticgames.com/privacy taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: newContact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: active approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an ApplicationOwner object. Update_an_ApplicationOwner_with_json_content_type_request: value: '@type': ApplicationOwner status: inactive description: Updating an ApplicationOwner object. Update_an_ApplicationOwner_with_json-patch_json_content_type_request: value: - op: replace path: /status value: inactive description: An example of a request for updating an ApplicationOwner object. Update_an_ApplicationOwner_with_merge-patch_json_content_type_request: value: '@type': ApplicationOwner status: inactive description: An example of a request for updating an ApplicationOwner object. Update_an_ApplicationOwner_with_json_content_type_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: dpv:ForProfitOrganisation privacyPolicyURL: https://www.funtasticgames.com/privacy taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: inactive approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A response after PATCH-ing an ApplicationOwner object. Retrieve_a_list_of_ApplicationOwner_response: value: - '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: dpv:ForProfitOrganisation privacyPolicyURL: https://www.funtasticgames.com/privacy taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: dpv:OrganisationalUnit contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: active approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A collection of ApplicationOwner representation responses: 200ApplicationOwnerArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/ApplicationOwner_RES' examples: Retrieve_a_list_of_ApplicationOwner: $ref: '#/components/examples/Retrieve_a_list_of_ApplicationOwner_response' Retrieve_a_list_of_ApplicationOwner_with_field_selection_and_filter: $ref: '#/components/examples/Retrieve_a_list_of_ApplicationOwner_with_field_selection_and_filter_response' 200ApplicationOwner_Patch: description: Success content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_RES' examples: Update_an_ApplicationOwner_with_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_json_content_type_response' Update_an_ApplicationOwner_with_merge-patch_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_merge-patch_json_content_type_response' Update_an_ApplicationOwner_with_json-patch_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_json-patch_json_content_type_response' Update_an_ApplicationOwner_with_json-patch-query_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_json-patch-query_json_content_type_response' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Unauthorized Error value: '@type': Error code: ERR401 reason: Unauthorized message: You are not authorized to access the requested resource. Please provide the correct credentials. referenceError: https://host/errors '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Not Implemented Error value: '@type': Error code: ERR501 reason: The requested operation is not implemented message: The requested operation is not implemented. Please contact the system administrator. referenceError: https://host/errors '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Service Unavailable Error value: '@type': Error code: ERR503 reason: Service Unavailable message: The service is currently unavailable. Please try again later. referenceError: https://host/errors '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Not Found Error value: '@type': Error code: ERR404 reason: Not Found message: The requested URL was not found on the server. referenceError: https://host/errors 200ApplicationOwner_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_RES' examples: Retrieve_an_ApplicationOwner_from_its_identifier: $ref: '#/components/examples/Retrieve_an_ApplicationOwner_from_its_identifier_response' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Conflict Error value: '@type': Error code: ERR409 reason: Conflict message: The request could not be completed due to a conflict with the current state of the target resource. referenceError: https://host/errors '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Bad Request Error value: '@type': Error code: ERR400 reason: Bad Request message: The server could not understand the request due to invalid syntax. Please correct the syntax and try again. referenceError: https://host/errors '405': description: Method Not allowed content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Method Not allowed Error value: '@type': Error code: ERR405 reason: Method Not allowed message: The method is not allowed for the requested URL. referenceError: https://host/errors '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Internal Server Error example value: '@type': Error code: ERR500 reason: Internal Server Error message: The server encountered an internal error. Please contact the system administrator. referenceError: https://host/errors '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Forbidden Error value: '@type': Error code: ERR403 reason: Forbidden message: You don't have the permission to access the requested resource. It is either read-protected or not readable by the server. referenceError: https://host/errors 201ApplicationOwner: description: Created content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_RES' examples: Create_an_ApplicationOwner: $ref: '#/components/examples/Create_an_ApplicationOwner_response' parameters: Limit: name: limit in: query description: Requested number of resources to be provided in response schema: type: integer Sort: name: sort in: query description: The default direction is Ascending order, the use of the modifier in front of the sort field name, “-“, changes the sort order direction. schema: type: string Before: name: before in: query description: An opaque string value representing the page results before the cursor value schema: type: string Filter: name: filter in: query description: Filter a collection using JSONPath schema: type: string example: attachment[?(@size==300)] Offset: name: offset in: query description: Requested index for start of resources to be provided in response schema: type: integer After: name: after in: query description: An opaque string value representing the page results after the cursor value schema: type: string Fields: name: fields in: query description: Comma-separated properties to be provided in response schema: type: string Id: name: id required: true schema: type: string in: path description: Identifier of the Resource