Jump to

• Request
• Response

Create/Update Host Profile

post

/ic/api/b2b/v1/tpm/host

Add new or update existing host identifier with the specified host company name.

Request

Supported Media Types

• application/json

Body ()

Update host profile.

Example:

{	"identifiers" : [	{"type": "EDI Group ID", "value": "hostEdiGrp"}], "name": "My Company"}

Root Schema : HostIdentifiersRs

Type: object

Show Source

• items: array items
• links: array links
• name: string
• supported_identifiers_types: array supported_identifiers_types

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HostIdentifierRs"
            }
        },
        "supported_identifiers_types":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdentifierSuggestions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object HostIdentifierRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : supported_identifiers_types

Type: array

Show Source

• Array of: object IdentifierSuggestions

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

Nested Schema : HostIdentifierRs

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : IdentifierSuggestions

Type: object

Show Source

• desc: string
• label: string
• type: string

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : HostIdentifierRs

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

201 Response

Successful operation

409 Response

Duplicate data error

412 Response

Pre condition failure

500 Response

Server error

Back to Top